Comment on page

Set Maven project packaging

org.openrewrite.maven.ChangePackaging
Sets the packaging type of Maven projects. Either adds the packaging tag if it is missing or changes its context if present.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.9.5
Options
Type
Name
Description
String
groupId
The groupId of the project whose packaging should be changed. Accepts glob patterns.
String
artifactId
The artifactId of the project whose packaging should be changed. Accepts glob patterns.
String
packaging
The type of packaging to set. If null specified the packaging tag will be removed
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.ChangePackagingExample. 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.ChangePackagingExample
displayName: Set Maven project packaging example
recipeList:
  - org.openrewrite.maven.ChangePackaging:
      groupId: org.openrewrite.*
      artifactId: rewrite-*
      packaging: jar
Now that com.yourorg.ChangePackagingExample has been defined activate it in your build file:
Maven
Moderne CLI
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePackagingExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangePackaging
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.
Contributors
​Sam Snyder, Jonathan Schnéider, Adriano Machado

Type	Name	Description
`String`	groupId	The groupId of the project whose packaging should be changed. Accepts glob patterns.
`String`	artifactId	The artifactId of the project whose packaging should be changed. Accepts glob patterns.
`String`	packaging	The type of packaging to set. If `null` specified the packaging tag will be removed

Rename Maven property key

Update Maven wrapper

Last modified 10d ago