Comment on page
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.
- groupId: org.openrewrite
- artifactId: rewrite-maven
- version: 8.9.5
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 | oldRelativePath | Optional. The relativePath of the maven parent pom to be changed away from. |
String | newRelativePath | Optional. New relative path attribute for parent lookup. |
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 |
Attempts to resolve maven metadata that failed.
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
oldRelativePath: ../../pom.xml
newRelativePath: ../pom.xml
versionPattern: '-jre'
allowVersionDowngrades: null
retainVersions: com.jcraft:jsch
Now that
com.yourorg.ChangeParentPomExample has been defined activate it in your build file:Maven
Moderne CLI
- 1.Add the following to your
pom.xmlfile:
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.ChangeParentPomExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:runto 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 ChangeParentPom
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.
Sam Snyder, Jonathan Schneider, Valentin Delaye, Nick McKinney, Tyler Van Gorder, Knut Wannheden, Jonathan Leitschuh