feat(config): managerFilePatterns

docs/development/new-package-manager-template.md

@@ -25,14 +25,14 @@ Explain how this package manager is different from existing ones.
 
 ### What kind of package files, and names, does this package manager use?
 
-### Which [`fileMatch`](../usage/configuration-options.md#filematch) pattern(s) should Renovate use?
+### Which [`filePatterns`](../usage/configuration-options.md#filepatterns) pattern(s) should Renovate use?
 
-### Do many users need to extend the [`fileMatch`](../usage/configuration-options.md#filematch) pattern for custom file names?
+### Do many users need to extend the [`filePatterns`](../usage/configuration-options.md#filepatterns) pattern for custom file names?
 
 - [ ] Yes, provide details.
 - [ ] No.
 
-### Is the [`fileMatch`](../usage/configuration-options.md#filematch) pattern going to get many "false hits" for files that have nothing to do with package management?
+### Is the [`filePatterns`](../usage/configuration-options.md#filepatterns) pattern going to get many "false hits" for files that have nothing to do with package management?
 
 ## Parsing and Extraction
 

docs/usage/configuration-options.md

@@ -711,7 +711,7 @@ Renovate has two custom managers:
 
 To use a custom manager, you need give some information:
 
-1. `fileMatch`: name/pattern of the file to extract deps from
+1. `filePatterns`: regex/glob pattern of the file to extract deps from
 1. `matchStrings`: `regex` patterns or `jsonata` queries used to process the file
 
 The `matchStrings` must capture/extract the following three fields:
@@ -753,7 +753,7 @@ image: my.old.registry/aRepository/andImage:1.18-alpine
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["values.yaml$"],
+      "filePatterns": ["/values.yaml$/"],
       "matchStrings": [
         "image:\\s+(?<depName>my\\.old\\.registry/aRepository/andImage):(?<currentValue>[^\\s]+)"
       ],
@@ -792,7 +792,7 @@ Example:
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["values.yaml$"],
+      "filePatterns": ["/values.yaml$/"],
       "matchStrings": [
         "ENV .*?_VERSION=(?<currentValue>.*) # (?<datasource>.*?)/(?<depName>.*?)\\s"
       ]
