feat(replacements): support for replacement name templating

[setchy]

Changes

Adds a new configuration options called replacementNameTemplate which supports all of the allowed template fields.

Replacement logic has been refactored to a set of utility functions to reduce duplicating logic

Context

Closes #20890

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[setchy]

Open items

• review new configuration option names
• run against a real repository (by EOD)
• discuss if replacement helper functions should stay within lookup/index.ts or their own file

[fgreinacher]

I think this overlaps a bit with #20898 😀

[setchy]

I think this overlaps a bit with #20898 😀

Yes indeed.

If I'm not mistaken, that could be achieved by a single package rule such as

"packageRules": [
    {
      "matchDatasources": [
        "docker"
      ],
      "matchPackagePatterns": ["k8s.gcr.io/"],
      "replacementPrefixRemove": "k8s.gcr.io/",
      "replacementPrefixAdd": "registry.k8s.io/"
    }
]

which could be added as a new replacement preset

[setchy]

Just ran this against a real repository - worked a treat 🚀

[fgreinacher]

As mentioned in the issue I'm still unsure whether this is common enough to warrant two new options.

If it is i think it would be better to have a single option that describes the prefix change. Maybe we could reuse the template concept and go with something like replacementNameTemplate?

[secustor]

I also like the idea of reusing templates, but I can currently don't see how the use cases could be implemented using them.

@fgreinacher Could you elaborate how this should work?

[secustor]

The code LGTM

[fgreinacher]

I also like the idea of reusing templates, but I can currently don't see how the use cases could be implemented using them.

@fgreinacher Could you elaborate how this should work?

If we conceptually follow the regex manager approach, something like this maybe?

{
   "matchPackagePatterns": ["^oldPrefix/(?<packageNameWithoutPrefix>.*)"],
   "replacementNameTemplate": "newPrefix/{{{packageNameWithoutPrefix}}}"
}

[viceice]

converted to draft, will do some experiements first, checkout slack discussion

[viceice]

checkout https://github.com/renovate-reproductions/docker-replacements/pulls

@setchy anything else this PR can do which is currently not possible?

[viceice]

I also like the idea of reusing templates, but I can currently don't see how the use cases could be implemented using them.
@fgreinacher Could you elaborate how this should work?

If we conceptually follow the regex manager approach, something like this maybe?

{
   "matchPackagePatterns": ["^oldPrefix/(?<packageNameWithoutPrefix>.*)"],
   "replacementNameTemplate": "newPrefix/{{{packageNameWithoutPrefix}}}"
}

This would make more sense to me, as it allows to use less replacement rules.

[secustor]

Can you link the repo on which you have run your changes?

[fgreinacher]

This is awesome, love it 😍

[setchy]

Can you link the repo on which you have run your changes?

@secustor - take a look at this repository https://github.com/setchy/renovate-docker-replacement

[setchy]

@secustor - I made an update to the documentation to callout that replacementName will take precedence - would you mind re-approving please 🙏

[setchy]

@viceice @JamieMagee WDYT?

[JamieMagee]

This looks great to me 👍

[renovate-release]

🎉 This PR is included in version 35.16.0 🎉

The release is available on:

• GitHub release
• 35.16.0

Your semantic-release bot 📦🚀

[viceice]

nice solution

[setchy]

thank you all. much better solution than where this PR started, appreciate the input.

@fgreinacher, up to you if you want to move the k8s.gcr.io replacement rules to use a replacementNameTemplate or not :)

[fgreinacher]

@fgreinacher, up to you if you want to move the k8s.gcr.io replacement rules to use a replacementNameTemplate or not :)

Definitely! Will send a PR tomorrow!