Comment on page

Change Gradle dependency

org.openrewrite.gradle.ChangeDependency
Change a Gradle dependency coordinates.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-gradle
version: 8.9.5
Options
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. You can also use latest.release for the latest available version and latest.patch if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors.
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 old dependency has a managed version, this flag can be used to explicitly set the version on the new dependency. WARNING: No check is done on the NEW dependency to verify if it is managed, it relies on whether the OLD dependency had a managed version. The default for this flag is false.
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:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeDependencyExample
displayName: Change Gradle dependency example
recipeList:
  - org.openrewrite.gradle.ChangeDependency:
      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.ChangeDependencyExample has been defined activate it in your build file:
Gradle
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.ChangeDependencyExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun 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 ChangeDependency
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, Joan Viladrosa, Jonathan Schnéider​

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. You can also use `latest.release` for the latest available version and `latest.patch` if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors.
`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 old dependency has a managed version, this flag can be used to explicitly set the version on the new dependency. WARNING: No check is done on the NEW dependency to verify if it is managed, it relies on whether the OLD dependency had a managed version. The default for this flag is `false`.

Change Extra Property

Change Gradle dependency artifact

Last modified 9d ago