Change Gradle or Maven dependency
org.openrewrite.java.dependencies.ChangeDependency
Change the group ID, artifact ID, and/or the version of a specified Gradle or Maven dependency.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-java-dependencies
version: 1.7.0
Options
Type | Name | Description | Example |
---|---|---|---|
| oldGroupId | The old group ID to replace. The group ID is the first part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions. |
|
| oldArtifactId | The old artifact ID to replace. The artifact ID is the second part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions. |
|
| newGroupId | Optional. The new group ID to use. Defaults to the existing group ID. |
|
| newArtifactId | Optional. The new artifact ID 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 |
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.ChangeDependencyExample
. Here's how you can define and customize such a recipe within your rewrite.yml:
Now that com.yourorg.ChangeDependencyExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.7.0 in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
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
Shannon Pamperl, Tim te Beek, Jonathan Schneider, Joan Viladrosa
Last updated