Upgrade transitive Gradle or Maven dependencies
org.openrewrite.java.dependencies.UpgradeTransitiveDependencyVersion
Upgrades the version of a transitive dependency in a Maven pom.xml or Gradle build.gradle. 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.recipe
artifactId: rewrite-java-dependencies
version: 1.7.0
Options
Type | Name | Description | Example |
---|---|---|---|
| groupId | The first part of a dependency coordinate 'org.apache.logging.log4j:ARTIFACT_ID:VERSION'. |
|
| artifactId | The second part of a dependency coordinate 'org.apache.logging.log4j:log4j-bom:VERSION'. |
|
| version | An exact version number or node-style semver selector used to select the version number. |
|
| scope | Optional. An optional scope to use for the dependency management tag. Relevant only to Maven. Valid options: |
|
| type | Optional. An optional type to use for the dependency management tag. Relevant only to Maven builds. Valid options: |
|
| classifier | Optional. An optional classifier to use for the dependency management tag. Relevant only to Maven. |
|
| 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 |
|
| releasesOnly | Optional. Whether to exclude snapshots from consideration when using a semver selector | |
| onlyIfUsing | Optional. Only add managed dependencies to projects having a dependency matching the expression. |
|
| addToRootPom | Optional. Add to the root pom where root is the eldest parent of the pom within the source set. |
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:
Now that com.yourorg.UpgradeTransitiveDependencyVersionExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.7.0 in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
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.
Last updated