Update Maven wrapper

org.openrewrite.maven.UpdateMavenWrapper

Update the version of Maven used in an existing Maven wrapper.

Recipe source

GitHub, Issue Tracker, Maven Central

groupId: org.openrewrite
artifactId: rewrite-maven
version: 8.30.0

Options

Type Name Description Example

Type	Name	Description	Example
`String`	wrapperVersion	Optional. An exact version number or node-style semver selector used to select the wrapper version number.	`3.x`
`String`	wrapperDistribution	Optional. The distribution of the Maven wrapper to use. * "bin" uses a `maven-wrapper.jar` compiled binary. * "only-script" uses a lite version of `mvnw`/`mvnw.cmd` using wget/curl or powershell. (required wrapper 3.2.0 or newer) * "script" downloads `maven-wrapper.jar` or `MavenWrapperDownloader.java` to then download a full distribution. * "source" uses `MavenWrapperDownloader.java` source file. Defaults to "bin". Valid options: `bin`, `only-script`, `script`, `source`
`String`	distributionVersion	Optional. An exact version number or node-style semver selector used to select the Maven version number.	`3.x`
`String`	repositoryUrl	Optional. The URL of the repository to download the Maven wrapper and distribution from. Supports repositories with a Maven layout. Defaults to `https://repo.maven.apache.org/maven2`.	`https://repo.maven.apache.org/maven2`
`Boolean`	addIfMissing	Optional. Add a Maven wrapper, if it's missing. Defaults to `true`.
`Boolean`	enforceWrapperChecksumVerification	Optional. Enforce checksum verification for the maven-wrapper.jar. Enabling this feature may sporadically result in build failures, such as MWRAPPER-103. Defaults to `false`.

String

wrapperVersion

Optional. An exact version number or node-style semver selector used to select the wrapper version number.

3.x

String

wrapperDistribution

Optional. The distribution of the Maven wrapper to use. * "bin" uses a maven-wrapper.jar compiled binary. * "only-script" uses a lite version of mvnw/mvnw.cmd using wget/curl or powershell. (required wrapper 3.2.0 or newer) * "script" downloads maven-wrapper.jar or MavenWrapperDownloader.java to then download a full distribution. * "source" uses MavenWrapperDownloader.java source file. Defaults to "bin". Valid options: bin, only-script, script, source

String

distributionVersion

Optional. An exact version number or node-style semver selector used to select the Maven version number.

3.x

String

repositoryUrl

Optional. The URL of the repository to download the Maven wrapper and distribution from. Supports repositories with a Maven layout. Defaults to https://repo.maven.apache.org/maven2.

https://repo.maven.apache.org/maven2

Boolean

addIfMissing

Optional. Add a Maven wrapper, if it's missing. Defaults to true.

Boolean

enforceWrapperChecksumVerification

Optional. Enforce checksum verification for the maven-wrapper.jar. Enabling this feature may sporadically result in build failures, such as MWRAPPER-103. Defaults to false.

Data Tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run.
Source path after the run	A recipe may modify the source path. This is the path after the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Column Name

Description

Source path before the run

The source path of the file before the run.

Source path after the run

A recipe may modify the source path. This is the path after the run.

Parent of the recipe that made changes

In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.

Recipe that made changes

The specific recipe that made a change.

Estimated time saving

An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.

Cycle

The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Column Name

Description

Source path

The file that failed to parse.

Recipe that made changes

The specific recipe that made a change.

Stack trace

The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time	The total time spent across the scanning phase of this recipe.
99th percentile scanning time	99 out of 100 scans completed in this amount of time.
Max scanning time	The max time scanning any one source file.
Cumulative edit time	The total time spent across the editing phase of this recipe.
99th percentile edit time	99 out of 100 edits completed in this amount of time.
Max edit time	The max time editing any one source file.

Column Name

Description

The recipe

The recipe whose stats are being measured both individually and cumulatively.

Source file count

The number of source files the recipe ran over.

Source file changed count

The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.

Cumulative scanning time

The total time spent across the scanning phase of this recipe.

99th percentile scanning time

99 out of 100 scans completed in this amount of time.

Max scanning time

The max time scanning any one source file.

Cumulative edit time

The total time spent across the editing phase of this recipe.

99th percentile edit time

99 out of 100 edits completed in this amount of time.

Max edit time

The max time editing any one source file.

Usage

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

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.36.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.maven.UpdateMavenWrapper</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to run the recipe.

You will need to have Maven installed on your machine before you can run the following command.

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.activeRecipes=org.openrewrite.maven.UpdateMavenWrapper -Drewrite.exportDatatables=true

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

shell

mod run . --recipe UpdateMavenWrapper

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.

PreviousSet Maven project packaging NextUpgrade Maven dependency version

Last updated 10 days ago