You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 13:11:16 UTC
(maven-wrapper) branch master updated (91b03d9 -> 10f9581)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-wrapper.git
from 91b03d9 Bump apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml
new 5f4bf9c Rename the site documents ahead of converting them
new 10f9581 Port the site documentation from APT to Markdown
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../src/site/apt/index.apt.vm | 58 ----------------------
.../src/site/markdown/index.md.vm | 50 +++++++++++++++++++
maven-wrapper/src/site/apt/index.apt | 30 -----------
.../src/site/markdown/index.md | 16 ++----
4 files changed, 54 insertions(+), 100 deletions(-)
delete mode 100644 maven-wrapper-distribution/src/site/apt/index.apt.vm
create mode 100644 maven-wrapper-distribution/src/site/markdown/index.md.vm
delete mode 100644 maven-wrapper/src/site/apt/index.apt
copy AGENTS.md => maven-wrapper/src/site/markdown/index.md (61%)
(maven-wrapper) 02/02: Port the site documentation from APT to Markdown
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-wrapper.git
commit 10f95814175a185527f2260b5f2189ce4354ba4b
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:52:56 2026 +0200
Port the site documentation from APT to Markdown
2 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- references APT rendered literally are escaped, so they do not resolve
Verified by building the site before and after and comparing every
generated page: the visible text and the link targets are unchanged apart
from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
Markdown module's typographic substitution.
---
.../src/site/markdown/index.md.vm | 86 ++++++++++------------
maven-wrapper/src/site/markdown/index.md | 46 +++++-------
2 files changed, 59 insertions(+), 73 deletions(-)
diff --git a/maven-wrapper-distribution/src/site/markdown/index.md.vm b/maven-wrapper-distribution/src/site/markdown/index.md.vm
index c31612b..5786a09 100644
--- a/maven-wrapper-distribution/src/site/markdown/index.md.vm
+++ b/maven-wrapper-distribution/src/site/markdown/index.md.vm
@@ -1,58 +1,50 @@
-~~ 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.
-
- -----
- ${project.name}
- -----
- Hervé Boutemy
- -----
- 2021-10-10
- -----
-
-${project.name}
-
- ${project.description}
-
- Distributions types share the same base structure:
-
-----
+<!--
+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.
+-->
+
+# ${project.name}
+
+${project.description}
+
+Distributions types share the same base structure:
+
+```
mvnw
mvnw.cmd
.mvn/wrapper/maven-wrapper.properties
-----
+```
+
+but every distribution has specific content to manage different strategies to get [`maven-wrapper.jar`](../maven-wrapper/):
- but every distribution has specific content to manage different strategies to get {{{../maven-wrapper/}<<<maven-wrapper.jar>>>}}:
+\- `only-script`: the new lite implementation of `mvnw`/`mvnw.cmd` scripts will download Maven directly with `wget` or `curl` on *nix, or PowerShell on Windows, then exec/call the original `mvn`/`mvn.cmd` scripts of the downloaded maven distribution, skipping `maven-wrapper.jar`.
- - <<<only-script>>>: the new lite implementation of <<<mvnw>>>/<<<mvnw.cmd>>> scripts will download Maven directly with <<<wget>>> or <<<curl>>> on *nix, or PowerShell on Windows, then exec/call the original <<<mvn>>>/<<<mvn.cmd>>> scripts of the downloaded maven distribution, skipping <<<maven-wrapper.jar>>>.
-
- - <<<script>>>: <<<mvnw>>>/<<<mvnw.cmd>>> scripts will download {{{../maven-wrapper/}<<<maven-wrapper.jar>>>}} with <<<wget>>> or <<<curl>>> on *nix, or PowerShell on Windows
-
- - <<<bin>>> (default): no need to download <<<maven-wrapper.jar>>> binary, it is directly provided and used from project source tree (if stored in source control):
+\- `script`: `mvnw`/`mvnw.cmd` scripts will download [`maven-wrapper.jar`](../maven-wrapper/) with `wget` or `curl` on *nix, or PowerShell on Windows
-----
+\- `bin` (default): no need to download `maven-wrapper.jar` binary, it is directly provided and used from project source tree (if stored in source control):
+
+```
.mvn/wrapper/maven-wrapper.jar
-----
+```
- - <<<source>>>: on *nix, if <<<wget>>> and <<<curl>>> are not available, the <<<mvnw>>> script will compile <<<MavenWrapperDownloader.java>>>, then run the class to download {{{../maven-wrapper/}<<<maven-wrapper.jar>>>}}:
+\- `source`: on *nix, if `wget` and `curl` are not available, the `mvnw` script will compile `MavenWrapperDownloader.java`, then run the class to download [`maven-wrapper.jar`](../maven-wrapper/):
-----
+```
.mvn/wrapper/MavenWrapperDownloader.java
-----
-
- []
+```
- The distribution can be installed in a project either by unpacking the zip archive by hand, or by using {{{../maven-wrapper-plugin/}<<<wrapper:wrapper>>>}}.
+The distribution can be installed in a project either by unpacking the zip archive by hand, or by using [`wrapper:wrapper`](../maven-wrapper-plugin/).
diff --git a/maven-wrapper/src/site/markdown/index.md b/maven-wrapper/src/site/markdown/index.md
index f28a5fa..a424dc7 100644
--- a/maven-wrapper/src/site/markdown/index.md
+++ b/maven-wrapper/src/site/markdown/index.md
@@ -1,30 +1,24 @@
-~~ 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.
+<!--
+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
- -----
- Introduction
- -----
- Hervé Boutemy
- -----
- 2021-04-05
- -----
+http://www.apache.org/licenses/LICENSE-2.0
-Maven Wrapper Jar
+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.
+-->
- Maven Wrapper Jar 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 Jar
- Maven Wrapper is called by {{{../maven-wrapper-distribution/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.
+Maven Wrapper Jar 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 [`mvnw`/`mvnw.cmd` scripts](../maven-wrapper-distribution/) that need to be installed in the project source tree and called instead of `mvn`/`mvn.cmd`.
(maven-wrapper) 01/02: Rename the site documents ahead of converting them
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-wrapper.git
commit 5f4bf9c8fbdce2ebdbbf653064f6bc817babbf77
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:52:56 2026 +0200
Rename the site documents ahead of converting them
A pure rename, so that git records it and `git log --follow` and `git blame` still
reach the history of each page after the conversion that follows. The content is
still APT at this point and the site does not build between the two commits.
---
.../src/site/{apt/index.apt.vm => markdown/index.md.vm} | 0
maven-wrapper/src/site/{apt/index.apt => markdown/index.md} | 0
2 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/maven-wrapper-distribution/src/site/apt/index.apt.vm b/maven-wrapper-distribution/src/site/markdown/index.md.vm
similarity index 100%
rename from maven-wrapper-distribution/src/site/apt/index.apt.vm
rename to maven-wrapper-distribution/src/site/markdown/index.md.vm
diff --git a/maven-wrapper/src/site/apt/index.apt b/maven-wrapper/src/site/markdown/index.md
similarity index 100%
rename from maven-wrapper/src/site/apt/index.apt
rename to maven-wrapper/src/site/markdown/index.md