Comment on page
Upgrade Gradle dependency versions
org.openrewrite.gradle.UpgradeDependencyVersion
_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'
Can update version numbers which are defined earlier in the same file in variable declarations._
- groupId: org.openrewrite
- artifactId: rewrite-gradle
- version: 8.9.5
Type | Name | Description |
---|---|---|
String | groupId | The first part of a dependency coordinate com.google.guava:guava:VERSION . This can be a glob expression. |
String | artifactId | The second part of a dependency coordinate com.google.guava:guava:VERSION . This can be a glob expression. |
String | newVersion | Optional. 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 version and latest.patch if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors. Defaults to latest.release . |
String | versionPattern | 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 |
Attempts to resolve maven metadata that failed.
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.UpgradeDependencyVersionExample
. 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.UpgradeDependencyVersionExample
displayName: Upgrade Gradle dependency versions example
recipeList:
- org.openrewrite.gradle.UpgradeDependencyVersion:
groupId: com.fasterxml.jackson*
artifactId: jackson-module*
newVersion: 29.X
versionPattern: '-jre'
Now that
com.yourorg.UpgradeDependencyVersionExample
has been defined activate it in your build file:Gradle
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.UpgradeDependencyVersionExample")
}
repositories {
mavenCentral()
}
- 2.Run
gradle rewriteRun
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 UpgradeDependencyVersion
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.