Open source

Change Maven parent

Recipe IDorg.openrewrite.maven.ChangeParentPom

Artifactorg.openrewrite:rewrite-maven

Change the parent pom of a Maven pom.xml by matching the existing parent via groupId and artifactId, and updating it to a new groupId, artifactId, version, and optional relativePath. Also updates the project to retain dependency management and properties previously inherited from the old parent that are no longer provided by the new parent. Removes redundant dependency versions already managed by the new parent.

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

10 parameters

3 required7 optional

Parameter	Example	Type	Required
newVersion	29.X	String	Required
An exact version number or node-style semver selector used to select the version number.
oldArtifactId	spring-boot-starter-parent	String	Required
The artifact ID of the maven parent pom to be changed away from.
oldGroupId	org.springframework.boot	String	Required
The group ID of the Maven parent pom to be changed away from.
allowVersionDowngrades	—	Boolean	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.
except	com.jcraft:jsch	List	Optional
Accepts a list of GAVs that should be retained when calling RemoveRedundantDependencyVersions.
newArtifactId	spring-boot-starter-parent	String	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.
newGroupId	org.springframework.boot	String	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.
newRelativePath	../pom.xml	String	Optional
New relative path attribute for parent lookup.
oldRelativePath	../../pom.xml	String	Optional
The relativePath of the maven parent pom to be changed away from. Use an empty String to match <relativePath />, use ../pom.xml to match the default value.
versionPattern	-jre	String	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

Examples

xml

Parameter	Value
oldGroupId	org.springframework.boot
newGroupId	com.fasterxml.jackson
oldArtifactId	spring-boot-starter-parent
newArtifactId	jackson-parent
newVersion	2.12
oldRelativePath	null
newRelativePath	null
versionPattern	null
allowVersionDowngrades	false
except	null

xml

Before

<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.12.RELEASE</version>
  </parent>

  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

After

<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>com.fasterxml.jackson</groupId>
    <artifactId>jackson-parent</artifactId>
    <version>2.12</version>
  </parent>

  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -5,3 +5,3 @@

  <parent>
-   <groupId>org.springframework.boot</groupId>
-   <artifactId>spring-boot-starter-parent</artifactId>
-   <version>1.5.12.RELEASE</version>
+   <groupId>com.fasterxml.jackson</groupId>
+   <artifactId>jackson-parent</artifactId>
+   <version>2.12</version>
  </parent>

xml

Parameter	Value
oldGroupId	org.springframework.cloud
newGroupId	null
oldArtifactId	spring-cloud-config-dependencies
newArtifactId	null
newVersion	3.1.4
oldRelativePath	null
newRelativePath	null
versionPattern	null
allowVersionDowngrades	null
except	null

xml

Before

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.sample</groupId>
  <artifactId>sample</artifactId>
  <version>1.0.0</version>

  <parent>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-dependencies</artifactId>
    <version>3.1.2</version>
  </parent>

  <dependencies>
    <dependency>
      <groupId>com.jcraft</groupId>
      <artifactId>jsch</artifactId>
      <version>0.1.55</version>
    </dependency>
  </dependencies>
</project>

After

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.sample</groupId>
  <artifactId>sample</artifactId>
  <version>1.0.0</version>

  <parent>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-dependencies</artifactId>
    <version>3.1.4</version>
  </parent>

  <dependencies>
    <dependency>
      <groupId>com.jcraft</groupId>
      <artifactId>jsch</artifactId>
      <version>0.1.55</version>
    </dependency>
  </dependencies>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -10,1 +10,1 @@
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-dependencies</artifactId>
-   <version>3.1.2</version>
+   <version>3.1.4</version>
  </parent>

Usage

Run this 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 --recipe-option "oldGroupId=org.springframework.boot" --recipe-option "newGroupId=org.springframework.boot" --recipe-option "oldArtifactId=spring-boot-starter-parent" --recipe-option "newArtifactId=spring-boot-starter-parent" --recipe-option "newVersion=29.X" --recipe-option "oldRelativePath=../../pom.xml" --recipe-option "newRelativePath=../pom.xml" --recipe-option "versionPattern='-jre'" --recipe-option "except=com.jcraft:jsch"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-maven:8.85.6

Data tables

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.