Comment on page

Change Gradle or Maven dependency

org.openrewrite.java.dependencies.ChangeDependency
Change the groupId, artifactId 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.2.0
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
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.
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.
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 or Maven dependency example
recipeList:
  - org.openrewrite.java.dependencies.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 and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.2.0 in your build file:
Gradle
Maven
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()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.2.0")
}
2.Run gradle rewriteRun to run the recipe.
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangeDependencyExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-java-dependencies</artifactId>
            <version>1.2.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
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 ChangeDependency
Definition
Recipe List
Yaml Recipe List
​Change Gradle dependency​
​Change Maven dependency groupId, artifactId and/or the version​
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.dependencies.ChangeDependency
displayName: Change Gradle or Maven dependency
description: Change the groupId, artifactId and/or the version of a specified Gradle or Maven dependency.
​
​
​
​
​
​
​
recipeList:
  - org.openrewrite.gradle.ChangeDependency:
  - org.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId:
​
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​

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`.

Add Gradle or Maven dependency

Dependency Insight Gradle or Maven

Last modified 9d ago