Skip to main content

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringwrapperVersionOptional. An exact version number or node-style semver selector used to select the wrapper version number.3.x
StringwrapperDistributionOptional. 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. | |

Usage​

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

  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>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.maven.UpdateMavenWrapper</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.