addprofile.md

Add Maven profile

org.openrewrite.maven.AddProfile

Add a maven profile to a pom.xml file.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-maven
• version: 8.1.3

Options

Type	Name	Description
String	id	The profile id.
String	activation	Optional. activation details of a maven profile, provided as raw XML.
String	properties	Optional. properties of a maven profile, provided as raw XML.
String	build	Optional. build details of a maven profile, provided as raw XML.

Example

Parameters

Parameter	Value
id	myprofile
activation	<activation><foo>foo</foo></activation>
properties	<properties><bar>bar</bar></properties>
build	<build><param>value</param></build>

{% tabs %} {% tab title="pom.xml" %}

Before

{% code title="pom.xml" %}

<project>
  <groupId>group</groupId>
  <artifactId>artifact</artifactId>
  <version>1</version>
</project>

{% endcode %}

After

{% code title="pom.xml" %}

<project>
  <groupId>group</groupId>
  <artifactId>artifact</artifactId>
  <version>1</version>
  <profiles>
    <profile>
      <id>myprofile</id>
      <activation>
        <foo>foo</foo>
      </activation>
      <properties>
        <bar>bar</bar>
      </properties>
      <build>
        <param>value</param>
      </build>
    </profile>
  </profiles>
</project>

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- pom.xml
+++ pom.xml
@@ -5,0 +5,14 @@
  <artifactId>artifact</artifactId>
  <version>1</version>
+ <profiles>
+   <profile>
+     <id>myprofile</id>
+     <activation>
+       <foo>foo</foo>
+     </activation>
+     <properties>
+       <bar>bar</bar>
+     </properties>
+     <build>
+       <param>value</param>
+     </build>
+   </profile>
+ </profiles>
</project>

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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>

{% endcode %}

Now that com.yourorg.AddProfileExample has been defined activate it in your build file: {% tabs %}

{% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddProfileExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Mark Brophy

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.