Design Partners
Add Managed Maven Dependency
** org.openrewrite.maven.AddManagedDependency** Add a managed maven dependency to a pom.xml file.

Source

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

Options

Type
Name
Description
String
groupId
The first part of a dependency coordinate 'org.apache.logging.log4j:ARTIFACT_ID:VERSION'.
String
artifactId
The second part of a dependency coordinate 'org.apache.logging.log4j:log4j-bom:VERSION'.
String
version
An exact version number or node-style semver selector used to select the version number.
String
scope
Optional. An optional scope to use for the dependency management tag.
String
type
Optional. An optional type to use for the dependency management tag.
String
classifier
Optional. An optional classifier to use for the dependency management tag
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
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.
Boolean
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.AddManagedDependencyExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.AddManagedDependencyExample
4
displayName: Add Managed Maven Dependency example
5
recipeList:
6
- org.openrewrite.maven.AddManagedDependency:
7
groupId: org.apache.logging.log4j
8
artifactId: log4j-bom
9
version: latest.release
10
scope: import
11
type: pom
12
classifier: test
13
versionPattern: '-jre'
14
releasesOnly: true
15
onlyIfUsing: org.apache.logging.log4j:log4j*
16
addToRootPom: true
Copied!
Now that com.yourorg.AddManagedDependencyExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddManagedDependencyExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.25.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddManagedDependencyExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.AddManagedDependencyExample
Export as PDF
Copy link