feat(replacements): support for replacement name templating

docs/usage/configuration-options.md

@@ -2134,9 +2134,29 @@ Managers which do not support replacement:
 - `regex`
 
 Use the `replacementName` config option to set the name of a replacement package.
-Must be used with `replacementVersion` (see example below).
+
+Can be used in combination with `replacementVersion`, `replacementPrefixAdd` and `replacmeentPrefixRemove`.
+
 You can suggest a new community package rule by editing [the `replacements.ts` file on the Renovate repository](https://github.com/renovatebot/renovate/blob/main/lib/config/presets/internal/replacements.ts) and opening a pull request.
 
+### replacementPrefixAdd
+
+Use the `replacementPrefixAdd` config option to add a new prefix to the name of the replacement package.
+
+This is useful for situations such as migrating container registries / mirrors.
+
+Can be used in combination with `replacementName`, `replacementVersion` and `replacmeentPrefixRemove`.
+
+### replacementPrefixRemove
+
+Use the `replacementPrefixRemove` config option to remove a prefix from the replacement package.
+
+This is useful for situations such as migrating container registries / mirrors.
+
+Can be used in combination with `replacementVersion` and `replacmeentPrefixAdd`.
+
+If a `replacementName` has been used in the package rule, this will take priority.
+
 ### replacementVersion
 
 This config option only works with some managers.

lib/config/options/index.ts

@@ -1207,6 +1207,26 @@ const options: RenovateOptions[] = [
     cli: false,
     env: false,
   },
+  {
+    name: 'replacementPrefixAdd',
+    description:
+      'The name of the new prefix to add to the old deprecated dependency.',
+    type: 'string',
+    stage: 'package',
+    parent: 'packageRules',
+    cli: false,
+    env: false,
+  },
+  {
+    name: 'replacementPrefixRemove',
+    description:
+      'The name of the new prefix to add to the old deprecated dependency.',
+    type: 'string',
+    stage: 'package',
+    parent: 'packageRules',
+    cli: false,
+    env: false,
+  },
   {
     name: 'replacementVersion',
     description:

lib/workers/repository/process/lookup/index.spec.ts

@@ -1958,6 +1958,224 @@ describe('workers/repository/process/lookup/index', () => {
       ]);
     });
 
+    it('handles replacements - can remove old prefix', async () => {
+      config.packageName = 'mirror.some.org/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'mirror.some.org/library/';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'openjdk',
+          newValue: '17.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - will skip if prefix to remove does not match', async () => {
+      config.packageName = 'mirror.some.org/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'mirror.some.com/registry/';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - will add new prefix', async () => {
+      config.packageName = 'openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixAdd = 'mirror.some.org/library/';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'mirror.some.org/library/openjdk',
+          newValue: '17.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - can swap prefixes', async () => {
+      config.packageName = 'old.registry.net/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'old.registry.net/library/';
+      config.replacementPrefixAdd = 'new.registry.io/library/';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'new.registry.io/library/openjdk',
+          newValue: '17.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - prefix to be removed not matched, but adds new prefix', async () => {
+      config.packageName = 'mirror.com/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'old.registry.net/library/';
+      config.replacementPrefixAdd = 'new.registry.io/library/';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'new.registry.io/library/mirror.com/library/openjdk',
+          newValue: '17.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - replace name and prefix', async () => {
+      config.packageName = 'old.registry.net/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'old.registry.net/library/';
+      config.replacementPrefixAdd = 'new.registry.io/library/';
+      config.replacementName = 'eclipse-temurin';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'new.registry.io/library/eclipse-temurin',
+          newValue: '17.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
+    it('handles replacements - replace prefixes and version', async () => {
+      config.packageName = 'old.registry.net/library/openjdk';
+      config.currentValue = '17.0.0';
+      config.replacementPrefixRemove = 'old.registry.net/library/';
+      config.replacementPrefixAdd = 'new.registry.io/library/';
+      config.replacementVersion = '18.0.0';
+      config.datasource = DockerDatasource.id;
+      getDockerReleases.mockResolvedValueOnce({
+        releases: [
+          {
+            version: '17.0.0',
+          },
+          {
+            version: '18.0.0',
+          },
+        ],
+      });
+
+      expect((await lookup.lookupUpdates(config)).updates).toMatchObject([
+        {
+          updateType: 'replacement',
+          newName: 'new.registry.io/library/openjdk',
+          newValue: '18.0.0',
+        },
+        {
+          updateType: 'major',
+          newMajor: 18,
+          newValue: '18.0.0',
+          newVersion: '18.0.0',
+        },
+      ]);
+    });
+
     it('rollback for invalid version to last stable version', async () => {
       config.currentValue = '2.5.17';
       config.packageName = 'vue';

lib/workers/repository/process/lookup/index.ts

@@ -26,6 +26,11 @@ import { filterInternalChecks } from './filter-checks';
 import { generateUpdate } from './generate';
 import { getRollbackUpdate } from './rollback';
 import type { LookupUpdateConfig, UpdateResult } from './types';
+import {
+  addReplacementUpdateIfValid,
+  isReplacementNameRulesConfigured,
+  isReplacementRulesConfigured,
+} from './utils';
 
 export async function lookupUpdates(
   inconfig: LookupUpdateConfig
@@ -157,27 +162,10 @@ export async function lookupUpdates(
       }
       let rangeStrategy = getRangeStrategy(config);
 
-      if (config.replacementName && !config.replacementVersion) {
-        res.updates.push({
-          updateType: 'replacement',
-          newName: config.replacementName,
-          newValue: currentValue!,
-        });
+      if (isReplacementRulesConfigured(config)) {
+        addReplacementUpdateIfValid(res.updates, config);
       }
 
-      if (config.replacementName && config.replacementVersion) {
-        res.updates.push({
-          updateType: 'replacement',
-          newName: config.replacementName,
-          newValue: versioning.getNewValue({
-            // TODO #7154
-            currentValue: currentValue!,
-            newVersion: config.replacementVersion,
-            rangeStrategy: rangeStrategy!,
-            isReplacement: true,
-          })!,
-        });
-      }
       // istanbul ignore next
       if (
         isVulnerabilityAlert &&
@@ -344,19 +332,12 @@ export async function lookupUpdates(
       } else {
         delete res.skipReason;
       }
-    } else if (
-      !currentValue &&
-      config.replacementName &&
-      !config.replacementVersion
-    ) {
+    } else if (!currentValue && isReplacementNameRulesConfigured(config)) {
       logger.debug(
         `Handle name-only replacement for ${packageName} without current version`
       );
-      res.updates.push({
-        updateType: 'replacement',
-        newName: config.replacementName,
-        newValue: currentValue!,
-      });
+
+      addReplacementUpdateIfValid(res.updates, config);
     } else {
       res.skipReason = 'invalid-value';
     }

lib/workers/repository/process/lookup/types.ts

@@ -45,6 +45,8 @@ export interface LookupUpdateConfig
   packageName: string;
   minimumConfidence?: string;
   replacementName?: string;
+  replacementPrefixAdd?: string;
+  replacementPrefixRemove?: string;
   replacementVersion?: string;
 }