Links

Upgrade Maven dependency version

org.openrewrite.maven.UpgradeDependencyVersion Upgrade the version of a dependency by specifying a group and (optionally) an artifact 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.33.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 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
overrideManagedVersion
Optional. This flag can be set to explicitly override a managed dependency's version. The default for this flag is false.

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.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 Maven dependency version example
recipeList:
- org.openrewrite.maven.UpgradeDependencyVersion:
groupId: com.fasterxml.jackson*
artifactId: jackson-module*
newVersion: 29.X
versionPattern: '-jre'
overrideManagedVersion: false
Now that com.yourorg.UpgradeDependencyVersionExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.32.0")
}
rewrite {
activeRecipe("com.yourorg.UpgradeDependencyVersionExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.37.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.UpgradeDependencyVersionExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.UpgradeDependencyVersionExample