Change Maven dependency
org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId
Change a Maven dependency coordinates. The newGroupId
or newArtifactId
MUST be different from before. Matching <dependencyManagement>
coordinates are also updated if a newVersion
or versionPattern
is provided.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.24.0
Options
Type | Name | Description | Example |
---|---|---|---|
| oldGroupId | The old groupId to replace. The groupId is the first part of a dependency coordinate |
|
| oldArtifactId | The old artifactId to replace. The artifactId is the second part of a dependency coordinate |
|
| newGroupId | Optional. The new groupId to use. Defaults to the existing group id. |
|
| newArtifactId | Optional. The new artifactId to use. Defaults to the existing artifact id. |
|
| newVersion | Optional. An exact version number or node-style semver selector used to select the version number. |
|
| versionPattern | Optional. Allows version selection to be extended beyond the original Node Semver semantics. So for example,Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre |
|
| overrideManagedVersion | Optional. If the new dependency has a managed version, this flag can be used to explicitly set the version on the dependency. The default for this flag is | |
| changeManagedDependency | Optional. Also update the dependency management section. The default for this flag is |
Data Tables (Only available on the Moderne platform)
Maven metadata failures
Attempts to resolve maven metadata that failed.
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml
create a new recipe with a unique name. For example: com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample
. Here's how you can define and customize such a recipe within your rewrite.yml:
Now that com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample
has been defined activate it in your build file:
Add the following to your
pom.xml
file:
Run
mvn rewrite:run
to run the recipe.
See how this recipe works across multiple open-source repositories
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Contributors
Jonathan Leitschuh, Tyler Van Gorder, Patrick, Tim te Beek, Nick McKinney, Shannon Pamperl, Jonathan Schneider, Tobias Lidskog, Sam Snyder
Last updated