Skip to main content

Add managed Maven dependency

org.openrewrite.maven.AddManagedDependency

Add a managed Maven dependency to a pom.xml file.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdThe first part of a dependency coordinate 'org.apache.logging.log4j:ARTIFACT_ID:VERSION'.org.apache.logging.log4j
StringartifactIdThe second part of a dependency coordinate 'org.apache.logging.log4j:log4j-bom:VERSION'.log4j-bom
StringversionAn exact version number or node-style semver selector used to select the version number.latest.release
StringscopeOptional. An optional scope to use for the dependency management tag. Valid options: import, runtime, provided, testimport
StringtypeOptional. An optional type to use for the dependency management tag. Valid options: jar, pom, warpom
StringclassifierOptional. An optional classifier to use for the dependency management tagtest
StringversionPatternOptional. 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
BooleanreleasesOnlyOptional. Whether to exclude snapshots from consideration when using a semver selector
StringonlyIfUsingOptional. Only add managed dependencies to projects having a dependency matching the expression.org.apache.logging.log4j:log4j*
BooleanaddToRootPomOptional. Add to the root pom where root is the eldest parent of the pom within the source set.

Examples​

Example 1​
Parameters​
ParameterValue
groupIdorg.apache.logging.log4j
artifactIdlog4j-bom
version2.17.2
scopeimport
typepom
classifiernull
versionPatternnull
releasesOnlynull
onlyIfUsingorg.apache.logging.log4j:*
addToRootPomfalse
Before​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.17.2</version>
    </dependency>
  </dependencies>
</project>
After​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-bom</artifactId>
        <version>2.17.2</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.17.2</version>
    </dependency>
  </dependencies>
</project>
Example 2​
Parameters​
ParameterValue
groupId${quarkus.platform.group-id}
artifactId${quarkus.platform.artifact-id}
version${quarkus.platform.version}
scopeimport
typepom
classifiernull
versionPatternnull
releasesOnlynull
onlyIfUsingnull
addToRootPomnull
Before​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>core</artifactId>
  <version>1</version>
  <properties>
    <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
    <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
    <quarkus.platform.version>3.2.3.Final</quarkus.platform.version>
  </properties>
</project>
After​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>core</artifactId>
  <version>1</version>
  <properties>
    <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
    <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
    <quarkus.platform.version>3.2.3.Final</quarkus.platform.version>
  </properties>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>${quarkus.platform.artifact-id}</artifactId>
        <version>${quarkus.platform.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
</project>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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:

  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>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.AddManagedDependencyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Maven metadata failures​

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column NameDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.