wrapper:wrapper

Full name:

org.apache.maven.plugins:maven-wrapper-plugin:3.3.2:wrapper

Description:

Unpacks the maven-wrapper distribution files to the current project source tree.

Attributes:

  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 3.0.0.

Optional Parameters

Name Type Since Description
<alwaysDownload> boolean 3.2.0 Determines if the Maven distribution should be downloaded on every execution of the Maven wrapper.
Default: false
User Property: alwaysDownload
<alwaysUnpack> boolean 3.2.0 Determines if the Maven distribution should be unpacked on every execution of the Maven wrapper.
Default: false
User Property: alwaysUnpack
<distributionSha256Sum> String 3.2.0 The expected SHA-256 checksum of the Maven distribution that is executed by the installed wrapper.
User Property: distributionSha256Sum
<distributionType> String 3.0.0 The Maven Wrapper distribution type.

Options are:

script
only mvnw scripts
bin
precompiled and packaged code
source
Java source code, will be compiled on the fly
only-script (default)
the new lite implementation of mvnw/mvnw.cmd scripts downloads the maven directly and skips maven-wrapper.jar - since 3.2.0
If -Dtype={type} is not explicitly provided, then distributionType from .mvn/wrapper/maven-wrapper.properties is used, if it exists. Otherwise, only-script is used as the default distribution type.

This value will be used as the classifier of the downloaded file.


User Property: type
<includeDebugScript> boolean 3.0.0 Include mvnwDebug* scripts?
Default: false
User Property: includeDebug
<mavenVersion> String 3.0.0 The version of Maven to require, default value is the Runtime version of Maven. Can be any valid release above 2.0.9
User Property: maven
<mvndVersion> String 3.2.0 The version of Maven Daemon to require.
User Property: mvnd
<wrapperSha256Sum> String 3.2.0 The expected SHA-256 checksum of the maven-wrapper.jar that is used to load the configured Maven distribution.
User Property: wrapperSha256Sum

Parameter Details

<alwaysDownload>

Determines if the Maven distribution should be downloaded on every execution of the Maven wrapper.
  • Type: boolean
  • Since: 3.2.0
  • Required: No
  • User Property: alwaysDownload
  • Default: false

<alwaysUnpack>

Determines if the Maven distribution should be unpacked on every execution of the Maven wrapper.
  • Type: boolean
  • Since: 3.2.0
  • Required: No
  • User Property: alwaysUnpack
  • Default: false

<distributionSha256Sum>

The expected SHA-256 checksum of the Maven distribution that is executed by the installed wrapper.
  • Type: java.lang.String
  • Since: 3.2.0
  • Required: No
  • User Property: distributionSha256Sum

<distributionType>

The Maven Wrapper distribution type.

Options are:

script
only mvnw scripts
bin
precompiled and packaged code
source
Java source code, will be compiled on the fly
only-script (default)
the new lite implementation of mvnw/mvnw.cmd scripts downloads the maven directly and skips maven-wrapper.jar - since 3.2.0
If -Dtype={type} is not explicitly provided, then distributionType from .mvn/wrapper/maven-wrapper.properties is used, if it exists. Otherwise, only-script is used as the default distribution type.

This value will be used as the classifier of the downloaded file.

  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • User Property: type

<includeDebugScript>

Include mvnwDebug* scripts?
  • Type: boolean
  • Since: 3.0.0
  • Required: No
  • User Property: includeDebug
  • Default: false

<mavenVersion>

The version of Maven to require, default value is the Runtime version of Maven. Can be any valid release above 2.0.9
  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • User Property: maven

<mvndVersion>

The version of Maven Daemon to require.
  • Type: java.lang.String
  • Since: 3.2.0
  • Required: No
  • User Property: mvnd

<wrapperSha256Sum>

The expected SHA-256 checksum of the maven-wrapper.jar that is used to load the configured Maven distribution.
  • Type: java.lang.String
  • Since: 3.2.0
  • Required: No
  • User Property: wrapperSha256Sum