From cb7df3a9d5c0cad1a4ec015fc9cf092e1fce7313 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Boutemy?= Date: Sun, 7 Nov 2021 21:01:46 +0100 Subject: [PATCH] [MWRAPPER-14] update documentation --- .../src/site/apt/index.apt.vm | 2 +- maven-wrapper-distribution/src/site/site.xml | 3 -- .../src/site/markdown/index.md.vm | 5 +-- .../src/site/markdown/usage.md | 4 +- maven-wrapper-plugin/src/site/site.xml | 10 +---- maven-wrapper/src/site/apt/index.apt | 4 +- maven-wrapper/src/site/site.xml | 2 - pom.xml | 22 +--------- src/site/apt/index.apt | 35 ++++++++++++++++ .../src => src}/site/resources/download.cgi | 0 src/site/site.xml | 42 +++++++++++++++++++ .../src => src}/site/xdoc/download.xml.vm | 10 ++--- 12 files changed, 92 insertions(+), 47 deletions(-) create mode 100644 src/site/apt/index.apt rename {maven-wrapper-plugin/src => src}/site/resources/download.cgi (100%) create mode 100644 src/site/site.xml rename {maven-wrapper-plugin/src => src}/site/xdoc/download.xml.vm (85%) diff --git a/maven-wrapper-distribution/src/site/apt/index.apt.vm b/maven-wrapper-distribution/src/site/apt/index.apt.vm index a8ecdc9..7592f68 100644 --- a/maven-wrapper-distribution/src/site/apt/index.apt.vm +++ b/maven-wrapper-distribution/src/site/apt/index.apt.vm @@ -55,4 +55,4 @@ mvnwDebug.cmd [] - Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{/plugins/maven-wrapper-plugin/}<<>>}}. + Distribution can be installed in a project either by unpacking zip archive by hand, or by using {{{../maven-wrapper-plugin/}<<>>}}. diff --git a/maven-wrapper-distribution/src/site/site.xml b/maven-wrapper-distribution/src/site/site.xml index cd7807c..7673a9a 100644 --- a/maven-wrapper-distribution/src/site/site.xml +++ b/maven-wrapper-distribution/src/site/site.xml @@ -21,9 +21,6 @@ under the License. - - ${project.scm.url} - diff --git a/maven-wrapper-plugin/src/site/markdown/index.md.vm b/maven-wrapper-plugin/src/site/markdown/index.md.vm index 29bcac0..8746af6 100644 --- a/maven-wrapper-plugin/src/site/markdown/index.md.vm +++ b/maven-wrapper-plugin/src/site/markdown/index.md.vm @@ -18,15 +18,14 @@ specific language governing permissions and limitations under the License. --> -The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](/ref/4-LATEST/apache-maven-wrapper/) -as introduced in Apache Maven 4. +The Apache Maven Wrapper Plugin helps with downloading and unpacking the [wrapper distribution](../maven-wrapper-distribution/). Goals Overview -------------- * [wrapper:wrapper](./wrapper-mojo.html) is the default goal invoked during the - `wrapper` phase. It downloads and unpacks the apache-maven-wrapper distribution, + `wrapper` phase. It downloads and unpacks the maven-wrapper distribution, Usage ----- diff --git a/maven-wrapper-plugin/src/site/markdown/usage.md b/maven-wrapper-plugin/src/site/markdown/usage.md index 3c147fa..e7b8671 100644 --- a/maven-wrapper-plugin/src/site/markdown/usage.md +++ b/maven-wrapper-plugin/src/site/markdown/usage.md @@ -48,7 +48,7 @@ This type comes with a `.mvn/wrapper/MavenWrapperDownloader.java` which will be Maven Version ------------- By default the plugin will assume the same version as the Maven runtime (calling `mvn -v`). But you can pick a different version. -Either call `mvn wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven +Either call `mvn wrapper:wrapper -DmavenVersion=x`, where x is any valid Apache Maven Release, see https://search.maven.org/artifact/org.apache.maven/apache-maven Another option is adjust the `distributionUrl` in `.mvn/wrapper/maven-wrapper.properties` Debugging @@ -56,4 +56,4 @@ Debugging The apache-maven-wrapper distributions all contains the `mvnwDebug`-script for both Windows and Unix based operating systems. This makes it possible to debug through Apache Maven, Maven Plugin or Maven Extension. -You can exclude these scripts by calling `mvn wrapper -DincludeDebug=false` \ No newline at end of file +You can exclude these scripts by calling `mvn wrapper:wrapper -DincludeDebug=false` \ No newline at end of file diff --git a/maven-wrapper-plugin/src/site/site.xml b/maven-wrapper-plugin/src/site/site.xml index 3b846b6..9678ca4 100644 --- a/maven-wrapper-plugin/src/site/site.xml +++ b/maven-wrapper-plugin/src/site/site.xml @@ -27,14 +27,8 @@ under the License. - - - - - - - - + + diff --git a/maven-wrapper/src/site/apt/index.apt b/maven-wrapper/src/site/apt/index.apt index c579786..5e449c5 100644 --- a/maven-wrapper/src/site/apt/index.apt +++ b/maven-wrapper/src/site/apt/index.apt @@ -25,6 +25,6 @@ Maven Wrapper - Maven Wrapper dowloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default. + Maven Wrapper downloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default. - Maven Wrapper is called by {{{../apache-maven-wrapper/}<<>>/<<>> scripts}} that need to be installed in the project source tree and called instead of <<>>/<<>>. + Maven Wrapper is called by {{{../maven-wrapper-distribution/}<<>>/<<>> scripts}} that need to be installed in the project source tree and called instead of <<>>/<<>>. diff --git a/maven-wrapper/src/site/site.xml b/maven-wrapper/src/site/site.xml index e475330..1c1c7d8 100644 --- a/maven-wrapper/src/site/site.xml +++ b/maven-wrapper/src/site/site.xml @@ -22,8 +22,6 @@ under the License. - ${project.scm.url} - diff --git a/pom.xml b/pom.xml index ce73810..4c972be 100644 --- a/pom.xml +++ b/pom.xml @@ -40,10 +40,6 @@ under the License. 2020 - - ${mavenVersion} - - scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git scm:git:https://gitbox.apache.org/repos/asf/maven-wrapper-plugin.git @@ -66,6 +62,7 @@ under the License. + wrapper-archives/wrapper-LATEST 3.1.0 8 2021-04-05T14:15:37Z @@ -76,21 +73,4 @@ under the License. maven-wrapper-distribution maven-wrapper-plugin - - - - - - org.apache.maven.plugins - maven-jxr-plugin - 3.0.0 - - - org.apache.maven.plugins - maven-project-info-reports-plugin - 3.1.0 - - - - diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt new file mode 100644 index 0000000..b150a80 --- /dev/null +++ b/src/site/apt/index.apt @@ -0,0 +1,35 @@ +~~ Licensed to the Apache Software Foundation (ASF) under one +~~ or more contributor license agreements. See the NOTICE file +~~ distributed with this work for additional information +~~ regarding copyright ownership. The ASF licenses this file +~~ to you under the Apache License, Version 2.0 (the +~~ "License"); you may not use this file except in compliance +~~ with the License. You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, +~~ software distributed under the License is distributed on an +~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +~~ KIND, either express or implied. See the License for the +~~ specific language governing permissions and limitations +~~ under the License. + + ----- + Introduction + ----- + Hervé Boutemy + ----- + 2021-04-05 + ----- + +Maven Wrapper + + Maven Wrapper is composed of 3 pieces: + + - {{{./maven-wrapper/} maven-wrapper}}, + + - {{{./maven-wrapper-distribution/} maven-wrapper distribution}}, that provides <<>>:<<>> scripts distributions, + + - {{{./maven-wrapper-plugin/} maven-wrapper-plugin}}, a plugin to ease installing Wrapper into a project. + \ No newline at end of file diff --git a/maven-wrapper-plugin/src/site/resources/download.cgi b/src/site/resources/download.cgi similarity index 100% rename from maven-wrapper-plugin/src/site/resources/download.cgi rename to src/site/resources/download.cgi diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..b6816dd --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/maven-wrapper-plugin/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm similarity index 85% rename from maven-wrapper-plugin/src/site/xdoc/download.xml.vm rename to src/site/xdoc/download.xml.vm index 5130c5c..e49aeac 100644 --- a/maven-wrapper-plugin/src/site/xdoc/download.xml.vm +++ b/src/site/xdoc/download.xml.vm @@ -34,7 +34,7 @@ under the License.

In order to guard against corrupted downloads/installations, it is highly recommended to verify the signature - of the release bundles against the public KEYS used by the Apache Maven + of the release bundles against the public KEYS used by the Apache Maven developers.

${project.name} is distributed under the Apache License, version 2.0.

@@ -107,9 +107,9 @@ under the License. ${project.name} ${project.version} (Source zip) - maven/plugins/${project.artifactId}-${project.version}-source-release.zip - maven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512 - maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc + maven/wrapper/${project.artifactId}-${project.version}-source-release.zip + maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.sha512 + maven/wrapper/${project.artifactId}-${project.version}-source-release.zip.asc @@ -117,7 +117,7 @@ under the License. -

Older non-recommended releases can be found on our archive site.

+

Older non-recommended releases can be found on our archive site.