Skip to main content

Add Maven plugin

org.openrewrite.maven.AddPlugin

Add the specified Maven plugin to the pom.xml.

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.openrewrite.maven:rewrite-maven-plugin:VERSION'.org.openrewrite.maven
StringartifactIdThe second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.rewrite-maven-plugin
StringversionOptional. A fixed version of the plugin to add.1.0.0
StringconfigurationOptional. Optional plugin configuration provided as raw XML<configuration><foo>foo</foo></configuration>
StringdependenciesOptional. Optional plugin dependencies provided as raw XML.<dependencies><dependency><groupId>com.yourorg</groupId><artifactId>core-lib</artifactId><version>1.0.0</version></dependency></dependencies>
StringexecutionsOptional. Optional executions provided as raw XML.<executions><execution><phase>generate-sources</phase><goals><goal>add-source</goal></goals></execution></executions>
StringfilePatternOptional. A glob expression that can be used to constrain which directories or source files should be searched. Multiple patterns may be specified, separated by a semicolon ;. If multiple patterns are supplied any of the patterns matching will be interpreted as a match. When not set, all source files are searched.**/*-parent/grpc-*/pom.xml

Example​

Parameters​
ParameterValue
groupIdorg.openrewrite.maven
artifactIdrewrite-maven-plugin
version100.0
configuration<configuration><activeRecipes><recipe>io.moderne.FindTest</recipe></activeRecipes></configuration>
dependenciesnull
executionsnull
filePatternnull
Before​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>
After​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>100.0</version>
        <configuration>
          <activeRecipes>
            <recipe>io.moderne.FindTest</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</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.AddPluginExample. 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.AddPluginExample
displayName: Add Maven plugin example
recipeList:
  - org.openrewrite.maven.AddPlugin:
      groupId: org.openrewrite.maven
      artifactId: rewrite-maven-plugin
      version: 1.0.0
      configuration: <configuration><foo>foo</foo></configuration>
      dependencies: <dependencies><dependency><groupId>com.yourorg</groupId><artifactId>core-lib</artifactId><version>1.0.0</version></dependency></dependencies>
      executions: <executions><execution><phase>generate-sources</phase><goals><goal>add-source</goal></goals></execution></executions>
      filePattern: '**/*-parent/grpc-*/pom.xml'

Now that com.yourorg.AddPluginExample 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.AddPluginExample</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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Jonathan Schneider, Sam Snyder, Daniel Wallman, Greg Adams, Laurens Westerlaken, Alex Boyko, traceyyoshima, Tyler Van Gorder, Aaron Gershman, Tim te Beek, Adriano Machado, Henrik S