Links

Add managed Maven dependency

org.openrewrite.maven.AddManagedDependency
Add a managed Maven dependency to a pom.xml file.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 8.17.1

Options

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.

Data Tables (Only available on the Moderne platform)

Maven metadata failures

Attempts to resolve maven metadata that failed.

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.AddManagedDependencyExample. 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.AddManagedDependencyExample
displayName: Add managed Maven dependency example
recipeList:
- org.openrewrite.maven.AddManagedDependency:
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.AddManagedDependencyExample has been defined activate it in your build file:
Maven
Moderne CLI
  1. 1.
    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.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddManagedDependencyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    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 AddManagedDependencyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.