Comment on page

Add Maven plugin dependencies

org.openrewrite.maven.AddPluginDependency
Adds the specified dependencies to a Maven plugin. Will not add the plugin if it does not already exist in the pom.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.9.5
Options
Type
Name
Description
String
pluginGroupId
GroupId of the plugin to which the dependency will be added. A GroupId is the first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String
pluginArtifactId
ArtifactId of the plugin to which the dependency will be added.The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String
groupId
The GroupId of the dependency to add.
String
artifactId
The ArtifactId of the dependency to add.
String
version
The Version of the dependency to add.
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.AddPluginDependencyExample. 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.AddPluginDependencyExample
displayName: Add Maven plugin dependencies example
recipeList:
  - org.openrewrite.maven.AddPluginDependency:
      pluginGroupId: org.openrewrite.maven
      pluginArtifactId: rewrite-maven-plugin
      groupId: org.openrewrite.recipe
      artifactId: org.openrewrite.recipe
      version: org.openrewrite.recipe
Now that com.yourorg.AddPluginDependencyExample has been defined activate it in your build file:
Maven
Moderne CLI
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddPluginDependencyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
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 AddPluginDependency
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.
Contributors
​Sam Snyder, Jonathan Schnéider​

Type	Name	Description
`String`	pluginGroupId	GroupId of the plugin to which the dependency will be added. A GroupId is the first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
`String`	pluginArtifactId	ArtifactId of the plugin to which the dependency will be added.The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
`String`	groupId	The GroupId of the dependency to add.
`String`	artifactId	The ArtifactId of the dependency to add.
`String`	version	The Version of the dependency to add.

Add Maven plugin

Add Maven profile

Last modified 12d ago