Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

formatting, added update via plugin

This commit is contained in:
Manfred Moser 2017-04-24 12:14:09 -07:00 committed by rfscholte
parent ae4dda4c16
commit 274ffb663e
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
maven-wrapper/README.md
View File

@ -1,8 +1,12 @@
# Maven Wrapper # Maven Wrapper
The Maven Wrapper is an easy way to ensure a user of your Maven build has everything necessary to run your Maven build. Why might this be necessary? Maven to date has been very stable for users, is available on most systems or is easy to procure: but with many of the recent changes in Maven it will be easier for users to have a fully encapsulated build setup provided by the project. With the Maven Wrapper this is very easy to do and it's a great idea borrowed from Gradle. The Maven Wrapper is an easy way to ensure a user of your Maven build has everything necessary to run your Maven build.
Why might this be necessary? Maven to date has been very stable for users, is available on most systems or is easy to
procure: but with many of the recent changes in Maven it will be easier for users to have a fully encapsulated build
setup provided by the project. With the Maven Wrapper this is very easy to do and it's a great idea borrowed from Gradle.
The easiest way to setup the Maven Wrapper for your project is to use the [Takari Maven Plugin][1] with its provided `wrapper` goal. To add all the necessary Maven Wrapper files to your project execute the following command: The easiest way to setup the Maven Wrapper for your project is to use the [Takari Maven Plugin][1] with its provided
`wrapper` goal. To add or update all the necessary Maven Wrapper files to your project execute the following command:
``` ```
mvn -N io.takari:maven:wrapper mvn -N io.takari:maven:wrapper
@ -26,7 +30,8 @@ or
$ ./mvnw.cmd clean install $ ./mvnw.cmd clean install
``` ```
A normal Maven build will be executed with the one important change that if the user doesn't have the necessary version of Maven specified in `.mvn/wrapper/maven-wrapper.properties` it will be downloaded for the user first. A normal Maven build will be executed with the one important change that if the user doesn't have the necessary version
of Maven specified in `.mvn/wrapper/maven-wrapper.properties` it will be downloaded for the user first.
## Supported Systems ## Supported Systems
@ -63,7 +68,8 @@ To switch the version of Maven used to build a project you can initialize it usi
mvn -N io.takari:maven:wrapper -Dmaven=3.3.3 mvn -N io.takari:maven:wrapper -Dmaven=3.3.3
``` ```
which works for any version except snapshots. Once you have a wrapper you can change its version by setting the `distributionUrl` in `.mvn/wrapper/maven-wrapper.properties`, e.g. which works for any version except snapshots. Once you have a wrapper you can change its version by setting the
`distributionUrl` in `.mvn/wrapper/maven-wrapper.properties`, e.g.
``` ```
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.2.1/apache-maven-3.2.1-bin.zip distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.2.1/apache-maven-3.2.1-bin.zip