Open source

Change Maven dependency

Recipe IDorg.openrewrite.maven.ChangeDependencyGroupIdAndArtifactId

Artifactorg.openrewrite:rewrite-maven

Change a Maven dependency coordinates. The newGroupId or newArtifactId MUST be different from before. Matching <dependencyManagement> coordinates are also updated if a newVersion or versionPattern is provided. Exclusions that reference the old dependency coordinates are preserved, and a sibling exclusion for the new coordinates is added alongside them.

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

8 parameters

2 required6 optional

Parameter	Example	Type	Required
oldArtifactId	rewrite-testing-frameworks	String	Required
The old artifactId to replace. The artifactId is the second part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob expressions.
oldGroupId	org.openrewrite.recipe	String	Required
The old groupId to replace. The groupId is the first part of a dependency coordinate com.google.guava:guava:VERSION. Supports glob expressions.
changeManagedDependency	—	Boolean	Optional
Also update the dependency management section. The default for this flag is true.
newArtifactId	rewrite-testing-frameworks	String	Optional
The new artifactId to use. Defaults to the existing artifact id.
newGroupId	corp.internal.openrewrite.recipe	String	Optional
The new groupId to use. Defaults to the existing group id.
newVersion	29.X	String	Optional
An exact version number or node-style semver selector used to select the version number.
overrideManagedVersion	—	Boolean	Optional
If the new dependency has a managed version, this flag can be used to explicitly set the version on the dependency. The default for this flag is false.
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	javax.activation
oldArtifactId	javax.activation-api
newGroupId	jakarta.activation
newArtifactId	jakarta.activation-api
newVersion	null
versionPattern	null
overrideManagedVersion	false
changeManagedDependency	false

xml

Before

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>javax.activation</groupId>
            <artifactId>javax.activation-api</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>javax.activation</groupId>
                <artifactId>javax.activation-api</artifactId>
                <version>1.2.0</version>
            </dependency>
            <dependency>
                <groupId>jakarta.activation</groupId>
                <artifactId>jakarta.activation-api</artifactId>
                <version>1.2.1</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

After

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>jakarta.activation</groupId>
            <artifactId>jakarta.activation-api</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>javax.activation</groupId>
                <artifactId>javax.activation-api</artifactId>
                <version>1.2.0</version>
            </dependency>
            <dependency>
                <groupId>jakarta.activation</groupId>
                <artifactId>jakarta.activation-api</artifactId>
                <version>1.2.1</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -8,2 +8,2 @@
    <dependencies>
        <dependency>
-           <groupId>javax.activation</groupId>
-           <artifactId>javax.activation-api</artifactId>
+           <groupId>jakarta.activation</groupId>
+           <artifactId>jakarta.activation-api</artifactId>
        </dependency>

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 ChangeDependencyGroupIdAndArtifactId --recipe-option "oldGroupId=org.openrewrite.recipe" --recipe-option "oldArtifactId=rewrite-testing-frameworks" --recipe-option "newGroupId=corp.internal.openrewrite.recipe" --recipe-option "newArtifactId=rewrite-testing-frameworks" --recipe-option "newVersion=29.X" --recipe-option "versionPattern='-jre'"

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.