Change a Gradle dependency version
** org.openrewrite.gradle.ChangeDependencyVersion** Finds dependencies declared in
build.gradle files.Source
- groupId: org.openrewrite
- artifactId: rewrite-gradle
- version: 7.22.0
Options
1
| `String` | dependencyPattern | A dependency pattern specifying which dependencies should have their groupId updated. Dependency patterns are a concise way of describing which dependencies are applicable to a recipe. Valid dependency patterns take one of these forms:
Copied!
- groupId:artifactId
- groupId:artifactId:versionSelector
- groupId:artifactId:versionSelector/versionPattern
"groupId" and "artifactId" accept glob patterns. "versionSelector" accepts both literal version numbers and semver selectors. "versionPattern" is used for artifacts that encode variant/platform information in their version.Guava is a common example of such a library. Guava appends "-jre" or "-android" to its version to indicate platform compatibility. | |
String | newVersion | The version number to update the dependency to | | 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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangeDependencyVersionExample
4
displayName: Change a Gradle dependency version example
5
recipeList:
6
- org.openrewrite.gradle.ChangeDependencyVersion:
7
dependencyPattern: com.fasterxml.jackson*:*
8
newVersion: 1.0
9
configuration: api
Copied!
Now that
com.yourorg.ChangeDependencyVersionExample has been defined activate it and take a dependency on org.openrewrite:rewrite-gradle:7.22.0 in your build file:Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
​
5
rewrite {
6
activeRecipe("com.yourorg.ChangeDependencyVersionExample")
7
}
8
​
9
repositories {
10
mavenCentral()
11
}
12
​
13
dependencies {
14
rewrite("org.openrewrite:rewrite-gradle:7.22.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ChangeDependencyVersionExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite</groupId>
16
<artifactId>rewrite-gradle</artifactId>
17
<version>7.22.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument
-Drewrite.activeRecipes=com.yourorg.ChangeDependencyVersionExampleLast modified 5d ago