Links

Change Maven dependency

org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId
Change a Maven dependency coordinates. The newGroupId or newArtifactId MUST be different from before.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 8.17.1

Options

Type
Name
Description
Example
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.
org.openrewrite.recipe
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.
rewrite-testing-frameworks
String
newGroupId
Optional. The new groupId to use. Defaults to the existing group id.
corp.internal.openrewrite.recipe
String
newArtifactId
Optional. The new artifactId to use. Defaults to the existing artifact id.
rewrite-testing-frameworks
String
newVersion
Optional. An exact version number or node-style semver selector used to select the version number.
29.X
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
-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.
Boolean
changeManagedDependency
Optional. Also update the dependency management section. The default for this flag is true.

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:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample
displayName: Change Maven dependency 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'
Now that com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample has been defined activate it in your build file:
Maven
Moderne CLI
  1. 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.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeDependencyGroupIdAndArtifactIdExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangeDependencyGroupIdAndArtifactIdExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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