Skip to main content

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringoldGroupIdThe old group ID to replace. The group ID is the first part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.org.openrewrite.recipe
StringoldArtifactIdThe old artifact ID to replace. The artifact ID is the second part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.rewrite-testing-frameworks
StringnewGroupIdOptional. The new group ID to use. Defaults to the existing group ID.corp.internal.openrewrite.recipe
StringnewArtifactIdOptional. The new artifact ID to use. Defaults to the existing artifact ID.rewrite-testing-frameworks
StringnewVersionOptional. An exact version number or node-style semver selector used to select the version number.29.X
StringversionPatternOptional. 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
BooleanoverrideManagedVersionOptional. 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.
BooleanchangeManagedDependencyOptional. Also update the dependency management section. The default for this flag is true.

Examples​

Example 1​

Change Gradle dependency

Parameters​
ParameterValue
oldGroupIdcommons-lang
oldArtifactIdcommons-lang
newGroupIdorg.apache.commons
newArtifactIdcommons-lang3
newVersion3.11.x
versionPatternnull
overrideManagedVersionnull
changeManagedDependencynull
Before​
build.gradle
plugins {
    id "java-library"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation "commons-lang:commons-lang:2.6"
}
After​
build.gradle
plugins {
    id "java-library"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation "org.apache.commons:commons-lang3:3.11"
}
Example 2​

Change Maven dependency

Parameters​
ParameterValue
oldGroupIdcommons-lang
oldArtifactIdcommons-lang
newGroupIdorg.apache.commons
newArtifactIdcommons-lang3
newVersion3.11.x
versionPatternnull
overrideManagedVersionnull
changeManagedDependencynull
Before​
pom.xml
<project>
    <groupId>com.example.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.6</version>
        </dependency>
    </dependencies>
</project>
After​
pom.xml
<project>
    <groupId>com.example.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.11</version>
        </dependency>
    </dependencies>
</project>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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'

Now that com.yourorg.ChangeDependencyExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.34.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.2")
}

rewrite {
    activeRecipe("com.yourorg.ChangeDependencyExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.34.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Shannon Pamperl, Tim te Beek, Jonathan Schneider, Sam Snyder, Greg Oledzki, Joan Viladrosa