Comment on page

Add Maven project property

org.openrewrite.maven.AddProperty
Add a new property to the Maven project property.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.9.5
Options
Type
Name
Description
String
key
The name of the property key to be added.
String
value
The value of property to be added.
Boolean
preserveExistingValue
Optional. Preserve previous value if the property already exists in the pom file.
Boolean
trustParent
Optional. Even if the parent defines a property with the same key, trust it even if the value isn't the same. Useful when you want to wait for the parent to have its value changed first. The parent is not trusted by default.
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.AddPropertyExample. 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.AddPropertyExample
displayName: Add Maven project property example
recipeList:
  - org.openrewrite.maven.AddProperty:
      key: junit.version
      value: 4.13
      preserveExistingValue: null
      trustParent: null
Now that com.yourorg.AddPropertyExample 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.AddPropertyExample</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 AddProperty
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
​Aurélien Mino, Jonathan Schneider​

Type	Name	Description
`String`	key	The name of the property key to be added.
`String`	value	The value of property to be added.
`Boolean`	preserveExistingValue	Optional. Preserve previous value if the property already exists in the pom file.
`Boolean`	trustParent	Optional. Even if the parent defines a property with the same key, trust it even if the value isn't the same. Useful when you want to wait for the parent to have its value changed first. The parent is not trusted by default.

Add Maven profile

Add Repository

Last modified 12d ago