Change Maven dependency groupId, artifactId and/or the version
org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId
Change the groupId, artifactId and/or the version of a specified Maven dependency.
- groupId: org.openrewrite
- artifactId: rewrite-maven
- version: 8.6.0
Type | Name | Description |
---|---|---|
String | oldGroupId | The old groupId to replace. The groupId is the first part of a dependency coordinate com.google.guava:guava:VERSION . Supports glob expressions. |
String | oldArtifactId | The old artifactId to replace. The artifactId is the second part of a dependency coordinate com.google.guava:guava:VERSION . Supports glob expressions. |
String | newGroupId | Optional. The new groupId to use. Defaults to the existing group id. |
String | newArtifactId | Optional. The new artifactId to use. Defaults to the existing artifact id. |
String | newVersion | Optional. An exact version number or node-style semver selector used to select the version number. |
String | 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 |
Boolean | 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 false . |
Attempts to resolve maven metadata that failed.
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:rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample
displayName: Change Maven dependency groupId, artifactId and/or the version example
recipeList:
- org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId:
oldGroupId: org.openrewrite.recipe
oldArtifactId: rewrite-testing-frameworks
newGroupId: corp.internal.openrewrite.recipe
newArtifactId: rewrite-testing-frameworks
newVersion: 29.X
versionPattern: '-jre'
overrideManagedVersion: null
Now that
com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample
has been defined activate it in your build file:Maven
- 1.Add the following to your
pom.xml
file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.5.2</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:run
to run the recipe.
- Tyler Van Gorder
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.
Last modified 6d ago