Open source

Change Maven Project Version

Recipe IDorg.openrewrite.maven.ChangeProjectVersionArtifactorg.openrewrite:rewrite-maven

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.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.maven.ChangeProjectVersion")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-maven:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.maven.ChangeProjectVersion --recipe-option "groupId=org.openrewrite" --recipe-option "artifactId=*" --recipe-option "newVersion=8.4.2"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-maven:RELEASE

Options

Name	Type	Description
`groupId`required	`String`	The group ID of the maven project to change its version. This can be a glob expression. e.g. `org.openrewrite`
`artifactId`required	`String`	The artifact ID of the maven project to change its version. This can be a glob expression. e.g. `*`
`newVersion`required	`String`	The new version to replace the maven project version. e.g. `8.4.2`
`overrideParentVersion`	`Boolean`	This flag can be set to explicitly override the inherited parent version. Default `false`.

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats