Links

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.38.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
---
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>
Now that com.yourorg.AddPluginExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.38.0")
}
rewrite {
activeRecipe("com.yourorg.AddPluginExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.42.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddPluginExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.