Open source

Upgrade Gradle or Maven dependency versions

Recipe IDorg.openrewrite.java.dependencies.UpgradeDependencyVersion

Artifactorg.openrewrite.recipe:rewrite-java-dependencies

For Gradle projects, upgrade the version of a dependency in a build.gradle or build.gradle.kts file. Supports updating dependency declarations of various forms:

• String notation: "group:artifact:version"
• Map notation: group: 'group', name: 'artifact', version: 'version' It is possible to update version numbers which are defined earlier in the same file in variable declarations, in gradle.properties, or in a version catalog.

For Maven projects, upgrade the version of a dependency by specifying a group ID and an artifact ID using Node Semver advanced range selectors, allowing more precise control over version updates to patch or minor releases.

Single recipeJavaApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

6 parameters

3 required3 optional

Parameter	Example	Type	Required
artifactId	jackson-module*	String	Required
The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
groupId	com.fasterxml.jackson*	String	Required
The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
newVersion	29.x	String	Required
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 release version, latest.integration to include pre-release and snapshot versions, and latest.patch for patch updates if the current version is a valid semantic version. For more details, you can look at the documentation page of [version selectors](https://docs.openrewrite.org/reference/dependency-version-selectors).
overrideManagedVersion	—	Boolean	Optional
For Maven only, this flag can be set to explicitly override a managed dependency's version. The default for this flag is false.
retainVersions	com.jcraft:jsch	List	Optional
For Maven only, accepts a list of GAVs. For each GAV, if it is a project direct dependency, and it is removed from dependency management after the changes from this recipe, then it will be retained with an explicit version. The version can be omitted from the GAV to use the old value from dependency management.
versionPattern	-jre	String	Optional
Allows version selection to be extended beyond the original Node Semver semantics. So for example, setting newVersion to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre.

Examples

groovy

Parameter	Value
groupId	com.google.guava
artifactId	guava
newVersion	30.x
versionPattern	-jre
overrideManagedVersion	null
retainVersions	null

groovy

Before

plugins {
  id 'java-library'
}

repositories {
  mavenCentral()
}

dependencies {
  compileOnly 'com.google.guava:guava:29.0-jre'
  runtimeOnly ('com.google.guava:guava:29.0-jre')
}

After

plugins {
  id 'java-library'
}

repositories {
  mavenCentral()
}

dependencies {
  compileOnly 'com.google.guava:guava:30.1.1-jre'
  runtimeOnly ('com.google.guava:guava:30.1.1-jre')
}

Diff

--- build.gradle
+++ build.gradle
@@ -10,2 +10,2 @@

dependencies {
- compileOnly 'com.google.guava:guava:29.0-jre'
- runtimeOnly ('com.google.guava:guava:29.0-jre')
+ compileOnly 'com.google.guava:guava:30.1.1-jre'
+ runtimeOnly ('com.google.guava:guava:30.1.1-jre')
}

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe UpgradeDependencyVersion --recipe-option "groupId=com.fasterxml.jackson*" --recipe-option "artifactId=jackson-module*" --recipe-option "newVersion=29.x"

To also set the recipe's optional settings, add them to the command. The values below are examples, not recommendations; see Options for what each one does.

With optional settings (example values)

mod run . --recipe UpgradeDependencyVersion \
  --recipe-option "groupId=com.fasterxml.jackson*" \
  --recipe-option "artifactId=jackson-module*" \
  --recipe-option "newVersion=29.x" \
  --recipe-option "versionPattern='-jre'" \
  --recipe-option "overrideManagedVersion=true" \
  --recipe-option "retainVersions=com.jcraft:jsch"

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

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

LATEST

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

Pinned version

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

Data tables

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.maven.table.MavenMetadataFailures

Column	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileResults

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SearchResults

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileErrors

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.