Skip to content

Commit 390d99a

Browse files
fix docs
1 parent da993fd commit 390d99a

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

docs/usage/configuration-options.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1493,45 +1493,6 @@ If you are running on any platform except `github.com`, you need to [configure a
14931493
We're planning improvements so that Renovate can show more changelogs.
14941494
Read [issue 14138 on GitHub](https://github.com/renovatebot/renovate/issues/14138) to get an overview of the planned work.
14951495

1496-
## managerFilePatterns
1497-
1498-
`managerFilePatterns` were formerly known as `fileMatch`, and regex-only.
1499-
`managerFilePatterns` instead supports regex or glob patterns, and any existing config containing `fileMatch` patterns will be automatically migrated.
1500-
Do not use the below guide for `fileMatch` if you are using an older version of Renovate.
1501-
1502-
`managerFilePatterns` tells Renovate which repository files to parse and extract.
1503-
`managerFilePatterns` patterns in the user config are _added_ to the default values, they do not replace the default values.
1504-
1505-
The default `managerFilePatterns` patterns can not be removed.
1506-
If you need to include, or exclude, specific paths then use the `ignorePaths` or `includePaths` configuration options.
1507-
1508-
Some `managerFilePatterns` patterns are short, like Renovate's default Go Modules `managerFilePatterns` for example.
1509-
Here Renovate looks for _any_ `go.mod` file.
1510-
In this case you can probably keep using that default `managerFilePatterns`.
1511-
1512-
At other times, the possible files is too vague for Renovate to have any default.
1513-
For example, Kubernetes manifests can exist in any `*.yaml` file.
1514-
We do not want Renovate to parse every YAML file in every repository, just in case _some_ of them have a Kubernetes manifest.
1515-
Therefore Renovate's default `managerFilePatterns` for the `kubernetes` manager is an empty array (`[]`).
1516-
Because the array is empty, you as user must tell Renovate which directories/files to check.
1517-
1518-
Finally, there are cases where Renovate's default `managerFilePatterns` is good, but you may be using file patterns that a bot couldn't possibly guess about.
1519-
For example, Renovate's default `managerFilePatterns` for `Dockerfile` is `['/(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$/', '/(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$/']`.
1520-
This will catch files like `backend/Dockerfile`, `prefix.Dockerfile` or `Dockerfile-suffix`, but it will miss files like `ACTUALLY_A_DOCKERFILE.template`.
1521-
Because `managerFilePatterns` is "mergeable", you can add the missing file to the `filePattern` like this:
1522-
1523-
```json
1524-
{
1525-
"dockerfile": {
1526-
"managerFilePatterns": ["/^ACTUALLY_A_DOCKERFILE\\.template$/"]
1527-
}
1528-
}
1529-
```
1530-
1531-
You must configure `managerFilePatterns` _inside_ a manager object.
1532-
In the example above, the manager object is the `dockerfile`.
1533-
For reference, here is a [list of supported managers](modules/manager/index.md#supported-managers).
1534-
15351496
## filterUnavailableUsers
15361497

15371498
When this option is enabled PRs are not assigned to users that are unavailable.
@@ -2414,6 +2375,45 @@ Be careful with remapping `warn` or `error` messages to lower log levels, as it
24142375

24152376
Add to this object if you wish to define rules that apply only to major updates.
24162377

2378+
## managerFilePatterns
2379+
2380+
`managerFilePatterns` were formerly known as `fileMatch`, and regex-only.
2381+
`managerFilePatterns` instead supports regex or glob patterns, and any existing config containing `fileMatch` patterns will be automatically migrated.
2382+
Do not use the below guide for `fileMatch` if you are using an older version of Renovate.
2383+
2384+
`managerFilePatterns` tells Renovate which repository files to parse and extract.
2385+
`managerFilePatterns` patterns in the user config are _added_ to the default values, they do not replace the default values.
2386+
2387+
The default `managerFilePatterns` patterns can not be removed.
2388+
If you need to include, or exclude, specific paths then use the `ignorePaths` or `includePaths` configuration options.
2389+
2390+
Some `managerFilePatterns` patterns are short, like Renovate's default Go Modules `managerFilePatterns` for example.
2391+
Here Renovate looks for _any_ `go.mod` file.
2392+
In this case you can probably keep using that default `managerFilePatterns`.
2393+
2394+
At other times, the possible files is too vague for Renovate to have any default.
2395+
For example, Kubernetes manifests can exist in any `*.yaml` file.
2396+
We do not want Renovate to parse every YAML file in every repository, just in case _some_ of them have a Kubernetes manifest.
2397+
Therefore Renovate's default `managerFilePatterns` for the `kubernetes` manager is an empty array (`[]`).
2398+
Because the array is empty, you as user must tell Renovate which directories/files to check.
2399+
2400+
Finally, there are cases where Renovate's default `managerFilePatterns` is good, but you may be using file patterns that a bot couldn't possibly guess about.
2401+
For example, Renovate's default `managerFilePatterns` for `Dockerfile` is `['/(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$/', '/(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$/']`.
2402+
This will catch files like `backend/Dockerfile`, `prefix.Dockerfile` or `Dockerfile-suffix`, but it will miss files like `ACTUALLY_A_DOCKERFILE.template`.
2403+
Because `managerFilePatterns` is "mergeable", you can add the missing file to the `filePattern` like this:
2404+
2405+
```json
2406+
{
2407+
"dockerfile": {
2408+
"managerFilePatterns": ["/^ACTUALLY_A_DOCKERFILE\\.template$/"]
2409+
}
2410+
}
2411+
```
2412+
2413+
You must configure `managerFilePatterns` _inside_ a manager object.
2414+
In the example above, the manager object is the `dockerfile`.
2415+
For reference, here is a [list of supported managers](modules/manager/index.md#supported-managers).
2416+
24172417
## milestone
24182418

24192419
If set to the number of an existing [GitHub milestone](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones), Renovate will add that milestone to its PR.

0 commit comments

Comments
 (0)