Design Partners
Upgrade Maven plugin version
** org.openrewrite.maven.UpgradePluginVersion** Upgrade the version of a plugin using Node Semver advanced range selectors, allowing more precise control over version updates to patch or minor releases.

Source

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

Options

Type
Name
Description
String
groupId
The first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String
artifactId
The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
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
Boolean
trustParent
Optional. Even if the parent suggests a version that is older than what we are trying to upgrade to, trust it anyway. Useful when you want to wait for the parent to catch up before upgrading. The parent is not trusted by default.

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: Upgrade Maven plugin version example
5
recipeList:
6
- org.openrewrite.maven.UpgradePluginVersion:
7
groupId: org.openrewrite.maven
8
artifactId: rewrite-maven-plugin
9
newVersion: 29.X
10
versionPattern: '-jre'
11
trustParent: false
Copied!
Now that com.yourorg.UpgradePluginVersionExample has been defined activate it 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
}
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
</plugin>
14
</plugins>
15
</build>
16
</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