Change Maven plugin dependencies

org.openrewrite.maven.ChangePluginDependencies

Applies 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.24.0

Options

Type	Name	Description	Example
String	groupId	The first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.	org.openrewrite.maven
String	artifactId	The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.	rewrite-maven-plugin
String	dependencies	Optional. Plugin dependencies provided as dependency coordinates of format "groupId:artifactId:version". When supplying multiple coordinates separate them with ",". Supplying null will remove any existing plugin dependencies.	org.openrewrite.recipe:rewrite-spring:1.0.0, org.openrewrite.recipe:rewrite-testing-frameworks:1.0.0

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.ChangePluginDependenciesExample. 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.ChangePluginDependenciesExample
displayName: Change Maven plugin dependencies example
recipeList:
  - org.openrewrite.maven.ChangePluginDependencies:
      groupId: org.openrewrite.maven
      artifactId: rewrite-maven-plugin
      dependencies: org.openrewrite.recipe:rewrite-spring:1.0.0, org.openrewrite.recipe:rewrite-testing-frameworks:1.0.0

Now that com.yourorg.ChangePluginDependenciesExample has been defined activate it in your build file:

Maven

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.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePluginDependenciesExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangePluginDependenciesExample

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, Tim te Beek