upgradeparentversion.md

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.

Source

GitHub, Issue Tracker, Maven Central

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

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

Example

Parameters

Parameter	Value
groupId	org.jenkins-ci.plugins
artifactId	plugin
newVersion	4.40
versionPattern	null
retainVersions	null

{% tabs %} {% tab title="pom.xml" %}

Before

{% code title="pom.xml" %}

<project>
    <parent>
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
        <version>4.33</version>
    </parent>
    <artifactId>antisamy-markup-formatter</artifactId>
    <version>1.0.0</version>
</project>

{% endcode %}

After

{% code title="pom.xml" %}

<project>
    <parent>
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
        <version>4.40</version>
    </parent>
    <artifactId>antisamy-markup-formatter</artifactId>
    <version>1.0.0</version>
</project>

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- pom.xml
+++ pom.xml
@@ -5,1 +5,1 @@
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
-       <version>4.33</version>
+       <version>4.40</version>
    </parent>

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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

{% endcode %}

Now that com.yourorg.UpgradeParentVersionExample has been defined activate it in your build file: {% tabs %}

{% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.UpgradeParentVersionExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Leitschuh
• Jonathan Schneider
• Nick McKinney

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.