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.6.0
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
Optional. 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.
String
filePattern
Optional. 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.
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:
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>
      filePattern: '**/*-parent/grpc-*/pom.xml'
Now that com.yourorg.AddPluginExample 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.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddPluginExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Jonathan Schneider​
​Sam Snyder​
​Daniel Wallman​
​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.

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	Optional. 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.
`String`	filePattern	Optional. 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.

Add Maven dependency

Add Maven plugin dependencies

Last modified 6d ago