Skip to content

Commit

Permalink
feat: replacement support for all managers (#17883)
Browse files Browse the repository at this point in the history
Co-authored-by: Jamie Magee <jamie.magee@gmail.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
  • Loading branch information
4 people committed Jan 11, 2023
1 parent 9bb46ae commit 51107e3
Show file tree
Hide file tree
Showing 4 changed files with 926 additions and 15 deletions.
20 changes: 16 additions & 4 deletions docs/usage/configuration-options.md
Expand Up @@ -2026,19 +2026,31 @@ Example setting source URL for package "dummy":

### replacementName

This config option only works with the `npm` manager.
This config option only works with some managers.
We're working to support more managers, subscribe to issue [renovatebot/renovate#14149](https://github.com/renovatebot/renovate/issues/14149) to follow our progress.

Use this field to define the name of a replacement package.
Managers which do not support replacement:

- `bazel`
- `git-submodules`
- `gomod`
- `gradle`
- `hermit`
- `homebrew`
- `maven`
- `regex`

Use the `replacementName` config option to set the name of a replacement package.
Must be used with `replacementVersion` (see example below).
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.

### replacementVersion

This config option only works with the `npm` manager.
This config option only works with some managers.
We're working to support more managers, subscribe to issue [renovatebot/renovate#14149](https://github.com/renovatebot/renovate/issues/14149) to follow our progress.
For a list of managers which do not support replacement read the `replacementName` config option docs.

Use this field to define the version of a replacement package.
Use the `replacementVersion` config option to set the version of a replacement package.
Must be used with `replacementName`.
For example to replace the npm package `jade` with version `2.0.0` of the package `pug`:

Expand Down

0 comments on commit 51107e3

Please sign in to comment.