Skip to main content

Remove Maven plugin goal

org.openrewrite.maven.RemovePluginGoal

Removes a goal from a Maven plugin wherever it is declared: directly under a <plugin>, inside <executions>, and within <build>, <pluginManagement>, or <profiles>. If removing the goal leaves an <execution> with no remaining goals, the execution is removed. If all executions are removed, the <executions> element is also removed.

Recipe source​

GitHub: RemovePluginGoal.java, Issue Tracker, Code Genome Project

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringpluginGroupIdGroup ID of the plugin from which the goal will be removed. Supports glob. A Group ID is the first part of a plugin coordinate 'org.apache.maven.plugins:maven-compiler-plugin:VERSION'.org.apache.maven.plugins
StringpluginArtifactIdArtifact ID of the plugin from which the goal will be removed. Supports glob. The second part of a plugin coordinate 'org.apache.maven.plugins:maven-compiler-plugin:VERSION'.maven-compiler-plugin
StringgoalThe goal to remove. Matching is case-insensitive and supports glob.compile

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.RemovePluginGoalExample. 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.RemovePluginGoalExample
displayName: Remove Maven plugin goal example
recipeList:
  - org.openrewrite.maven.RemovePluginGoal:
      pluginGroupId: org.apache.maven.plugins
      pluginArtifactId: maven-compiler-plugin
      goal: compile

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

Now that com.yourorg.RemovePluginGoalExample has been defined, activate it in your build file:

OpenRewrite artifacts are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token, then in the snippets below replace USERNAME with the email or username you signed in with and TOKEN with that token. See the quickstart guide for details.

  1. Add the Code Genome Project credentials to your Maven settings.xml file (typically at ~/.m2/settings.xml):
    settings.xml
    <settings>
      <servers>
        <server>
          <id>codegenome</id>
          <username>USERNAME</username>
          <password>TOKEN</password>
        </server>
      </servers>
    </settings>
  2. Add the following to your pom.xml file:
    pom.xml
    <project>
      <repositories>
        <repository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </pluginRepository>
      </pluginRepositories>
      <build>
        <plugins>
          <plugin>
            <groupId>org.openrewrite.maven</groupId>
            <artifactId>rewrite-maven-plugin</artifactId>
            <version>6.45.0</version>
            <configuration>
              <exportDatatables>true</exportDatatables>
              <activeRecipes>
                <recipe>com.yourorg.RemovePluginGoalExample</recipe>
              </activeRecipes>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </project>
  3. 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.