renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 06:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs: improve documentation around fileMatch being additive (#20084)

Browse source 
Co-authored-by: Rhys Arkins <rhys@arkins.net>
This commit is contained in:
Matthias Schoettle 2023-01-30 01:15:53 -05:00 committed by GitHub
parent a37bd81298
commit 3e325e900f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/usage/configuration-options.md
View file

@ -821,7 +821,9 @@ Renovate can fetch release notes when they are hosted on one of these platforms:
## fileMatch ## fileMatch
`fileMatch` is used by Renovate to know which files in a repository to parse and extract, and it is possible to override the default values to customize for your project's needs. `fileMatch` is used by Renovate to know which files in a repository to parse and extract.
`fileMatch` patterns in the user config are added to the default values and do not replace them.
The default `fileMatch` patterns cannot be removed, so if you need to include or exclude specific paths then use the `ignorePaths` or `includePaths` configuration options.
Sometimes file matches are really simple - for example with Go Modules Renovate looks for any `go.mod` file, and you probably don't need to change that default. Sometimes file matches are really simple - for example with Go Modules Renovate looks for any `go.mod` file, and you probably don't need to change that default.

4
docs/usage/modules/manager/index.md
View file

@ -48,9 +48,9 @@ If the default `fileMatch` regular expression for a manager does not match again
#### Ignoring files that match the default fileMatch #### Ignoring files that match the default fileMatch
Renovate will _extend_ the existing `fileMatch`, meaning you don't need to include the default regular expressions like `Dockerfile` in your own array. Renovate will _extend_ the existing [`fileMatch`](/configuration-options/#filematch), meaning you don't need to include the default regular expressions like `Dockerfile` in your own array.
In other words, the regular expression are "additive". In other words, the regular expression are "additive".
If a manager matches a file that you _don't_ want it to, ignore it using the `ignorePaths` configuration option. If a manager matches a file that you _don't_ want it to, ignore it using the [`ignorePaths`](/configuration-options/#ignorepaths) configuration option.
Also, if you ever find that Renovate is _not_ matching a file name that you're certain it should, check your preset config isn't the cause of it. Also, if you ever find that Renovate is _not_ matching a file name that you're certain it should, check your preset config isn't the cause of it.
The `config:base` preset ignores common test and example directory names, for example. The `config:base` preset ignores common test and example directory names, for example.