Links

Change a Gradle dependency version

org.openrewrite.gradle.ChangeDependencyVersion Change a version of a specified dependency. The new version must be an exact version number.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-gradle
  • version: 7.38.0

Options

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
An exact version number.
String
versionPattern
Optional. 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
String
configuration
Optional. The dependency configuration to search for dependencies in.

Usage

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.ChangeDependencyVersionExample. 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.ChangeDependencyVersionExample
displayName: Change a Gradle dependency version example
recipeList:
- org.openrewrite.gradle.ChangeDependencyVersion:
groupId: com.fasterxml.jackson*
artifactId: jackson-module*
newVersion: 29.0
versionPattern: '-jre'
configuration: api
Now that com.yourorg.ChangeDependencyVersionExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.38.0")
}
rewrite {
activeRecipe("com.yourorg.ChangeDependencyVersionExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.42.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeDependencyVersionExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.