Comment on page

Change Maven Project Version

org.openrewrite.maven.ChangeProjectVersion
Change the project version of a Maven pom.xml. Identifies the project to be changed by its groupId and artifactId. If the version is defined as a property, this recipe will only change the property value if the property exists within the same pom.
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 maven project to change its version. This can be a glob expression.
String
artifactId
The artifactId of the maven project to change its version. This can be a glob expression.
String
newVersion
The new version to replace the maven project version.
Boolean
overrideParentVersion
Optional. This flag can be set to explicitly override the inherited parent version. Default false.
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.ChangeProjectVersionExample. 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.ChangeProjectVersionExample
displayName: Change Maven Project Version example
recipeList:
  - org.openrewrite.maven.ChangeProjectVersion:
      groupId: org.openrewrite
      artifactId: '*'
      newVersion: 8.4.2
      overrideParentVersion: null
Now that com.yourorg.ChangeProjectVersionExample 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.ChangeProjectVersionExample</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 ChangeProjectVersion
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
​Joan Viladrosa, Sam Snyder​

Type	Name	Description
`String`	groupId	The groupId of the maven project to change its version. This can be a glob expression.
`String`	artifactId	The artifactId of the maven project to change its version. This can be a glob expression.
`String`	newVersion	The new version to replace the maven project version.
`Boolean`	overrideParentVersion	Optional. This flag can be set to explicitly override the inherited parent version. Default `false`.

Apache Maven best practices

Change Maven dependency classifier

Last modified 12d ago