Add Maven profile

org.openrewrite.maven.AddProfile

Add a maven profile to a pom.xml file.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-maven

• version: 8.24.0

Options

Type	Name	Description	Example
String	id	The profile id.	default
String	activation	Optional. activation details of a maven profile, provided as raw XML.	<activation><foo>foo</foo></activation>
String	properties	Optional. properties of a maven profile, provided as raw XML.	<properties><foo>foo</foo><bar>bar</bar></properties>
String	build	Optional. build details of a maven profile, provided as raw XML.	<build><foo>foo</foo></build>

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.AddProfileExample. 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.AddProfileExample
displayName: Add Maven profile example
recipeList:
  - org.openrewrite.maven.AddProfile:
      id: default
      activation: <activation><foo>foo</foo></activation>
      properties: <properties><foo>foo</foo><bar>bar</bar></properties>
      build: <build><foo>foo</foo></build>

Now that com.yourorg.AddProfileExample 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.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddProfileExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe AddProfileExample

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

Mark Brophy, Jonathan Schnéider, Tim te Beek