feat(migrate): regexManagers -> customManagers (#24451)

Co-authored-by: HonkingGoose <[email protected]>
Co-authored-by: Rhys Arkins <[email protected]>

docs/usage/getting-started/use-cases.md

@@ -58,8 +58,8 @@ This can be because:
 - The package manager/file format is not supported, or
 - The file format is not a standard or is proprietary
 
-If your dependencies are not found by default, you can use our "regex" manager to set your own custom patterns to extract dependencies.
-You configure the regex manager by telling it:
+If your dependencies are not found by default, you can use our `custom` manager to set your own custom patterns to extract dependencies.
+You configure the custom manager by telling it:
 
 - Which file pattern(s) to match
 - How to find the dependency name and version from within the file

docs/usage/reading-list.md

@@ -59,7 +59,7 @@ Feel free to read up on anything that looks interesting to you.
 First, complete the "Beginners" and the "Intermediate" reading list.
 Then read:
 
-- Define your own regex manager with [`regexManagers`](./configuration-options.md#regexmanagers)
+- Define your own custom manager with [`customManagers`](./configuration-options.md#custommanagers)(previously `regexManagers`)
 - [Shareable config presets](./config-presets.md)
 
 ## Self-hosting Renovate

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

@@ -39,12 +39,13 @@ Renovate comes with over 50 different datasources, but the one that is important
 Managers are the Renovate concept for package managers.
 There isn’t an AUR or `PKGBUILD` manager, but there is a [regex manager](https://docs.renovatebot.com/modules/manager/regex/) that I can use.
 
-I can create a `renovate.json` configuration with the following regex manager configuration:
+I can create a `renovate.json` configuration with the following custom manager configuration:
 
 ```json
 {
-  "regexManagers": [
+  "customManagers": [
     {
+      "customType": "regex",
       "fileMatch": ["(^|/)PKGBUILD$"],
       "matchStrings": [
         "pkgver=(?<currentValue>.*) # renovate: datasource=(?<datasource>.*) depName=(?<depName>.*)"

docs/usage/user-stories/swissquote.md

@@ -177,7 +177,7 @@ Some features and options we enjoy:
 - Each rule can be customized either globally [or specified per package](../configuration-options.md#packagerules)
 - Works with your [private package registry](../getting-started/private-packages.md)
 - Supports more than 70 [languages and package managers](https://docs.renovatebot.com/modules/manager/#supported-managers): Maven, Docker, npm, Docker Compose, Python
-- If you are using dependencies in a custom way, [there is a special regexManager](../configuration-options.md#regexmanagers) that allows you to transform patterns into dependencies
+- If you are using dependencies in a custom way, [there is a `customManagers` option](../configuration-options.md#custommanagers) that allows you to transform patterns into dependencies
 
 There is an [on-premise option](https://www.mend.io/free-developer-tools/renovate/on-premises/), but you can also use [the Mend Renovate App](https://github.com/marketplace/renovate).
 On our side, we’re not using the on-premise but rather a custom scheduler using the open source Docker image.

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

@@ -1,5 +1,33 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`config/migration it migrates customManagers 1`] = `
+{
+  "customManagers": [
+    {
+      "customType": "regex",
+      "fileMatch": [
+        "(^|/|\\.)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[^/]*$",
+      ],
+      "matchStrings": [
+        "# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)(?: lookupName=(?<holder>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s(?:ENV|ARG) .+?_VERSION="?(?<currentValue>.+?)"?\\s",
+      ],
+      "packageNameTemplate": "{{{holder}}}",
+    },
+  ],
+}
+`;
+
 exports[`config/migration it migrates gradle-lite 1`] = `
 {
   "gradle": {
@@ -51,34 +79,6 @@ exports[`config/migration it migrates nested packageRules 1`] = `
 }
 `;
 
-exports[`config/migration it migrates regexManagers 1`] = `
-{
-  "regexManagers": [
-    {
-      "customType": "regex",
-      "fileMatch": [
-        "(^|/|\\.)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[^/]*$",
-      ],
-      "matchStrings": [
-        "# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)(?: lookupName=(?<holder>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s(?:ENV|ARG) .+?_VERSION="?(?<currentValue>.+?)"?\\s",
-      ],
-      "packageNameTemplate": "{{{holder}}}",
-    },
-  ],
-}
-`;
-
 exports[`config/migration migrateConfig(config, parentConfig) does not migrate multi days 1`] = `
 {
   "schedule": "after 5:00pm on wednesday and thursday",

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

@@ -113,6 +113,15 @@ exports[`config/validation validateConfig(config) errors for unsafe fileMatches
 ]
 `;
 
+exports[`config/validation validateConfig(config) errors if customManager fields are missing 1`] = `
+[
+  {
+    "message": "Regex Managers must contain currentValueTemplate configuration or regex group named currentValue",
+    "topic": "Configuration Error",
+  },
+]
+`;
+
 exports[`config/validation validateConfig(config) errors if fileMatch has wrong parent 1`] = `
 [
   {
@@ -176,15 +185,6 @@ exports[`config/validation validateConfig(config) errors if manager objects are
 ]
 `;
 
-exports[`config/validation validateConfig(config) errors if regexManager fields are missing 1`] = `
-[
-  {
-    "message": "Regex Managers must contain currentValueTemplate configuration or regex group named currentValue",
-    "topic": "Configuration Error",
-  },
-]
-`;
-
 exports[`config/validation validateConfig(config) ignore packageRule nesting validation for presets 1`] = `[]`;
 
 exports[`config/validation validateConfig(config) included managers of the wrong type 1`] = `
@@ -250,7 +250,7 @@ exports[`config/validation validateConfig(config) selectors outside packageRules
 exports[`config/validation validateConfig(config) validates regEx for each fileMatch 1`] = `
 [
   {
-    "message": "Invalid regExp for regexManagers[0].fileMatch: \`***$}{]][\`",
+    "message": "Invalid regExp for customManagers[0].fileMatch: \`***$}{]][\`",
     "topic": "Configuration Error",
   },
 ]

lib/config/migration.spec.ts

@@ -643,10 +643,11 @@ describe('config/migration', () => {
     expect(migratedConfig).toEqual({ extends: ['local>org/renovate-config'] });
   });
 
-  it('it migrates regexManagers', () => {
+  it('it migrates customManagers', () => {
     const config: RenovateConfig = {
-      regexManagers: [
+      customManagers: [
         {
+          customType: 'regex',
           fileMatch: ['(^|/|\\.)Dockerfile$', '(^|/)Dockerfile[^/]*$'],
           matchStrings: [
             '# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)(?: lookupName=(?<lookupName>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s(?:ENV|ARG) .+?_VERSION="?(?<currentValue>.+?)"?\\s',

lib/config/migrations/custom/regex-managers-migration.spec.ts → lib/config/migrations/custom/custom-managers-migration.spec.ts

@@ -1,12 +1,12 @@
 import { partial } from '../../../../test/util';
 import type { CustomManager } from '../../../modules/manager/custom/types';
-import { RegexManagersMigration } from './regex-managers-migration';
+import { CustomManagersMigration } from './custom-managers-migration';
 
-describe('config/migrations/custom/regex-managers-migration', () => {
+describe('config/migrations/custom/custom-managers-migration', () => {
   it('migrates', () => {
-    expect(RegexManagersMigration).toMigrate(
+    expect(CustomManagersMigration).toMigrate(
       {
-        regexManagers: partial<CustomManager>([
+        customManagers: partial<CustomManager>([
           {
             fileMatch: ['js', '***$}{]]['],
             matchStrings: ['^(?<depName>foo)(?<currentValue>bar)$'],
@@ -23,7 +23,7 @@ describe('config/migrations/custom/regex-managers-migration', () => {
         ]),
       },
       {
-        regexManagers: [
+        customManagers: [
           {
             customType: 'regex',
             fileMatch: ['js', '***$}{]]['],

lib/config/migrations/custom/regex-managers-migration.ts → lib/config/migrations/custom/custom-managers-migration.ts

@@ -2,19 +2,19 @@ import is from '@sindresorhus/is';
 import type { CustomManager } from '../../../modules/manager/custom/types';
 import { AbstractMigration } from '../base/abstract-migration';
 
-export class RegexManagersMigration extends AbstractMigration {
-  override readonly propertyName = 'regexManagers';
+export class CustomManagersMigration extends AbstractMigration {
+  override readonly propertyName = 'customManagers';
 
   override run(value: unknown): void {
     if (is.nonEmptyArray(value)) {
-      const regexManagers = (value as CustomManager[]).map((mgr) => {
+      const customManagers = (value as CustomManager[]).map((mgr) => {
         if (mgr.customType) {
           return mgr;
         }
-        return Object.assign({ customType: 'regex' }, mgr); // to make sure customType is at top, looks good when migration pr is created
+        return Object.assign({ customType: 'regex' }, mgr); // to make sure customType is at top, looks good when migration PR is created
       });
 
-      this.rewrite(regexManagers);
+      this.rewrite(customManagers);
     }
   }
 }

lib/config/migrations/migrations-service.ts

@@ -15,6 +15,7 @@ import { BranchNameMigration } from './custom/branch-name-migration';
 import { BranchPrefixMigration } from './custom/branch-prefix-migration';
 import { CompatibilityMigration } from './custom/compatibility-migration';
 import { ComposerIgnorePlatformReqsMigration } from './custom/composer-ignore-platform-reqs-migration';
+import { CustomManagersMigration } from './custom/custom-managers-migration';
 import { DatasourceMigration } from './custom/datasource-migration';
 import { DepTypesMigration } from './custom/dep-types-migration';
 import { DryRunMigration } from './custom/dry-run-migration';
@@ -41,7 +42,6 @@ import { RaiseDeprecationWarningsMigration } from './custom/raise-deprecation-wa
 import { RebaseConflictedPrs } from './custom/rebase-conflicted-prs-migration';
 import { RebaseStalePrsMigration } from './custom/rebase-stale-prs-migration';
 import { RecreateClosedMigration } from './custom/recreate-closed-migration';
-import { RegexManagersMigration } from './custom/regex-managers-migration';
 import { RenovateForkMigration } from './custom/renovate-fork-migration';
 import { RequireConfigMigration } from './custom/require-config-migration';
 import { RequiredStatusChecksMigration } from './custom/required-status-checks-migration';
@@ -96,6 +96,7 @@ export class MigrationsService {
     ['masterIssueFooter', 'dependencyDashboardFooter'],
     ['masterIssueTitle', 'dependencyDashboardTitle'],
     ['masterIssueLabels', 'dependencyDashboardLabels'],
+    ['regexManagers', 'customManagers'],
   ]);
 
   static readonly customMigrations: ReadonlyArray<MigrationConstructor> = [
@@ -151,7 +152,7 @@ export class MigrationsService {
     RecreateClosedMigration,
     StabilityDaysMigration,
     FetchReleaseNotesMigration,
-    RegexManagersMigration,
+    CustomManagersMigration,
   ];
 
   static run(originalConfig: RenovateConfig): RenovateConfig {

lib/config/options/index.ts

@@ -2493,7 +2493,7 @@ const options: RenovateOptions[] = [
     default: false,
   },
   {
-    name: 'regexManagers',
+    name: 'customManagers',
     description: 'Custom managers using regex matching.',
     type: 'array',
     subType: 'object',
@@ -2505,21 +2505,21 @@ const options: RenovateOptions[] = [
   {
     name: 'customType',
     description:
-      'Custom manager to use. Valid only within a `regexManagers` object.',
+      'Custom manager to use. Valid only within a `customManagers` object.',
     type: 'string',
     allowedValues: ['regex'],
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'matchStrings',
     description:
-      'Regex capture rule to use. Valid only within a `regexManagers` object.',
+      'Regex capture rule to use. Valid only within a `customManagers` object.',
     type: 'array',
     subType: 'string',
     format: 'regex',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
@@ -2529,88 +2529,88 @@ const options: RenovateOptions[] = [
     type: 'string',
     default: 'any',
     allowedValues: ['any', 'recursive', 'combination'],
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'depNameTemplate',
     description:
-      'Optional depName for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional depName for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'packageNameTemplate',
     description:
-      'Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `regexManagers` object.',
+      'Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'datasourceTemplate',
     description:
-      'Optional datasource for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional datasource for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'depTypeTemplate',
     description:
-      'Optional `depType` for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional `depType` for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'currentValueTemplate',
     description:
-      'Optional `currentValue` for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional `currentValue` for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'versioningTemplate',
     description:
-      'Optional versioning for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional versioning for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'registryUrlTemplate',
     description:
-      'Optional registry URL for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional registry URL for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'extractVersionTemplate',
     description:
-      'Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional `extractVersion` for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },
   {
     name: 'autoReplaceStringTemplate',
     description:
-      'Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.',
+      'Optional `extractVersion` for extracted dependencies. Valid only within a `customManagers` object.',
     type: 'string',
-    parent: 'regexManagers',
+    parent: 'customManagers',
     cli: false,
     env: false,
   },