Links

Change Maven Parent Pom

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.

Source

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

Options

Type
Name
Description
String
oldGroupId
The groupId of the maven parent pom to be changed away from.
String
newGroupId
Optional. The groupId of the new maven parent pom to be adopted. If this argument is omitted it defaults to the value of oldGroupId.
String
oldArtifactId
The artifactId of the maven parent pom to be changed away from.
String
newArtifactId
Optional. The artifactId of the new maven parent pom to be adopted. If this argument is omitted it defaults to the value of oldArtifactId.
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
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.
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.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 Pom 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
versionPattern: '-jre'
allowVersionDowngrades: false
retainVersions: - com.jcraft:jsch
Now that com.yourorg.ChangeParentPomExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.ChangeParentPomExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeParentPomExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangeParentPomExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.