Update a Gradle plugin by id
** org.openrewrite.gradle.UpgradePluginVersion** Update a Gradle plugin by id to a later version.

Source

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

Options

Type
Name
Description
String
pluginIdPattern
The ID part of plugin { ID }, as a glob expression.
String
newVersion
An exact version number, or node-style semver selector used to select the 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

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.UpgradePluginVersionExample. 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.UpgradePluginVersionExample
4
displayName: Update a Gradle plugin by id example
5
recipeList:
6
- org.openrewrite.gradle.UpgradePluginVersion:
7
pluginIdPattern: com.jfrog.bintray
8
newVersion: 29.X
9
versionPattern: '-jre'
Copied!
Now that com.yourorg.UpgradePluginVersionExample 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.UpgradePluginVersionExample")
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.UpgradePluginVersionExample</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.UpgradePluginVersionExample
Export as PDF
Copy link