@@ -807,7 +807,7 @@ Example:
     {
       "customType": "jsonata",
       "fileFormat": "json",
-      "fileMatch": ["file.json"],
+      "filePatterns": ["/file.json/"],
       "matchStrings": [
         "packages.{ \"depName\": package, \"currentValue\": version }"
       ]
@@ -854,7 +854,7 @@ Only the `json`, `toml` and `yaml` formats are supported.
     {
       "customType": "jsonata",
       "fileFormat": "json",
-      "fileMatch": [".renovaterc"],
+      "filePatterns": ["/.renovaterc/"],
       "matchStrings": [
         "packages.{ 'depName': package, 'currentValue': version }"
       ]
@@ -869,7 +869,7 @@ Only the `json`, `toml` and `yaml` formats are supported.
     {
       "customType": "jsonata",
       "fileFormat": "yaml",
-      "fileMatch": ["file.yml"],
+      "filePatterns": ["/file.yml/"],
       "matchStrings": [
         "packages.{ 'depName': package, 'currentValue': version }"
       ]
@@ -884,7 +884,7 @@ Only the `json`, `toml` and `yaml` formats are supported.
     {
       "customType": "jsonata",
       "fileFormat": "toml",
-      "fileMatch": ["file.toml"],
+      "filePatterns": ["/file.toml/"],
       "matchStrings": [
         "packages.{ 'depName': package, 'currentValue': version }"
       ]
@@ -943,7 +943,7 @@ As example the following configuration will update all three lines in the Docker
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["^Dockerfile$"],
+      "filePatterns": ["/^Dockerfile$/"],
       "matchStringsStrategy": "any",
       "matchStrings": [
         "ENV [A-Z]+_VERSION=(?<currentValue>.*) # (?<datasource>.*?)/(?<depName>.*?)(\\&versioning=(?<versioning>.*?))?\\s",
@@ -981,7 +981,7 @@ But the second custom manager will upgrade both definitions as its first `matchS
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["^example.json$"],
+      "filePatterns": ["/^example.json$/"],
       "matchStringsStrategy": "recursive",
       "matchStrings": [
         "\"backup\":\\s*{[^}]*}",
@@ -991,7 +991,7 @@ But the second custom manager will upgrade both definitions as its first `matchS
       "datasourceTemplate": "docker"
     },
     {
-      "fileMatch": ["^example.json$"],
+      "filePatterns": ["/^example.json$/"],
       "matchStringsStrategy": "recursive",
       "matchStrings": [
         "\"test\":\\s*\\{[^}]*}",
@@ -1037,7 +1037,7 @@ Matched group values will be merged to form a single dependency.
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["^main.yml$"],
+      "filePatterns": ["/^main.yml$/"],
       "matchStringsStrategy": "combination",
       "matchStrings": [
         "prometheus_image:\\s*\"(?<depName>.*)\"\\s*//",
@@ -1046,7 +1046,7 @@ Matched group values will be merged to form a single dependency.
       "datasourceTemplate": "docker"
     },
     {
-      "fileMatch": ["^main.yml$"],
+      "filePatterns": ["/^main.yml$/"],
       "matchStringsStrategy": "combination",
       "matchStrings": [
         "thanos_image:\\s*\"(?<depName>.*)\"\\s*//",
@@ -1492,33 +1492,33 @@ If you are running on any platform except `github.com`, you need to [configure a
     We're planning improvements so that Renovate can show more changelogs.
     Read [issue 14138 on GitHub](https://github.com/renovatebot/renovate/issues/14138) to get an overview of the planned work.
 
-## fileMatch
+## filePatterns
 
-`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.
+`filePatterns` is used by Renovate to know which files in a repository to parse and extract.
+`filePatterns` patterns in the user config are added to the default values and do not replace them.
+The default `filePatterns` patterns cannot be removed, so if you need to include or exclude specific paths then use the `ignorePaths` or `includePaths` configuration options.
 
-Some `fileMatch` patterns are short, like Renovate's default Go Modules `fileMatch` for example.
+Some `filePatterns` patterns are short, like Renovate's default Go Modules `filePatterns` for example.
 Here Renovate looks for _any_ `go.mod` file.
-In this case you can probably keep using that default `fileMatch`.
+In this case you can probably keep using that default `filePatterns`.
 
 At other times, the possible files is too vague for Renovate to have any default.
-For default, Kubernetes manifests can exist in any `*.yaml` file and we don't want Renovate to parse every single YAML file in every repository just in case some of them have a Kubernetes manifest, so Renovate's default `fileMatch` for manager `kubernetes` is actually empty (`[]`) and needs the user to tell Renovate what directories/files to look in.
+For default, Kubernetes manifests can exist in any `*.yaml` file and we don't want Renovate to parse every single YAML file in every repository just in case some of them have a Kubernetes manifest, so Renovate's default `filePatterns` for manager `kubernetes` is actually empty (`[]`) and needs the user to tell Renovate what directories/files to look in.
 
-Finally, there are cases where Renovate's default `fileMatch` is good, but you may be using file patterns that a bot couldn't possibly guess about.
-For example, Renovate's default `fileMatch` for `Dockerfile` is `['(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$', '(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$']`.
+Finally, there are cases where Renovate's default `filePatterns` is good, but you may be using file patterns that a bot couldn't possibly guess about.
+For example, Renovate's default `filePatterns` for `Dockerfile` is `['/(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$/', '/(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$/']`.
 This will catch files like `backend/Dockerfile`, `prefix.Dockerfile` or `Dockerfile-suffix`, but it will miss files like `ACTUALLY_A_DOCKERFILE.template`.
-Because `fileMatch` is mergeable, you don't need to duplicate the defaults and could add the missing file like this:
+Because `filePatterns` is mergeable, you don't need to duplicate the defaults and could add the missing file like this:
 
 ```json
 {
   "dockerfile": {
-    "fileMatch": ["^ACTUALLY_A_DOCKERFILE\\.template$"]
+    "filePatterns": ["/^ACTUALLY_A_DOCKERFILE\\.template$/"]
   }
 }
 ```
 
-If you configure `fileMatch` then it must be within a manager object (e.g. `dockerfile` in the above example).
+If you configure `filePatterns` then it must be within a manager object (e.g. `dockerfile` in the above example).
 The full list of supported managers can be found [here](modules/manager/index.md#supported-managers).
 
 ## filterUnavailableUsers

docs/usage/docker.md

@@ -16,7 +16,7 @@ Renovate supports upgrading dependencies in various types of Docker definition f
 
 ## How It Works
 
-1. Renovate searches in each repository for any files matching each manager's configured `fileMatch` pattern(s)
+1. Renovate searches in each repository for any files matching each manager's configured `filePatterns` pattern(s)
 1. Matching files are parsed, Renovate checks if the file(s) has any Docker image references (e.g. `FROM` lines in a `Dockerfile`)
 1. If the image tag in use "looks" like a version (e.g. `myimage:1`, `myimage:1.1`, `myimage:1.1.0`, `myimage:1-onbuild`) then Renovate checks the Docker registry for upgrades (e.g. from `myimage:1.1.0` to `myimage:1.2.0`)
 

docs/usage/getting-started/private-packages.md

@@ -485,7 +485,7 @@ private-package==1.2.3
 ```json
 {
   "pip-compile": {
-    "fileMatch": ["requirements.in"]
+    "filePatterns": ["/requirements.in/"]
   },
   "hostRules": [
     {

docs/usage/java.md

@@ -44,7 +44,7 @@ Renovate does not support:
 - Catalog versions using `reject`, and `rejectAll` constraints
 - Catalog versions using more than one of `require`, `strictly`, `prefer` in a single declaration
 - Catalogs with custom names that do not end in `.toml`
-- Catalogs outside the `gradle` folder whose names do not end in `.versions.toml` (unless overridden via [`fileMatch`](./configuration-options.md#filematch) configuration)
+- Catalogs outside the `gradle` folder whose names do not end in `.versions.toml` (unless overridden via [`filePatterns`](./configuration-options.md#filepatterns) configuration)
 
 ### Gradle Plugin Support
 

docs/usage/modules/manager/index.md

@@ -18,38 +18,38 @@ The goal of Renovate is to detect and maintain all third-party dependencies in y
 
 ### File Matching
 
-Most managers have a default `fileMatch` array.
-The `fileMatch` array has regular expression strings that match against the repository file list.
+Most managers have a default `filePatterns` array.
+The `filePatterns` array has regular expression or glob pattern that matches against the repository file list.
 
-#### Managers with no default fileMatch
+#### Managers with no default filePatterns
 
-Some managers have no default `fileMatch` regular expression, because they have no filename convention that would let Renovate intelligently filter them.
-In such a case, the manager will be disabled until you create a `fileMatch` regular expression, e.g. like the following:
+Some managers have no default `filePatterns`, because they have no filename convention that would let Renovate intelligently filter them.
+In such a case, the manager will be disabled until you create a `filePatterns` regular expression, e.g. like the following:
 
 ```json
 {
   "kubernetes": {
-    "fileMatch": ["^config/.*\\.yaml$"]
+    "filePatterns": ["/^config/.*\\.yaml$/"]
   }
 }
 ```
 
-#### Extending a manager's default fileMatch
+#### Extending a manager's default filePatterns
 
-If the default `fileMatch` regular expression for a manager does not match against one of your relevant files, you can _extend_ the existing regular expression(s) by configuring a manager's `fileMatch` like in this example:
+If the default `filePatterns` for a manager does not match against one of your relevant files, you can _extend_ the existing pattern(s) by configuring a manager's `filePatterns` like in this example:
 
 ```json
 {
   "dockerfile": {
-    "fileMatch": ["does-not-look-like-a-docker-file"]
+    "filePatterns": ["does-not-look-like-a-docker-file"]
   }
 }
 ```
 
-#### Ignoring files that match the default fileMatch
+#### Ignoring files that match the default filePatterns
 
-Renovate will _extend_ the existing [`fileMatch`](../../configuration-options.md#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".
+Renovate will _extend_ the existing [`filePatterns`](../../configuration-options.md#filepatterns), meaning you don't need to include the default patterns like `Dockerfile` in your own array.
+In other words, the patterns are "additive".
 If a manager matches a file that you _don't_ want it to, ignore it using the [`ignorePaths`](../../configuration-options.md#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.
 The `config:recommended` preset ignores common test and example directory names, for example.

docs/usage/user-stories/maintaining-aur-packages-with-renovate.md

@@ -46,7 +46,7 @@ I can create a `renovate.json` configuration with the following custom manager c
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["(^|/)PKGBUILD$"],
+      "filePatterns": ["/(^|/)PKGBUILD$/"],
       "matchStrings": [
         "pkgver=(?<currentValue>.*) # renovate: datasource=(?<datasource>.*) depName=(?<depName>.*)"
       ],
@@ -58,7 +58,7 @@ I can create a `renovate.json` configuration with the following custom manager c
 
 Breaking that down:
 
-- The `fileMatch` setting tells Renovate to look for any `PKGBUILD` files in a repository
+- The `filePatterns` setting tells Renovate to look for any `PKGBUILD` files in a repository
 - The `matchStrings` is the regex format to extract the version, datasource, and dependency name from the `PKGBUILD`
 - The `extractVersionTemplate` is to handle a “v” in front of any version number that is sometimes added to Git tags
 

lib/config/__snapshots__/migration.spec.ts.snap

@@ -338,19 +338,19 @@ exports[`config/migration > migrates customManagers 1`] = `
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": [
-        "(^|/|\\.)Dockerfile$",
-        "(^|/)Dockerfile[^/]*$",
+      "filePatterns": [
+        "/(^|/|\\.)Dockerfile$/",
+        "/(^|/)Dockerfile[^/]*$/",
       ],
       "matchStrings": [
         "# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)(?: lookupName=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s(?:ENV|ARG) .+?_VERSION="?(?<currentValue>.+?)"?\\s",
       ],
     },
     {
       "customType": "regex",
-      "fileMatch": [
-        "(^|/|\\.)Dockerfile$",
-        "(^|/)Dockerfile[^/]*$",
+      "filePatterns": [
+        "/(^|/|\\.)Dockerfile$/",
+        "/(^|/)Dockerfile[^/]*$/",
       ],
       "matchStrings": [
         "# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)(?: lookupName=(?<holder>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s(?:ENV|ARG) .+?_VERSION="?(?<currentValue>.+?)"?\\s",
@@ -365,8 +365,8 @@ exports[`config/migration > migrates gradle-lite 1`] = `
 {
   "gradle": {
     "enabled": true,
-    "fileMatch": [
-      "foo",
+    "filePatterns": [
+      "/foo/",
     ],
   },
   "packageRules": [

lib/config/__snapshots__/validation.spec.ts.snap

@@ -88,14 +88,14 @@ exports[`config/validation > validateConfig(config) > errors for all types 1`] =
 ]
 `;
 
-exports[`config/validation > validateConfig(config) > errors for unsafe fileMatches 1`] = `
+exports[`config/validation > validateConfig(config) > errors for unsafe filePatterns 1`] = `
 [
   {
-    "message": "Invalid regExp for dockerfile.fileMatch: \`x?+\`",
+    "message": "Failed to parse regex pattern for dockerfile.filePatterns: /x?+/",
     "topic": "Configuration Error",
   },
   {
-    "message": "Invalid regExp for npm.fileMatch: \`abc ([a-z]+) ([a-z]+))\`",
+    "message": "Failed to parse regex pattern for npm.filePatterns: /abc ([a-z]+) ([a-z]+))/",
     "topic": "Configuration Error",
   },
 ]
@@ -110,19 +110,19 @@ exports[`config/validation > validateConfig(config) > errors if customManager fi
 ]
 `;
 
-exports[`config/validation > validateConfig(config) > errors if fileMatch has wrong parent 1`] = `
+exports[`config/validation > validateConfig(config) > errors if filePatterns has wrong parent 1`] = `
 [
   {
-    "message": ""fileMatch" may not be defined at the top level of a config and must instead be within a manager block",
+    "message": ""filePatterns" may not be defined at the top level of a config and must instead be within a manager block",
     "topic": "Config error",
   },
 ]
 `;
 
-exports[`config/validation > validateConfig(config) > errors if fileMatch has wrong parent 2`] = `
+exports[`config/validation > validateConfig(config) > errors if filePatterns has wrong parent 2`] = `
 [
   {
-    "message": ""fileMatch" must be configured in a manager block and not here: npm.minor",
+    "message": ""filePatterns" must be configured in a manager block and not here: npm.minor",
     "topic": "Config warning",
   },
 ]
@@ -239,10 +239,10 @@ exports[`config/validation > validateConfig(config) > selectors outside packageR
 ]
 `;
 
-exports[`config/validation > validateConfig(config) > validates regEx for each fileMatch 1`] = `
+exports[`config/validation > validateConfig(config) > validates regEx for each filePatterns of format regex 1`] = `
 [
   {
-    "message": "Invalid regExp for customManagers[0].fileMatch: \`***$}{]][\`",
+    "message": "Failed to parse regex pattern for customManagers[0].filePatterns: /***$}{]][/",
     "topic": "Configuration Error",
   },
 ]

lib/config/index.spec.ts

@@ -125,10 +125,13 @@ describe('config/index', () => {
       const parentConfig = { ...defaultConfig };
       const config = getManagerConfig(parentConfig, 'npm');
       expect(config).toContainEntries([
-        ['fileMatch', ['(^|/)package\\.json$', '(^|/)pnpm-workspace\\.yaml$']],
+        [
+          'filePatterns',
+          ['/(^|/)package\\.json$/', '/(^|/)pnpm-workspace\\.yaml$/'],
+        ],
       ]);
       expect(getManagerConfig(parentConfig, 'html')).toContainEntries([
-        ['fileMatch', ['\\.html?$']],
+        ['filePatterns', ['/\\.html?$/']],
       ]);
     });