This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new cccc62d Migrate site generation templates to
https://maven.apache.org/xsd/xdoc-2.0.xsd
cccc62d is described below
commit cccc62da496ee5614fdc0d2ef0c60136603b2e81
Author: Gary D. Gregory <[email protected]>
AuthorDate: Mon Jan 20 08:20:47 2025 -0500
Migrate site generation templates to
https://maven.apache.org/xsd/xdoc-2.0.xsd
---
src/changes/changes.xml | 1 +
src/site/xdoc/development.xml | 5 +++--
src/site/xdoc/download_release-plugin.xml | 4 +++-
src/site/xdoc/index.xml | 35 ++++++++++++++++---------------
src/site/xdoc/issue-tracking.xml | 10 +++++----
src/site/xdoc/mail-lists.xml | 10 +++++----
src/site/xdoc/vote-txt.xml | 20 ++++++------------
7 files changed, 43 insertions(+), 42 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 30ba72b..6421b7b 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -26,6 +26,7 @@
<body>
<release version="1.9.1" date="YYYY-MM-DD" description="Version 1.9.1.">
<!-- FIX -->
+ <action dev="ggregory" type="fix" due-to="Gary Gregory">Migrate site
generation templates to https://maven.apache.org/xsd/xdoc-2.0.xsd.</action>
<!-- ADD -->
<!-- UPDATE -->
<action type="update" dev="engelen" due-to="Dependabot, Arnout
Engelen">Bump org.apache.commons:commons-build-plugin from 1.14.1 to 1.15.0
#355.</action>
diff --git a/src/site/xdoc/development.xml b/src/site/xdoc/development.xml
index 36ff8b0..1a469f4 100644
--- a/src/site/xdoc/development.xml
+++ b/src/site/xdoc/development.xml
@@ -13,8 +13,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Development</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
diff --git a/src/site/xdoc/download_release-plugin.xml
b/src/site/xdoc/download_release-plugin.xml
index 3a4da5c..2a659a0 100644
--- a/src/site/xdoc/download_release-plugin.xml
+++ b/src/site/xdoc/download_release-plugin.xml
@@ -56,7 +56,9 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Download Apache Commons Release Plugin</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index ba4b810..888a1a2 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -15,8 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Overview</title>
<author email="[email protected]">Apache Commons Team</author>
@@ -49,6 +50,7 @@
<p>
Available Goals (which are meant to be used together; the only
reason they are separated is for
code readability):
+ </p>
<ul>
<li>
<b>commons-release:detach-distributions</b> - Remove
@@ -65,7 +67,6 @@
<a href="vote-txt.html">commons-release:vote-txt</a>
-Dcommons.nexus.repo.id=nnnn [-Dgit.tag.name] # where nnn is the number
following orgapachecommons- in the Nexus 'Repository' column
</li>
</ul>
- </p>
</section>
<section name="Using the plugin">
@@ -143,27 +144,27 @@
After the above configuration performing the release would occur
by (<i>note.</i> more
in depth details can be found at
<a
href="https://commons.apache.org/releases/prepare.html";>Preparations For A
Release</a>):
- <ol>
- <li>creating our release branch,</li>
- <li>checking compatibility,</li>
- <li>checking your dependencies,</li>
- <li>checking javadocs and code style,</li>
- <li>checking the apache license,</li>
- <li>configure the build to generate a complete set of
release artifacts,</li>
- <li>preparing the release notes, updating the download
file and other autogenerated files,</li>
- <li>tagging the release candidate, and</li>
- <li>
+ </p>
+ <ol>
+ <li>creating our release branch,</li>
+ <li>checking compatibility,</li>
+ <li>checking your dependencies,</li>
+ <li>checking javadocs and code style,</li>
+ <li>checking the apache license,</li>
+ <li>configure the build to generate a complete set of release
artifacts,</li>
+ <li>preparing the release notes, updating the download file and
other autogenerated files,</li>
+ <li>tagging the release candidate, and</li>
+ <li>
running the following command:
<source><![CDATA[
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword]
[-Dcommons.release.dryRun=true -Ptest-deploy] -Prelease clean test site deploy
-]]></source>
- </li>
- </ol>
+]]></source></li>
+ </ol>
+ <p>
To avoid specifying distribution credentials at the command
line, consider using the <code>distServer</code> plugin
configuration parameter (property <code>commons.distServer</code>)
to specify a server definition in Maven <code>settings.xml</code>
which defines your (encrypted, right?) authentication info.
</p>
-
<p>
If the component is new, then, before running this maven command,
you would want to create
the requisite subversion directory
<code>https://dist.apache.org/repos/dist/dev/commons/foo</code>. Notice,
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index ad4f943..9407713 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -41,7 +41,9 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Release Plugin Issue tracking</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
@@ -64,6 +66,7 @@ limitations under the License.
<p>
If you would like to report a bug, or raise an enhancement request with
Apache Commons Release Plugin please do the following:
+ </p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
If you find your issue listed then please add a comment with your
details.</li>
@@ -73,16 +76,15 @@ limitations under the License.
<li>Submit either a <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&component=12312401&issuetype=1&priority=4&assignee=-1";>bug
report</a>
or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&component=12312401&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
</ol>
- </p>
<p>
Please also remember these points:
+ </p>
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed
enhancements</li>
<li>the developers of Apache Commons Release Plugin are all unpaid
volunteers</li>
</ul>
- </p>
<p>
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
<p>
You may also find these links useful:
+ </p>
<ul>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Release Plugin bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Release Plugin bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310466&component=12312401&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Release Plugin bugs</a></li>
</ul>
- </p>
</section>
</body>
</document>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index 24c64b2..3737f5a 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -39,7 +39,9 @@ limitations under the License.
| |
+======================================================================+
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Release Plugin Mailing Lists</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
@@ -53,10 +55,10 @@ limitations under the License.
To make it easier for people to only read messages related to
components they are interested in,
the convention in Commons is to prefix the subject line of messages
with the component's name,
for example:
- <ul>
- <li>[release-plugin] Problem with the ...</li>
- </ul>
</p>
+ <ul>
+ <li>[release-plugin] Problem with the ...</li>
+ </ul>
<p>
Questions related to the usage of Apache Commons Release Plugin should
be posted to the
<a
href="https://lists.apache.org/[email protected]";>User List</a>.
diff --git a/src/site/xdoc/vote-txt.xml b/src/site/xdoc/vote-txt.xml
index fe0ad00..554883b 100644
--- a/src/site/xdoc/vote-txt.xml
+++ b/src/site/xdoc/vote-txt.xml
@@ -15,30 +15,26 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Generating VOTE.txt</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
</properties>
-
<body>
-
-
- <section name="commons-release:vote-txt" href="vote-txt">
-
+ <section name="commons-release:vote-txt" id="vote-txt">
<subsection name="Overview">
<p>
The <code>commons-release:vote-txt</code> goal generates a
VOTE.txt file for a component.
Execute the goal using the following command: <source>mvn
commons-release:vote-txt</source>
</p>
-
<p>
<strong>Note:</strong> The VOTE.txt should be regenerated
before every release candidate.
</p>
-
<p>
This goal uses the following:
+ </p>
<ul>
<li>The goal is mapped to the ant script/target using the
<code>vote-txt</code> mojo definition in the
<a
href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
@@ -49,17 +45,15 @@
template</li>
<li>Uses the <a href="vote-txt-mojo.html">goal's (i.e.
mojo's) parameters</a> to filter values in the template</li>
</ul>
- </p>
</subsection>
-
<subsection name="Configuration">
<p>
To generate a VOTE.txt, the following <a
href="vote-txt-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>
+ </p>
<ul>
<li><b>commons.componentid</b> - Commons component ID</li>
<li><b>commons.release.version</b> - The version number of
the latest release of the component</li>
</ul>
- </p>
<p>
Example configuration for Commons Chain:
<source><![CDATA[
@@ -70,8 +64,6 @@
]]></source>
</p>
</subsection>
-
</section>
-
</body>
</document>
