← All recipes
Open source

Change Gradle or Maven dependency

Recipe IDorg.openrewrite.java.dependencies.ChangeDependency
Artifactorg.openrewrite.recipe:rewrite-java-dependencies

Change the group ID, artifact ID, and/or the version of a specified Gradle or Maven dependency.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.dependencies.ChangeDependency --recipe-option "oldGroupId=org.openrewrite.recipe" --recipe-option "oldArtifactId=rewrite-testing-frameworks"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.60.0

Options

NameTypeDescription
oldGroupIdrequiredStringThe old group ID to replace. The group ID is the first part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.
e.g. org.openrewrite.recipe
oldArtifactIdrequiredStringThe old artifact ID to replace. The artifact ID is the second part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.
e.g. rewrite-testing-frameworks
newGroupIdStringThe new group ID to use. Defaults to the existing group ID.
e.g. corp.internal.openrewrite.recipe
newArtifactIdStringThe new artifact ID to use. Defaults to the existing artifact ID.
e.g. rewrite-testing-frameworks
newVersionStringAn exact version number or node-style semver selector used to select the version number.
e.g. 29.X
versionPatternStringAllows 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
e.g. -jre
overrideManagedVersionBooleanIf 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.
changeManagedDependencyBooleanAlso update the dependency management section. The default for this flag is true.

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats