addplugin.md

Add Maven plugin

org.openrewrite.maven.AddPlugin

Add the specified Maven plugin to the pom.xml.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	groupId	The first part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String	artifactId	The second part of a dependency coordinate 'org.openrewrite.maven:rewrite-maven-plugin:VERSION'.
String	version	A fixed version of the plugin to add.
String	configuration	Optional. Optional plugin configuration provided as raw XML
String	dependencies	Optional. Optional plugin dependencies provided as raw XML.
String	executions	Optional. Optional executions provided as raw XML.

Example

Parameters

Parameter	Value
groupId	org.openrewrite.maven
artifactId	rewrite-maven-plugin
version	100.0
configuration	`

io.moderne.FindTest `| |dependencies|`null`| |executions|`null`|

{% tabs %} {% tab title="pom.xml" %}

Before

{% code title="pom.xml" %}

<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

{% endcode %}

After

{% code title="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>

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- pom.xml
+++ pom.xml
@@ -5,0 +5,14 @@
  <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>

{% endcode %} {% endtab %} {% endtabs %}

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.AddPluginExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="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: <execution><phase>generate-sources</phase><goals><goal>add-source</goal></goals></execution>

{% endcode %}

Now that com.yourorg.AddPluginExample has been defined activate it in your build file: {% tabs %}

{% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddPluginExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Sam Snyder
• Greg Adams
• Alex Boyko
• Tyler Van Gorder
• traceyyoshima
• Aaron Gershman

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.