Comment on page

Upgrade Maven parent project version

org.openrewrite.maven.UpgradeParentVersion
Set the parent pom version number according to a node-style semver selector or to a specific version number.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.9.5
Options
Type
Name
Description
String
groupId
The first part of a dependency coordinate 'org.springframework.boot:spring-boot-parent:VERSION'.
String
artifactId
The second part of a dependency coordinate 'org.springframework.boot:spring-boot-parent: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
List
retainVersions
Optional. Accepts a list of GAVs. For each GAV, if it is a project direct dependency, and it is removed from dependency management in the new parent pom, then it will be retained with an explicit version. The version can be omitted from the GAV to use the old value from dependency management
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.UpgradeParentVersionExample. 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.UpgradeParentVersionExample
displayName: Upgrade Maven parent project version example
recipeList:
  - org.openrewrite.maven.UpgradeParentVersion:
      groupId: org.springframework.boot
      artifactId: spring-boot-parent
      newVersion: 29.X
      versionPattern: '-jre'
      retainVersions: com.jcraft:jsch
Now that com.yourorg.UpgradeParentVersionExample has been defined activate it in your build file:
Maven
Moderne CLI
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.UpgradeParentVersionExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe UpgradeParentVersion
See how this recipe works across multiple open-source repositories
​​
​​
The community edition of the Moderne platform 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.
Contributors
​Jonathan Leitschuh, Jonathan Schneider, Nick McKinney, Valentin Delaye

Type	Name	Description
`String`	groupId	The first part of a dependency coordinate 'org.springframework.boot:spring-boot-parent:VERSION'.
`String`	artifactId	The second part of a dependency coordinate 'org.springframework.boot:spring-boot-parent: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
`List`	retainVersions	Optional. Accepts a list of GAVs. For each GAV, if it is a project direct dependency, and it is removed from dependency management in the new parent pom, then it will be retained with an explicit version. The version can be omitted from the GAV to use the old value from dependency management

Upgrade Maven dependency version

Upgrade Maven plugin version

Last modified 12d ago