Design Partners
Add Maven plugin
** org.openrewrite.maven.AddPlugin** Add the specified Maven plugin to the pom.xml.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 7.22.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
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.

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.AddPluginExample
4
displayName: Add Maven plugin example
5
recipeList:
6
- org.openrewrite.maven.AddPlugin:
7
groupId: org.openrewrite.maven
8
artifactId: rewrite-maven-plugin
9
version: 1.0.0
10
configuration: <configuration><foo>foo</foo></configuration>
11
dependencies: <dependencies><dependency><groupId>com.yourorg</groupId><artifactId>core-lib</artifactId><version>1.0.0</version></dependency></dependencies>
12
executions: <execution><phase>generate-sources</phase><goals><goal>add-source</goal></goals></execution>
Copied!
Now that com.yourorg.AddPluginExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddPluginExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddPluginExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.AddPluginExample
Export as PDF
Copy link