Change Maven parent

org.openrewrite.maven.ChangeParentPom

Change the parent pom of a Maven pom.xml. Identifies the parent pom to be changed by its groupId and artifactId.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-maven

• version: 8.24.0

Options

Type	Name	Description	Example
String	oldGroupId	The group ID of the Maven parent pom to be changed away from.	org.springframework.boot
String	newGroupId	Optional. The group ID of the new maven parent pom to be adopted. If this argument is omitted it defaults to the value of oldGroupId.	org.springframework.boot
String	oldArtifactId	The artifact ID of the maven parent pom to be changed away from.	spring-boot-starter-parent
String	newArtifactId	Optional. The artifact ID of the new maven parent pom to be adopted. If this argument is omitted it defaults to the value of oldArtifactId.	spring-boot-starter-parent
String	newVersion	An exact version number or node-style semver selector used to select the version number.	29.X
String	oldRelativePath	Optional. The relativePath of the maven parent pom to be changed away from.	../../pom.xml
String	newRelativePath	Optional. New relative path attribute for parent lookup.	../pom.xml
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	-jre
Boolean	allowVersionDowngrades	Optional. If the new parent has the same group/artifact, this flag can be used to only upgrade the version if the target version is newer than the current.

Data Tables (Only available on the Moderne platform)

Maven metadata failures

Attempts to resolve maven metadata that failed.

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.ChangeParentPomExample. 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.ChangeParentPomExample
displayName: Change Maven parent example
recipeList:
  - org.openrewrite.maven.ChangeParentPom:
      oldGroupId: org.springframework.boot
      newGroupId: org.springframework.boot
      oldArtifactId: spring-boot-starter-parent
      newArtifactId: spring-boot-starter-parent
      newVersion: 29.X
      oldRelativePath: ../../pom.xml
      newRelativePath: ../pom.xml
      versionPattern: '-jre'

Now that com.yourorg.ChangeParentPomExample has been defined activate it in your build file:

Maven

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.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangeParentPomExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangeParentPomExample

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

Sam Snyder, Nick McKinney, Jonathan Schnéider, Valentin Delaye, Tyler Van Gorder, Knut Wannheden, Jonathan Leitschuh, Tim te Beek