Upgrade transitive Maven dependencies

org.openrewrite.maven.UpgradeTransitiveDependencyVersion

Upgrades the version of a transitive dependency in a Maven pom file. Leaves direct dependencies unmodified. Can be paired with the regular Upgrade Dependency Version recipe to upgrade a dependency everywhere, regardless of whether it is direct or transitive.

Recipe source

GitHub, Issue Tracker, Maven Central

groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.30.0

Options

Type Name Description Example

Type	Name	Description	Example
`String`	groupId	The first part of a dependency coordinate 'org.apache.logging.log4j:ARTIFACT_ID:VERSION'.	`org.apache.logging.log4j`
`String`	artifactId	The second part of a dependency coordinate 'org.apache.logging.log4j:log4j-bom:VERSION'.	`log4j-bom`
`String`	version	An exact version number or node-style semver selector used to select the version number.	`latest.release`
`String`	scope	Optional. An optional scope to use for the dependency management tag. Valid options: `import`, `runtime`, `provided`, `test`	`import`
`String`	type	Optional. An optional type to use for the dependency management tag. Valid options: `jar`, `pom`, `war`	`pom`
`String`	classifier	Optional. An optional classifier to use for the dependency management tag	`test`
`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 29.0-jre	`-jre`
`Boolean`	releasesOnly	Optional. Whether to exclude snapshots from consideration when using a semver selector
`String`	onlyIfUsing	Optional. Only add managed dependencies to projects having a dependency matching the expression.	`org.apache.logging.log4j:log4j*`
`Boolean`	addToRootPom	Optional. Add to the root pom where root is the eldest parent of the pom within the source set.

String

groupId

The first part of a dependency coordinate 'org.apache.logging.log4j:ARTIFACT_ID:VERSION'.

org.apache.logging.log4j

String

artifactId

The second part of a dependency coordinate 'org.apache.logging.log4j:log4j-bom:VERSION'.

log4j-bom

String

version

An exact version number or node-style semver selector used to select the version number.

latest.release

String

scope

Optional. An optional scope to use for the dependency management tag. Valid options: import, runtime, provided, test

import

String

type

Optional. An optional type to use for the dependency management tag. Valid options: jar, pom, war

pom

String

classifier

Optional. An optional classifier to use for the dependency management tag

test

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 29.0-jre

-jre

Boolean

releasesOnly

Optional. Whether to exclude snapshots from consideration when using a semver selector

String

onlyIfUsing

Optional. Only add managed dependencies to projects having a dependency matching the expression.

org.apache.logging.log4j:log4j*

Boolean

addToRootPom

Optional. Add to the root pom where root is the eldest parent of the pom within the source set.

Data Tables

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column Name	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.

Column Name

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 Name	Description
Source path before the run	The source path of the file before the run.
Source path after the run	A recipe may modify the source path. This is the path after 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.

Column Name

Description

Source path before the run

The source path of the file before the run.

Source path after the run

A recipe may modify the source path. This is the path after 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 errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	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.

Column Name

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 Name	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	The total time spent across the scanning phase of this recipe.
99th percentile scanning time	99 out of 100 scans completed in this amount of time.
Max scanning time	The max time scanning any one source file.
Cumulative edit time	The total time spent across the editing phase of this recipe.
99th percentile edit time	99 out of 100 edits completed in this amount of time.
Max edit time	The max time editing any one source file.

Column Name

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

The total time spent across the scanning phase of this recipe.

99th percentile scanning time

99 out of 100 scans completed in this amount of time.

Max scanning time

The max time scanning any one source file.

Cumulative edit time

The total time spent across the editing phase of this recipe.

99th percentile edit time

99 out of 100 edits completed in this amount of time.

Max edit time

The max time editing any one source file.

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.UpgradeTransitiveDependencyVersionExample. 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.UpgradeTransitiveDependencyVersionExample
displayName: Upgrade transitive Maven dependencies example
recipeList:
  - org.openrewrite.maven.UpgradeTransitiveDependencyVersion:
      groupId: org.apache.logging.log4j
      artifactId: log4j-bom
      version: latest.release
      scope: import
      type: pom
      classifier: test
      versionPattern: '-jre'
      onlyIfUsing: org.apache.logging.log4j:log4j*

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

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.36.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.UpgradeTransitiveDependencyVersionExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to 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 UpgradeTransitiveDependencyVersionExample

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.

PreviousUpgrade Maven plugin version NextCleanup

Last updated 10 days ago