Upgrade Gradle or Maven dependency versions
org.openrewrite.java.dependencies.UpgradeDependencyVersionorg.openrewrite.recipe:rewrite-java-dependenciesFor Gradle projects, upgrade the version of a dependency in a build.gradle 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.
For Maven projects, upgrade the version of a dependency by specifying a group ID and (optionally) an artifact ID using Node Semver advanced range selectors, allowing more precise control over version updates to patch or minor releases.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.dependencies.UpgradeDependencyVersion --recipe-option "groupId=com.fasterxml.jackson*" --recipe-option "artifactId=jackson-module*" --recipe-option "newVersion=29.X"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.60.0Options
| Name | Type | Description |
|---|---|---|
groupIdrequired | String | The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.e.g. com.fasterxml.jackson* |
artifactIdrequired | String | The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.e.g. jackson-module* |
newVersionrequired | String | An exact version number or node-style semver selector used to select the version number. e.g. 29.X |
versionPattern | String | 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 e.g. -jre |
overrideManagedVersion | Boolean | For Maven project only, This flag can be set to explicitly override a managed dependency's version. The default for this flag is false. |
retainVersions | List | For Maven project 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. e.g. com.jcraft:jsch |
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