This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-resolver-ant-tasks.git
The following commit(s) were added to refs/heads/master by this push:
new af440da Refresh site documentation
af440da is described below
commit af440da959a56648637a789a886f01131fd62da5
Author: Slawomir Jaranowski <[email protected]>
AuthorDate: Thu Aug 14 19:21:38 2025 +0200
Refresh site documentation
- move index.md.vm to index.md - we not need a velocity here
- update format of xml examples in index.md
- update site descriptor to 2.0.0
- update download page
- fix scm/url - it is used for generating edit icon
---
pom.xml | 3 +-
src/site/markdown/{index.md.vm => index.md} | 223 +++++++++++++++++-----------
src/site/site.xml | 9 +-
src/site/xdoc/download.xml.vm | 123 +++++----------
4 files changed, 179 insertions(+), 179 deletions(-)
diff --git a/pom.xml b/pom.xml
index c2b5a2b..0821efc 100644
--- a/pom.xml
+++ b/pom.xml
@@ -39,8 +39,9 @@
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-resolver-ant-tasks.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-resolver-ant-tasks.git</developerConnection>
<tag>HEAD</tag>
- <url>https://github.com/apache/maven-resolver-ant-tasks/</url>
+
<url>https://github.com/apache/maven-resolver-ant-tasks/tree/${project.scm.tag}</url>
</scm>
+
<issueManagement>
<system>GitHub Issues</system>
<url>https://github.com/apache/maven-resolver-ant-tasks/issues</url>
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md
similarity index 53%
rename from src/site/markdown/index.md.vm
rename to src/site/markdown/index.md
index 58b14e3..44c1f45 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md
@@ -1,3 +1,21 @@
+<!--
+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.
+-->
# Maven Artifact Resolver Ant Tasks
The Maven Artifact Resolver Ant Tasks enable build scripts for [Apache
Ant](http://ant.apache.org/) 1.7+ to use
@@ -8,11 +26,13 @@ to resolve dependencies and install and deploy locally built
artifacts.
To integrate the tasks into your build file, copy the Über JAR into your
project's lib directory and use the following
snippet to load it:
- <project xmlns:resolver="antlib:org.apache.maven.resolver.ant" ...>
- <taskdef uri="antlib:org.apache.maven.resolver.ant"
resource="org/apache/maven/resolver/ant/antlib.xml"
- classpath="lib/maven-resolver-ant-tasks-${project.version}-uber.jar" />
- ...
- </project>
+```xml
+<project xmlns:resolver="antlib:org.apache.maven.resolver.ant" ...>
+ <taskdef uri="antlib:org.apache.maven.resolver.ant"
resource="org/apache/maven/resolver/ant/antlib.xml"
+ classpath="lib/maven-resolver-ant-tasks-${project.version}-uber.jar" />
+ ...
+</project>
+```
See the `build.xml` in the project sources for a complete example build script.
@@ -28,7 +48,9 @@ For the global settings, different paths will be tried:
The `<settings/>` definition is used to change that:
- <settings file="my-settings.xml" globalfile="myglobal-settings.xml"/>
+```xml
+<settings file="my-settings.xml" globalfile="myglobal-settings.xml"/>
+```
Some settings defined in the settings file or in the POM can also be changed
inside the Ant file.
@@ -38,7 +60,9 @@ Proxy definitions are used throughout the whole session.
There may be multiple
proxies set. The proxy to use will be chosen by evaluating the `nonProxyHosts`
on
each proxy definition, the first matching proxy will be used for a given
remote connection.
- <proxy host="proxy.mycorp.com" port="8080" type="http"
nonProxyHosts="127.*|localhost|*.mycorp.com"/>
+```xml
+<proxy host="proxy.mycorp.com" port="8080" type="http"
nonProxyHosts="127.*|localhost|*.mycorp.com"/>
+```
### Authentication
@@ -47,50 +71,61 @@ authentication definition will be added globally and chosen
based on the
`servers` attribute. If this attribute is not set, an authentication has to be
referenced explicitly to be used.
- <authentication username="login" password="pw" id="auth"/>
- <authentication privateKeyFile="file.pk" passphrase="phrase"
servers="distrepo" id="distauth"/>
+```xml
+<authentication username="login" password="pw" id="auth"/>
+<authentication privateKeyFile="file.pk" passphrase="phrase"
servers="distrepo" id="distauth"/>
+```
### Local Repository
Only one local repository can be used at a time.
- <localrepo dir="someDir"/>
+```xml
+<localrepo dir="someDir"/>
+```
### Remote Repositories
Remote repositories may be defined directly:
- <remoterepo id="ossrh"
url="https://oss.sonatype.org/content/repositories/snapshots/"; type="default"
releases="false" snapshots="true" updates="always" checksums="fail"/>
+```xml
+<remoterepo id="ossrh"
url="https://oss.sonatype.org/content/repositories/snapshots/"; type="default"
releases="false" snapshots="true" updates="always" checksums="fail"/>
- <remoterepo id="rao"
url="https://repository.apache.org/content/groups/public/";>
- <releases enabled="true" updates="daily" checksums="warn"/>
- <snapshots enabled="false"/>
- <authentication refid="auth"/>
- </remoterepo>
+<remoterepo id="rao"
url="https://repository.apache.org/content/groups/public/";>
+ <releases enabled="true" updates="daily" checksums="warn"/>
+ <snapshots enabled="false"/>
+ <authentication refid="auth"/>
+</remoterepo>
- <remoterepo id="distrepo" url="..." authref="distauth"/>
+<remoterepo id="distrepo" url="..." authref="distauth"/>
+```
Multiple repositories may be used as a group in every place that is legal for a
remote repository:
- <remoterepos id="all">
- <remoterepo refid="ossrh"/>
- <remoterepo refid="rao"/>
- <remoterepo refid="distrepo"/>
- </remoterepos>
+```xml
+<remoterepos id="all">
+ <remoterepo refid="ossrh"/>
+ <remoterepo refid="rao"/>
+ <remoterepo refid="distrepo"/>
+</remoterepos>
+```
*Note:* Currently, only file:, http: and https: protocols are supported for
remote repositories.
### Mirrors
- <mirror id="" url="" mirrorOf=""/>
+```xml
+<mirror id="" url="" mirrorOf=""/>
+```
### Offline Mode
To suppress any network activity and only use already cached
artifacts/metadata, you can use a boolean property:
- <property name="resolver.offline" value="true"/>
-
+```xml
+<property name="resolver.offline" value="true"/>
+```
## Project
@@ -102,9 +137,11 @@ The POM is the data type used to determine the target for
the install and
deploy tasks. If you define a POM without an id based on a full `pom.xml` file,
that POM will be used by default for install and deploy.
- <pom file="pom.xml" id="pom"/>
- <pom groupId="g" artifactId="a" version="v"/>
- <pom coords="g:a:v"/>
+```xml
+<pom file="pom.xml" id="pom"/>
+<pom groupId="g" artifactId="a" version="v"/>
+<pom coords="g:a:v"/>
+```
#### Properties
@@ -117,12 +154,14 @@ assigned, the properties use the prefix `pom.` by default.
`<artifact>` elements define the artifacts produced by this build that should
be installed or deployed.
- <artifact file="file-src.jar" type="jar" classifier="sources" id="src"/>
+```xml
+<artifact file="file-src.jar" type="jar" classifier="sources" id="src"/>
- <artifacts id="producedArtifacts">
- <artifact refid="src"/>
- <artifact file="file-src.jar"/>
- </artifacts>
+<artifacts id="producedArtifacts">
+ <artifact refid="src"/>
+ <artifact file="file-src.jar"/>
+</artifacts>
+```
### Dependencies
@@ -130,34 +169,35 @@ Dependencies are used to to create classpaths or
filesets. They are used by
the `<resolve>`-task, which collects the artifacts belonging to the
dependencies
transitively.
- <dependency coords="g:a:v:scope"/>
-
- <dependency groupId="g" artifactId="a" version="v" classifier="c"
type="jar" scope="runtime">
- <exclusion coords="g:a"/>
- <exclusion groupId="g" artifactId="a"/>
- </dependency>
+```xml
+<dependency coords="g:a:v:scope"/>
- <dependencies id="deps">
- <dependency refid="first"/>
- <dependency refid="second"/>
- <exclusion coords="g:a"/> <!-- global exclusion for all dependencies
of this group -->
- </dependencies>
+<dependency groupId="g" artifactId="a" version="v" classifier="c" type="jar"
scope="runtime">
+ <exclusion coords="g:a"/>
+ <exclusion groupId="g" artifactId="a"/>
+</dependency>
- <dependencies>
- <dependency coords="test:artifact:1.0:runtime"/>
- <dependencies refid="deps"/> <!-- nested dependency collection merged
into this one -->
- </dependencies>
+<dependencies id="deps">
+ <dependency refid="first"/>
+ <dependency refid="second"/>
+ <exclusion coords="g:a"/> <!-- global exclusion for all dependencies of
this group -->
+</dependencies>
- <dependencies id="depsFromPom" pomRef="pom"/>
+<dependencies>
+ <dependency coords="test:artifact:1.0:runtime"/>
+ <dependencies refid="deps"/> <!-- nested dependency collection merged into
this one -->
+</dependencies>
- <dependencies id="depsFromPlainTextFile" file="dependencies.txt"/>
- <!--
- Each non-empty line of that text file declares one dependency, using the
same syntax as for the `coords` attribute
- of the `<dependency>` element, i.e.
- <groupId>:<artifactId>:<version>[[:<type>[:<classifier>]]:<scope>]
- Everything after the first hash (#) character on a line is considered a
comment.
- -->
+<dependencies id="depsFromPom" pomRef="pom"/>
+<dependencies id="depsFromPlainTextFile" file="dependencies.txt"/>
+<!--
+Each non-empty line of that text file declares one dependency, using the same
syntax as for the `coords` attribute
+of the `<dependency>` element, i.e.
+<groupId>:<artifactId>:<version>[[:<type>[:<classifier>]]:<scope>]
+Everything after the first hash (#) character on a line is considered a
comment.
+-->
+```
## Tasks
@@ -165,16 +205,20 @@ transitively.
You need to set a POM that references a file for the install task to work.
- <install artifactsref="producedArtifacts"/>
+```xml
+<install artifactsref="producedArtifacts"/>
+```
### Deploy
You need to set a POM that references a file for the deploy task to work, as
that POM file will be deployed to repository.
- <deploy artifactsref="producedArtifacts">
- <remoterepo refid="distrepo"/>
- <snapshotrepo refid="snaprepo">
- </deploy>
+```xml
+<deploy artifactsref="producedArtifacts">
+ <remoterepo refid="distrepo"/>
+ <snapshotrepo refid="snaprepo">
+</deploy>
+```
### Resolve
@@ -194,24 +238,26 @@ This task is able to assemble the collected dependencies
in three different ways
These targets may also be mentioned more than once for the same resolve task,
but only one `<dependencies>` element is allowed.
- <resolve failOnMissingAttachments="true">
- <dependencies>
- <dependency coords="org.apache.maven:maven-profile:2.0.6"/>
- <exclusion artifactId="junit"/>
- <exclusion groupId="org.codehaus.plexus"/>
- </dependencies>
- <path refid="cp" classpath="compile"/>
- <files refid="src.files" attachments="sources" dir="target/sources"
- layout="{artifactId}-{classifier}.{extension}"/>
- <files refid="api.files" attachments="javadoc" dir="target/javadoc"
- layout="{artifactId}-{classifier}.{extension}"/>
- <properties prefix="dep." scopes="provided,system"/>
- </resolve>
-
- <resolve dependenciesref="deps">
- <path refid="cp.compile" classpath="compile"/>
- <path refid="cp.test" classpath="test"/>
- </resolve>
+```xml
+<resolve failOnMissingAttachments="true">
+ <dependencies>
+ <dependency coords="org.apache.maven:maven-profile:2.0.6"/>
+ <exclusion artifactId="junit"/>
+ <exclusion groupId="org.codehaus.plexus"/>
+ </dependencies>
+ <path refid="cp" classpath="compile"/>
+ <files refid="src.files" attachments="sources" dir="target/sources"
+ layout="{artifactId}-{classifier}.{extension}"/>
+ <files refid="api.files" attachments="javadoc" dir="target/javadoc"
+ layout="{artifactId}-{classifier}.{extension}"/>
+ <properties prefix="dep." scopes="provided,system"/>
+</resolve>
+
+<resolve dependenciesref="deps">
+ <path refid="cp.compile" classpath="compile"/>
+ <path refid="cp.test" classpath="test"/>
+</resolve>
+```
Scope filters can be set on every target, enumerating included and/or excluded
scope names. Exclusions are denoted by prefixing the scope name with `-` or
`!` (e.g. `provided,!system`).
@@ -220,12 +266,14 @@ The `classpath` attribute is a shortcut for the scope
filters (e.g.
`classpath="compile"` equals `scope="provided,system,compile"`). Valid values
are
"`compile`", "`runtime`", "`test`".
- <resolve>
- <dependencies pomRef="pom"/>
- <remoterepos refid="all"/>
- <path refid="cp" classpath="compile"/>
- <path refid="tp" classpath="test"/>
- </resolve>
+```xml
+<resolve>
+ <dependencies pomRef="pom"/>
+ <remoterepos refid="all"/>
+ <path refid="cp" classpath="compile"/>
+ <path refid="tp" classpath="test"/>
+</resolve>
+```
The layout attribute of the `<files>` element is only allowed when the `dir`
attribute is also given and recognizes the
following placeholders to refer to the coordinates of the currently processed
artifact:
@@ -239,5 +287,6 @@ following placeholders to refer to the coordinates of the
currently processed ar
* `{classifier}`, e.g. "sources"
# More information
-See [usage.md](https://github.com/apache/maven-resolver-ant-tasks/usage.md)
for info.
-The [examples](https://github.com/apache/maven-resolver-ant-tasks/examples)
contains 7 complete examples of various ways to use Maven Resolver Ant Tasks.
\ No newline at end of file
+See
[usage.md](https://github.com/apache/maven-resolver-ant-tasks/blob/master/usage.md)
for info.
+
+The
[examples](https://github.com/apache/maven-resolver-ant-tasks/tree/master/examples)
contains 7 complete examples of various ways to use Maven Resolver Ant Tasks.
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index 68313d3..6ac8edc 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,8 +19,8 @@ specific language governing permissions and limitations
under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.8.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0
http://maven.apache.org/xsd/decoration-1.8.0.xsd";
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd";
name="Maven Resolver Ant Tasks">
<body>
@@ -29,9 +29,10 @@ under the License.
<item name="Javadoc" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
- <item name="License" href="http://www.apache.org/licenses/"/>
+ <item name="License" href="https://www.apache.org/licenses/"/>
<item name="Download" href="download.html"/>
</menu>
+
<menu name="See Also">
<item name="Maven Artifact Resolver"
href="https://maven.apache.org/resolver/"/>
<item name="Maven Artifact Resolver Provider"
href="https://maven.apache.org/ref/current/maven-resolver-provider/"/>
@@ -39,4 +40,4 @@ under the License.
<menu ref="reports"/>
</body>
-</project>
\ No newline at end of file
+</site>
\ No newline at end of file
diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
index 57e7710..5e89920 100644
--- a/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -23,102 +23,51 @@ under the License.
<properties>
<title>Download ${project.name} Source</title>
</properties>
+
<body>
<section name="Download ${project.name} ${project.version} Source">
- <p>${project.name} ${project.version} is distributed in source format.
Use a source archive if you intend to build
- ${project.name} yourself. Otherwise, simply use the ready-made binary
artifacts from central repository.</p>
-
- <p>You will be prompted for a mirror - if the file is not found on
yours, please be patient, as it may take 24
- hours to reach all mirrors.<p/>
-
- <p>In order to guard against corrupted downloads/installations, it is
highly recommended to
- <a
href="http://www.apache.org/dev/release-signing#verifying-signature";>verify the
signature</a>
- of the release bundles against the public <a
href="https://www.apache.org/dist/maven/KEYS";>KEYS</a> used by the Apache Maven
- developers.</p>
-
- <p>${project.name} is distributed under the <a
href="http://www.apache.org/licenses/";>Apache License, version 2.0</a>.</p>
-
- <p></p>We <b>strongly</b> encourage our users to configure a Maven
repository mirror closer to their location, please read <a
href="/guides/mini/guide-mirror-settings.html">How to Use Mirrors for
Repositories</a>.</p>
-
- <a name="mirror"/>
- <subsection name="Mirror">
-
- <p>
- [if-any logo]
- <a href="[link]">
- <img align="right" src="[logo]" border="0"
- alt="logo"/>
- </a>
- [end]
- The currently selected mirror is
- <b>[preferred]</b>.
- If you encounter a problem with this mirror,
- please select another mirror.
- If all mirrors are failing, there are
- <i>backup</i>
- mirrors
- (at the end of the mirrors list) that should be available.
- </p>
+ <p><strong>${project.name} ${project.version}</strong> is distributed in
source format.</p>
+
+ <p>Use a source archive if you intend to build
<strong>${project.name}</strong> yourself.</p>
+
+ <p>Otherwise, simply use the ready-made binary artifacts from
<strong>central repository</strong>.</p>
+
+ <p><strong>${project.name}</strong> is distributed under the <a
href="https://www.apache.org/licenses/";>Apache License, version 2.0</a>.</p>
- <form action="[location]" method="get" id="SelectMirror">
- Other mirrors:
- <select name="Preferred">
- [if-any http]
- [for http]
- <option value="[http]">[http]</option>
- [end]
- [end]
- [if-any ftp]
- [for ftp]
- <option value="[ftp]">[ftp]</option>
- [end]
- [end]
- [if-any backup]
- [for backup]
- <option value="[backup]">[backup] (backup)</option>
- [end]
- [end]
- </select>
- <input type="submit" value="Change"/>
- </form>
-
- <p>
- You may also consult the
- <a href="http://www.apache.org/mirrors/";>complete list of
- mirrors.</a>
+ <subsection name="Files">
+
+ <p>This is the current stable version of
<strong>${project.name}</strong>.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th></th>
+ <th>Link</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>${project.name} ${project.version} (Source zip)</td>
+ <td><a
href="https://dlcdn.apache.org/maven/resolver/${project.artifactId}-${project.version}-source-release.zip";>${project.artifactId}-${project.version}-source-release.zip</a></td>
+ <td><a
href="https://downloads.apache.org/maven/resolver/${project.artifactId}-${project.version}-source-release.zip.sha512";>${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
+ <td><a
href="https://downloads.apache.org/maven/resolver/${project.artifactId}-${project.version}-source-release.zip.asc";>${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p>It is essential that you <a
href="https://www.apache.org/info/verification.html";>verify the integrity</a>
of the downloaded file
+ using the checksum (.sha512 file)
+ or using the signature (.asc file) against the public <a
href="https://downloads.apache.org/maven/KEYS";>KEYS</a> used by the Apache
Maven developers.
</p>
</subsection>
-
- <subsection name="${project.name} ${project.version}">
-
- <p>This is the current stable version of ${project.name}.</p>
-
- <table>
- <thead>
- <tr>
- <th></th>
- <th>Link</th>
- <th>Checksum</th>
- <th>Signature</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>${project.name} ${project.version} (Source zip)</td>
- <td><a
href="[preferred]maven/resolver/${project.artifactId}-${project.version}-source-release.zip">maven/resolver/${project.artifactId}-${project.version}-source-release.zip</a></td>
- <td><a
href="https://www.apache.org/dist/maven/resolver/${project.artifactId}-${project.version}-source-release.zip.sha512";>maven/resolver/${project.artifactId}-${project.version}-source-release.zip.sha512</a></td>
- <td><a
href="https://www.apache.org/dist/maven/resolver/${project.artifactId}-${project.version}-source-release.zip.asc";>maven/resolver/${project.artifactId}-${project.version}-source-release.zip.asc</a></td>
- </tr>
- </tbody>
- </table>
- </subsection>
<subsection name="Previous Versions">
-
- <p>Older non-recommended releases can be found on our <a
href="http://archive.apache.org/dist/maven/resolver/";>archive site</a>.</p>
-
+ <p>It is strongly recommended to use the latest release version of
<strong>${project.name}</strong> to take advantage of the newest features and
bug fixes.</p>
+ <p>Older non-recommended releases can be found on our <a
href="https://archive.apache.org/dist/maven/resolver/";>archive site</a>.</p>
</subsection>
</section>
</body>
