You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by se...@apache.org on 2020/08/07 12:14:11 UTC
svn commit: r1064055 [3/4] - in /websites/staging/commons/trunk/content: ./
downloads/ gsoc/ gsoc/2010/ releases/
Modified: websites/staging/commons/trunk/content/releases/prepare.html
==============================================================================
--- websites/staging/commons/trunk/content/releases/prepare.html (original)
+++ websites/staging/commons/trunk/content/releases/prepare.html Fri Aug 7 12:14:11 2020
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 26 July 2020
+ | Generated by Apache Maven Doxia at 07 August 2020
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -8,7 +8,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Apache Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20200726" />
+ <meta name="Date-Revision-yyyymmdd" content="20200807" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Commons – Preparations for a Release</title>
@@ -25,7 +25,7 @@
</head>
<body class="composite">
- <a href=".././" id="bannerLeft" title="Apache Commons logo">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
<img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
</a>
<div class="clear"></div>
@@ -33,11 +33,11 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
- <a class="brand" href="http://commons.apache.org/">Apache Commons ™</a>
+ <a class="brand" href="https://commons.apache.org/">Apache Commons ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 26 July 2020</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 19</li>
+ <li id="publishDate">Last Published: 07 August 2020</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 23</li>
</ul>
<div class="pull-right"> <ul class="nav">
<li>
@@ -86,7 +86,7 @@
Mailing Lists</a>
</li>
<li class="none">
- <a href="../team-list.html" title="PMC">
+ <a href="../team.html" title="PMC">
PMC</a>
</li>
<li class="collapsed">
@@ -205,23 +205,10 @@
</div>
</td>
<td class="content">
- <!-- 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. -->
+
- <div class="section">
+ <section>
<h2><a name="Introduction"></a>Introduction</h2>
<p>
@@ -243,9 +230,8 @@
The examples below assume that preparation is being made to release version <i>1.2</i>
of component <i>Foo</i>.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Build_Environments"></a>Build Environments</h2>
<p>
@@ -262,13 +248,11 @@
that steps are being executed from the command-line. The principles are the same, however,
for a release prepared on other operating systems.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Preparation"></a>Preparation</h2>
-
-<div class="section">
+ <section>
<h3><a name="Select_a_Release_Manager"></a>Select a Release Manager</h3>
<p>
@@ -277,10 +261,9 @@
Typically, the proposer volunteers as the release manager and it passes by
<a class="externalLink" href="http://www.apache.org/foundation/glossary.html#LazyConsensus">lazy consensus</a>.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Update_KEYS_file_if_necessary"></a>Update KEYS file if necessary</h3>
<p>
@@ -301,10 +284,9 @@
The public key should also be
<a class="externalLink" href="http://www.apache.org/dev/release-signing.html#keyserver-upload">uploaded to a public keyserver</a>.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Create_a_Release_Plan"></a>Create a Release Plan</h3>
<p>
@@ -312,10 +294,9 @@
the release are listed. It may be useful to prepare draft release notes before proposing
the release, so that others can see what changes are expected for the new release.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Using_a_Release_Branch"></a>Using a Release Branch</h3>
<p>
@@ -379,9 +360,8 @@
<pre>
git checkout -b release
</pre></div>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Check_Compatibility"></a>Check Compatibility</h3>
<p>
@@ -391,11 +371,10 @@
<a class="externalLink" href="http://clirr.sourceforge.net">Clirr</a>,
<a class="externalLink" href="http://www.jdiff.org">JDiff</a>, and <a class="externalLink" href="http://siom79.github.io/japicmp/">japicmp</a>
are very useful, and support Apache Maven (Clirr and JDiff support Apache Ant as well;
- japicmp could be invoked using Ant's <tt>java</tt> task).
+ japicmp could be invoked using Ant's <code>java</code> task).
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Check_Dependencies"></a>Check Dependencies</h3>
<p>
@@ -411,13 +390,12 @@
mvn versions:display-plugin-updates -U</pre></div>
Before updating a dependency version, check that it is suitable for the version of Java used by the component
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Check_Javadocs_And_Code_Style"></a>Check Javadocs And Code Style</h3>
<p>
- Ensure all new classes and methods have <tt>@since</tt> tags.
+ Ensure all new classes and methods have <code>@since</code> tags.
Compatibility reports produced in the last section may prove helpful.
</p>
@@ -452,9 +430,8 @@ mvn versions:display-plugin-updates -U</
If the component uses checkstyle, findbugs or PMD tools, examine the reports and fix all
problems.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Configure_the_Build_and_Release_Plugin_to_Generate_a_Complete_Set_of_Release_Artifacts"></a>Configure the Build and Release Plugin to Generate a Complete Set of Release Artifacts</h3>
<p>
@@ -470,7 +447,7 @@ mvn versions:display-plugin-updates -U</
<p>
Update the version numbers in pom.xml and build.xml to the new release version, in this example, 1.2.
- For Maven builds, make sure that the build properties are properly set. Review the <tt>properties</tt>
+ For Maven builds, make sure that the build properties are properly set. Review the <code>properties</code>
section of the pom:
</p>
<div>
@@ -498,7 +475,7 @@ mvn versions:display-plugin-updates -U</
<project.build.sourceEncoding>${commons.encoding}</project.build.sourceEncoding>
<!-- This is used by reporting plugins -->
<project.reporting.outputEncoding>${commons.encoding}</project.reporting.outputEncoding>
- <!-- Commons Release Plugin -->
+
<commons.bc.version>1.5</commons.bc.version>
<commons.release-plugin.version>1.4</commons.release-plugin.version>
<commons.release.isDistModule>true</commons.release.isDistModule>
@@ -525,8 +502,8 @@ mvn versions:display-plugin-updates -U</
git commit -am "Updated download page in preparation for 1.2 release." src/site/xdoc/download_foo.xml
</pre></div>
- Note that the target directory must exist beforehand, and that for a multi-module project the <tt>-N</tt>
- (non-recursive) parameter should be specified on the <tt>mvn</tt> command line.
+ Note that the target directory must exist beforehand, and that for a multi-module project the <code>-N</code>
+ (non-recursive) parameter should be specified on the <code>mvn</code> command line.
The release version can be overridden with -Dcommons.release.version=m.n if you want to create the new file
without updating the pom (e.g. before creating the tag)
@@ -546,7 +523,7 @@ mvn versions:display-plugin-updates -U</
<li> The jar manifests include LICENSE and NOTICE files and the contents of these files are correct.</li>
-<li> The jar manifests contain <tt>X-Compile-Source-JDK</tt> and <tt>X-Compile-Target-JDK</tt>
+<li> The jar manifests contain <code>X-Compile-Source-JDK</code> and <code>X-Compile-Target-JDK</code>
entries set to the correct values. </li>
<li> The jar manifests include correctly set OSGi bundle properties (ask for help verifying these on
@@ -575,17 +552,15 @@ mvn versions:display-plugin-updates -U</
<p>
- (*) The default configuration of the build will use the name of the current logged in user as value for the <tt>Built-By</tt> MANIFEST header. Use <tt>-Duser.name=<your apache ID></tt> to change this.
+ (*) The default configuration of the build will use the name of the current logged in user as value for the <code>Built-By</code> MANIFEST header. Use <code>-Duser.name=<your apache ID></code> to change this.
</p>
- </div>
- </div>
+ </section>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Creating_a_Release_Candidate"></a>Creating a Release Candidate</h2>
-
-<div class="section">
+ <section>
<h3><a name="Resolve_Bugs"></a>Resolve Bugs</h3>
<p>
@@ -595,21 +570,20 @@ mvn versions:display-plugin-updates -U</
<li>fixing</li>
-<li>marking them as <tt>INVALID</tt> or <tt>WONTFIX</tt></li>
+<li>marking them as <code>INVALID</code> or <code>WONTFIX</code></li>
<li>changing their fix version to another unreleased version</li>
</ul>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Check_the_commit_log"></a>Check the commit log</h3>
<p>
Different components have their own ways of creating the change log.
The most common, and recommended, way, is to record all significant
changes in JIRA tickets and include entries in the Maven change-log
- file, <tt>changes.xml</tt>. If your component has a change-log you
+ file, <code>changes.xml</code>. If your component has a change-log you
can skip this step.</p>
<p>Here's a way to get the information directly from svn if no change log
@@ -674,9 +648,8 @@ mvn versions:display-plugin-updates -U</
So while dates are reported correctly in "svn log" output, only revision numbers should
be used with the -r option. See issue #752 in the subversion issue tracker at tigris.org.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Prepare_Release_Notes"></a>Prepare Release Notes</h3>
<p>
@@ -711,16 +684,16 @@ mvn versions:display-plugin-updates -U</
<p>The commons parent project ships with a
<a class="externalLink" href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/src/changes/release-notes.vm">default
template</a>. If you want to configure your own you need to set
- the following property in the <tt>configuration</tt>
+ the following property in the <code>configuration</code>
for the maven-changes-plugin in the pom:
</p>
<div>
<pre>
<template>foo-release-notes.vm</template>
</pre></div>
- and the Velocity template, <tt>foo-release-notes.vm</tt> needs to be defined in
- <tt>src/changes</tt>. If you want to put it into a different directory
- you also want to set the <tt>templateDirectory</tt> property.
+ and the Velocity template, <code>foo-release-notes.vm</code> needs to be defined in
+ <code>src/changes</code>. If you want to put it into a different directory
+ you also want to set the <code>templateDirectory</code> property.
<p>
The release notes should be a plain text file. Take care to ensure
@@ -728,33 +701,31 @@ mvn versions:display-plugin-updates -U</
Long lines may need to be broken manually to allow them to be easily
read easily without word wrap.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Test_Against_Listed_Dependencies"></a>Test Against Listed Dependencies</h3>
<p>
If you are using Maven to execute the unit tests associated with the component then
there is nothing to do here; Maven will automatically perform the tests using the
- library versions specified in the <tt>pom.xml</tt> file.
+ library versions specified in the <code>pom.xml</code> file.
</p>
<p>
It's also vital to ensure that you test against the correct version of the Java libraries.
- If Maven requires a later version of Java, then use the appropriate <tt>java-1.x</tt> profile.
+ If Maven requires a later version of Java, then use the appropriate <code>java-1.x</code> profile.
See <a href="../commons-parent-pom.html#Testing_with_different_Java_versions">Testing with different Java versions</a>
for further details.
</p>
<p>
- If you are using Ant to execute unit tests, then ensure the Ant <tt>build.xml</tt> file
- references the same library versions as are listed as dependencies in the <tt>pom.xml</tt>
+ If you are using Ant to execute unit tests, then ensure the Ant <code>build.xml</code> file
+ references the same library versions as are listed as dependencies in the <code>pom.xml</code>
file then execute the unit tests.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Check_the_Apache_License"></a>Check the Apache License</h3>
<p>
@@ -788,7 +759,7 @@ mvn versions:display-plugin-updates -U</
</p>
<p>
- <tt><a class="externalLink" href="http://www.apache.org/legal/src-headers.html#headers">http://www.apache.org/legal/src-headers.html#headers</a></tt>
+ <code><a class="externalLink" href="http://www.apache.org/legal/src-headers.html#headers">http://www.apache.org/legal/src-headers.html#headers</a></code>
</p>
<p>
@@ -802,29 +773,27 @@ mvn versions:display-plugin-updates -U</
</p>
<p>
- <tt><a class="externalLink" href="http://www.apache.org/licenses/example-NOTICE.txt">http://www.apache.org/licenses/example-NOTICE.txt</a></tt>
+ <code><a class="externalLink" href="http://www.apache.org/licenses/example-NOTICE.txt">http://www.apache.org/licenses/example-NOTICE.txt</a></code>
</p>
<p>
for an example that provides all of the notices applicable to the
httpd-2.0 distribution.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Update_the_download_xml_file"></a>Update the download xml file</h3>
<p>
- The download page on the website is created from the file <tt>src/site/xdoc/download_{component}.xml</tt>.
+ The download page on the website is created from the file <code>src/site/xdoc/download_{component}.xml</code>.
The XML file is created using
- <tt>mvn commons-build:download-page [-Dcommons.release.version=m.n]</tt>.
+ <code>mvn commons-build:download-page [-Dcommons.release.version=m.n]</code>.
Check that the changes (if any) are correct and commit the updated file.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Update_the_other_autogenerated_files"></a>Update the other autogenerated files</h3>
<p>
@@ -832,20 +801,19 @@ mvn versions:display-plugin-updates -U</
</p>
<ul>
-<li>CONTRIBUTING.md - <tt>mvn commons-build:contributing-md</tt></li>
+<li>CONTRIBUTING.md - <code>mvn commons-build:contributing-md</code></li>
-<li>README.md - <tt>mvn commons-build:readme-md</tt></li>
+<li>README.md - <code>mvn commons-build:readme-md</code></li>
-<li>src/site/xdoc/issue-tracking.xml - <tt>mvn commons-build:jira-page</tt></li>
+<li>src/site/xdoc/issue-tracking.xml - <code>mvn commons-build:jira-page</code></li>
-<li>src/site/xdoc/mail-lists.xml - <tt>mvn commons-build:mail-page</tt></li>
+<li>src/site/xdoc/mail-lists.xml - <code>mvn commons-build:mail-page</code></li>
</ul>
Check that the changes (if any) are correct and commit the updated file(s).
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Check_NOTICE.txt"></a>Check NOTICE.txt</h3>
<p>
@@ -863,16 +831,15 @@ mvn versions:display-plugin-updates -U</
The Apache Software Foundation (http://www.apache.org/).
</pre></div>
-<p>Verify <tt>{latest}</tt> is the current year.</p>
+<p>Verify <code>{latest}</code> is the current year.</p>
<p>
The NOTICE.txt must be distributed along with the LICENSE.txt.
Check that the distribution build correctly adds this file
to the distributions and that the copyright start and end dates are correct.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Tag_the_Release_Candidate"></a>Tag the Release Candidate</h3>
<p>
@@ -883,7 +850,7 @@ mvn versions:display-plugin-updates -U</
<p>
Make sure that the build version number corresponds to the release version. For example,
- <tt>commons-foo-1.2</tt>. What you are preparing at this point is a candidate for release,
+ <code>commons-foo-1.2</code>. What you are preparing at this point is a candidate for release,
which we will vote on and then push directly to the mirrors. Clean build, run the unit tests
and check that the javadocs have the correct version number. Check in all changes.
</p>
@@ -893,8 +860,7 @@ mvn versions:display-plugin-updates -U</
you can either use the Maven release plugin or create the tag manually. In either case, record
the svn revision number, you'll need it for the release vote mail.</p>
-
-<div class="section">
+ <section>
<h4><a name="Tag_Name_Convention"></a>Tag Name Convention<a name="Tag_Name_convention"></a></h4>
<p>
@@ -907,20 +873,18 @@ mvn versions:display-plugin-updates -U</
</pre></div>
<p>
- where the <tt>name</tt> is the identifier of the component prefixed with <tt>commons-</tt>,
- <tt>x.y[.z]</tt> is the version number,
- the <tt>beta</tt> qualifier indicates a release that has no backwards compatibility requirements,
- <tt>m</tt> is an integer indicating how many beta releases were created towards the upcoming version,
- and <tt>n</tt> is an integer indicating how many releases candidates have been created.
+ where the <code>name</code> is the identifier of the component prefixed with <code>commons-</code>,
+ <code>x.y[.z]</code> is the version number,
+ the <code>beta</code> qualifier indicates a release that has no backwards compatibility requirements,
+ <code>m</code> is an integer indicating how many beta releases were created towards the upcoming version,
+ and <code>n</code> is an integer indicating how many releases candidates have been created.
</p>
- </div>
-<div class="section">
+ </section><section>
<h4>Manual Method<a name="Manual_Method"></a></h4>
-
-<div class="section">
-<h5>Manual Method (SVN)<a name="Manual_Method_SVN"></a></h5>
+ <section>
+<h5><a name="Manual_Method_.28SVN.29"></a>Manual Method (SVN)<a name="Manual_Method_SVN"></a></h5>
<p>Create a clean SVN workspace for the release candidate:</p>
@@ -942,7 +906,7 @@ mvn versions:display-plugin-updates -U</
<p>Edit the SCM entries in the POM. Note: use the final tag, without any RC suffix.
- Do <tt>svn diff</tt> and <tt>svn status</tt> to check that the changes are OK.
+ Do <code>svn diff</code> and <code>svn status</code> to check that the changes are OK.
These should only show changes to the POMs.</p>
@@ -967,9 +931,8 @@ mvn versions:display-plugin-updates -U</
Also, by leaving trunk unchanged, nothing needs to be reverted if the RC vote fails and the Rc needs to be re-rolled.
</p>
- </div>
-<div class="section">
-<h5>Manual Method (Git)<a name="Manual_Method_Git"></a></h5>
+ </section><section>
+<h5><a name="Manual_Method_.28Git.29"></a>Manual Method (Git)<a name="Manual_Method_Git"></a></h5>
<p>
@@ -993,8 +956,7 @@ mvn versions:display-plugin-updates -U</
git push -u origin/release
</pre></div>
- </div></div>
-<div class="section">
+ </section></section><section>
<h4>Maven Release Plugin<a name="Maven_Release_Plugin"></a></h4>
<p>When using the release plugin, please verify that your poms will not lose content when they are rewritten during the
@@ -1009,14 +971,14 @@ mvn versions:display-plugin-updates -U</
</pre></div>
-<p>Diff the original file <tt>pom.xml</tt> with the one called <tt>pom.xml.tag</tt> to see if the license or
- any other info has been removed. This has been known to happen if the starting <tt><project></tt> tag
- is not on a single line. The only things that should be different between these files are the <tt><version></tt>
- and <tt><scm></tt> elements. Any other changes, you must backport yourself to the original
- <tt>pom.xml</tt> file and commit before proceeding with the release.</p>
+<p>Diff the original file <code>pom.xml</code> with the one called <code>pom.xml.tag</code> to see if the license or
+ any other info has been removed. This has been known to happen if the starting <code><project></code> tag
+ is not on a single line. The only things that should be different between these files are the <code><version></code>
+ and <code><scm></code> elements. Any other changes, you must backport yourself to the original
+ <code>pom.xml</code> file and commit before proceeding with the release.</p>
-<p>Remember to do <tt>mvn release:clean</tt> before you start the real release process.
+<p>Remember to do <code>mvn release:clean</code> before you start the real release process.
If everything is ok, run:</p>
<div>
@@ -1033,16 +995,15 @@ mvn versions:display-plugin-updates -U</
<i>TODO:</i> Does the Maven Release plugin work with git?
- </div></div>
+ </section></section>
-
-<div class="section">
+ <section>
<h3><a name="Create_the_Release_Candidate_with_the_Commons_Release_Plugin."></a>Create the Release Candidate with the Commons Release Plugin.</h3>
The <a href="commons-release-plugin/index.html">Commons Release Plugin</a>, as of
commons-parent-46 is included but disabled. Note, as of version 1.2 of the plugin and version
46 of the parent, we have throughly tested single module builds, but multi-module builds remain
an open problem (which may work, but at the time of writing have not been fully vetted). To
- enable the plugin, one needs to configure the <tt>properties</tt> section of the pom as follows:
+ enable the plugin, one needs to configure the <code>properties</code> section of the pom as follows:
<div>
<pre class="prettyprint">
@@ -1050,20 +1011,20 @@ mvn versions:display-plugin-updates -U</
<commons.release.isDistModule>true</commons.release.isDistModule>
<commons.distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</commons.distSvnStagingUrl>
</properties></pre></div>
- where <tt>foo</tt> represents our component. Furthermore, during a release build, we ask that the svn
+ where <code>foo</code> represents our component. Furthermore, during a release build, we ask that the svn
folder be empty. We then generate our release build by runnning:
<div>
<pre>
mvn -Duser.name=${my_apache_id} -Prelease -Ptest-deploy clean package site deploy</pre></div>
to test our deployment. Note, all of the staged items end up in
- <tt>target/commons-release-plugin/scm</tt>. And, to perform a full release, we run:
+ <code>target/commons-release-plugin/scm</code>. And, to perform a full release, we run:
<div>
<pre>
mvn -Duser.name=${my_apache_id} -Prelease clean package site deploy</pre></div>
Using the release plugin should build and stage the non-assembly built artifacts to Nexus, and stage
- the assemblies to the svn location along with the site and the <tt>RELEASE-NOTES.txt</tt> from the
+ the assemblies to the svn location along with the site and the <code>RELEASE-NOTES.txt</code> from the
root of the project.
After finishing the build you will need to "close" the staging repository in the
@@ -1075,12 +1036,11 @@ mvn versions:display-plugin-updates -U</
<div>
<pre>mvn -Prelease org.apache.commons:commons-release-plugin:1.4:vote-txt</pre></div>
- This will generate a file <tt>target/vote.txt</tt> that will need to be altered for the vote email, but it
+ This will generate a file <code>target/vote.txt</code> that will need to be altered for the vote email, but it
gives you a considerable head start on writing the email.
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Create_the_Release_Candidate_Manually"></a>Create the Release Candidate Manually</h3>
@@ -1088,7 +1048,7 @@ mvn versions:display-plugin-updates -U</
Build distributions from a fresh checkout of the RC tag.
Build the code with the target version of Java if possible.<br />
If the version of Maven you are using requires a more recent version of Java than the code you are
- building, then use the appropriate <tt>java-1.x</tt> profile to ensure that compilation and testing is done
+ building, then use the appropriate <code>java-1.x</code> profile to ensure that compilation and testing is done
with the correct Java version. This will catch any accidental use of methods etc. that are not in
the target Java version libraries.
See <a href="../commons-parent-pom.html#Testing_with_different_Java_versions">Testing with different Java versions</a>
@@ -1112,27 +1072,27 @@ mvn versions:display-plugin-updates -U</
The "test-deploy" profile uploads the artifacts to target/deploy instead of Nexus so one can check all the required files
have been created with the expected contents.
Best to run "mvn clean" before doing the live deployment.
- Again remember to use <tt>-Duser.name=<your apache ID></tt> to make sure the <tt>Built-By</tt> MANIFEST header is correct.
+ Again remember to use <code>-Duser.name=<your apache ID></code> to make sure the <code>Built-By</code> MANIFEST header is correct.
<p>This will PGP-sign all artifacts and upload them to a new staging repository, Nexus itself will create MD5
and SHA1 checksums for all files that have been uploaded.</p>
<p>A known problem is that gpg signing may fail if the gpg plugin tries to read the passphrase interactively.
- It works if you specify the passphrase when invoking mvn (<tt>-Dgpg.passphrase=***</tt>)
+ It works if you specify the passphrase when invoking mvn (<code>-Dgpg.passphrase=***</code>)
-- this is not recommended as it may expose the plain password in process lists or shell history files --
- or run <tt>gpg-agent</tt> before starting mvn.</p>
+ or run <code>gpg-agent</code> before starting mvn.</p>
<p>Version 1.6 of the GPG plugin supports storage of the password using
<a class="externalLink" href="http://maven.apache.org/plugins/maven-gpg-plugin/sign-mojo.html#passphraseServerId">Maven password encryption</a>
- This uses the server id of <tt>gpg.passphrase</tt> by default.
+ This uses the server id of <code>gpg.passphrase</code> by default.
However Maven encryption is not inherently safe unless the master password is secured in some way.
For example by storing the security.xml file in a password-protected OS file or on removable storage.
Note that recovering from a compromised GPG key is not easy, so the password needs to be very carefully guarded.
</p>
<p>Unfortunately this uploads more than should be part of the Maven repository, in particular the binary and source
- distribution <tt>.tar.gz</tt> and <tt>.zip</tt> files are there as well. Before you
+ distribution <code>.tar.gz</code> and <code>.zip</code> files are there as well. Before you
<a class="externalLink" href="http://www.apache.org/dev/publishing-maven-artifacts.html#close-stage">close</a> the staging
repository you must remove the tarballs/zips together with their PGP signatures and checksums using
the Nexus web interface. While
@@ -1154,9 +1114,9 @@ mvn versions:display-plugin-updates -U</
svn mkdir -m "Creating initial directory structure for foo" https://dist.apache.org/repos/dist/dev/commons/foo
</pre></div>
-<p>Then check out <tt>https://dist.apache.org/repos/dist/dev/commons/foo</tt> and copy the tarballs, checksums and
+<p>Then check out <code>https://dist.apache.org/repos/dist/dev/commons/foo</code> and copy the tarballs, checksums and
PGP signatures to the appropriate directories. You can find those artifacts inside your local Maven repository.
- The procedure will be something like (where <tt>release_path</tt> points to your working copy of the dist repository):</p>
+ The procedure will be something like (where <code>release_path</code> points to your working copy of the dist repository):</p>
<div>
<pre>
@@ -1171,13 +1131,12 @@ mvn versions:display-plugin-updates -U</
cp RELEASE-NOTES.txt ${release_path}/FOO_1_2_RC1
</pre></div>
-<p><tt>svn add</tt> the files and commit them. Again, record the revision number for the vote email.</p>
+<p><code>svn add</code> the files and commit them. Again, record the revision number for the vote email.</p>
There is a script which can be used to do all of this at:
<a class="externalLink" href="https://svn.apache.org/repos/asf/commons/scripts/Nexus2DistDev.sh">https://svn.apache.org/repos/asf/commons/scripts/Nexus2DistDev.sh</a>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Create_the_Release_Candidate_Website"></a>Create the Release Candidate Website</h3>
<p>
@@ -1190,7 +1149,7 @@ mvn versions:display-plugin-updates -U</
</pre></div>
The optional "jacoco" and "cobertura" profiles are used to select the appropriate code coverage tool if required.
Then tar or zip the site in target/site and scp and unpack the files
- on people.apache.org in a directory <tt>~/public_html/foo-1.2-RC1</tt>.
+ on people.apache.org in a directory <code>~/public_html/foo-1.2-RC1</code>.
<p>
@@ -1198,30 +1157,27 @@ mvn versions:display-plugin-updates -U</
URLs; following these will lead to the currently published site, not to the
equivalent page on the new site being evaluated.
</p>
- </div>
- </div>
+ </section>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Voting_On_Release"></a>Voting On Release</h2>
-
-<div class="section">
+ <section>
<h3><a name="Using_commons-release-plugin"></a>Using commons-release-plugin</h3>
The vote email should have been mostly generated for you by the plugin. See the section above pertaining
to the commons-release-plugin for more details.
- </div>
+ </section>
-
-<div class="section">
-<h3><a name="aVOTE_Release_Foo_1.2_based_on_RC1"></a>[VOTE] Release Foo 1.2 based on RC1</h3>
+ <section>
+<h3><a name="a.5BVOTE.5D_Release_Foo_1.2_based_on_RC1"></a>[VOTE] Release Foo 1.2 based on RC1</h3>
<p>
Once the release candidate has been created and uploaded, now it's time to propose the release VOTE.
</p>
<p>
- Post a <tt>[VOTE] Release Foo 1.2 based on RC1</tt> email to <b>dev@commons.apache.org</b>.
+ Post a <code>[VOTE] Release Foo 1.2 based on RC1</code> email to <b>dev@commons.apache.org</b>.
This should include links to minimally the distributions, site, tag and KEYS.
Also the revisions for the various tags, and hashes for the release artifacts
Here is an example release VOTE message body:
@@ -1294,7 +1250,7 @@ Lucky RM </pre></div>
<p>
Votes from members of the Commons PMC are binding, however votes from other committers, users and
contributors are welcomed.
- If the <tt>[VOTE]</tt> is successful then continue. Release VOTEs should be left open for a
+ If the <code>[VOTE]</code> is successful then continue. Release VOTEs should be left open for a
minimum of 72 hours so community members have ample opportunity to download, review and test the
release candidate. It is a good practice to, as above, specify the closing time of the VOTE in
the VOTE message.
@@ -1310,7 +1266,7 @@ Lucky RM </pre></div>
</p>
<p>
- Once a vote is successful, post a <tt>[RESULT] Release Foo 1.2</tt> email to
+ Once a vote is successful, post a <code>[RESULT] Release Foo 1.2</code> email to
<b>dev@commons.apache.org</b> as a reply to the original posting.
This email should contain a summary of the voters/votes that were cast, eg
</p>
@@ -1326,7 +1282,7 @@ Lucky RM </pre></div>
<p>
Note that binding the VOTEs recorded need to be clearly designated in the RESULT.
This may be done by either stating only the binding votes (and indicating that to be the case)
- or by adding <tt>(non-binding)</tt> to those which are not.
+ or by adding <code>(non-binding)</code> to those which are not.
It is best practice to indicate how each person voted.
This allows any mistakes to be caught and corrected early.
If you do vote, please check the results to ensure that your vote has been correctly tallied.
@@ -1337,42 +1293,39 @@ Lucky RM </pre></div>
and hash files included with the release artifacts. If no one specifically mentions having done that during
the VOTE, ask on the dev list and make sure someone does this before you proceed with the release.
</p>
- </div>
- </div>
+ </section>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Things_To_Look_For_When_Inspecting_A_Release_Candidate"></a>Things To Look For When Inspecting A Release Candidate</h2>
<p>
There are a number of common things that releases fail on.
</p>
-
-<div class="section">
+ <section>
<h3><a name="Downloads"></a>Downloads</h3>
<p>Check the validity of what you download:</p>
<ul>
-<li>Verify the ASC file with <tt>gpg --verify FILE.asc</tt></li>
+<li>Verify the ASC file with <code>gpg --verify FILE.asc</code></li>
</ul>
<p>There should be at least one SHA file:</p>
<ul>
-<li>Verify the SHA-1 file if any with <tt>sha1sum FILE.zip/gz</tt> and compare with the actual <tt>FILE.zip/gz.sha1</tt> file</li>
+<li>Verify the SHA-1 file if any with <code>sha1sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha1</code> file</li>
-<li>Verify the SHA-256 file if any with <tt>sha256sum FILE.zip/gz</tt> and compare with the actual <tt>FILE.zip/gz.sha256</tt> file</li>
+<li>Verify the SHA-256 file if any with <code>sha256sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha256</code> file</li>
-<li>Verify the SHA-512 file if any with <tt>sha256sum FILE.zip/gz</tt> and compare with the actual <tt>FILE.zip/gz.sha512</tt> file</li>
+<li>Verify the SHA-512 file if any with <code>sha256sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha512</code> file</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Licensing"></a>Licensing</h3>
<ul>
@@ -1381,17 +1334,16 @@ Lucky RM </pre></div>
<li>In NOTICE.txt, the end year of the copright notice is the current year.</li>
-<li>Check the <a class="externalLink" href="http://creadur.apache.org/rat/apache-rat-plugin/">RAT</a> report or run it with <tt>mvn apache-rat:check</tt></li>
+<li>Check the <a class="externalLink" href="http://creadur.apache.org/rat/apache-rat-plugin/">RAT</a> report or run it with <code>mvn apache-rat:check</code></li>
</ul>
<p>
Maven builds default to including this, so no further effort is required
for those projects.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="API_Changes"></a>API Changes</h3>
<p>
@@ -1401,14 +1353,13 @@ Lucky RM </pre></div>
<ul>
-<li>You can check the site's <a class="externalLink" href="http://www.mojohaus.org/clirr-maven-plugin/">Clirr</a> report or run it yourself with <tt>mvn clirr:check</tt></li>
+<li>You can check the site's <a class="externalLink" href="http://www.mojohaus.org/clirr-maven-plugin/">Clirr</a> report or run it yourself with <code>mvn clirr:check</code></li>
-<li>You can check the site's <a class="externalLink" href="https://github.com/siom79/japicmp">Japicmp</a> report or run it yourself with <tt>mvn japicmp:cmp</tt></li>
+<li>You can check the site's <a class="externalLink" href="https://github.com/siom79/japicmp">Japicmp</a> report or run it yourself with <code>mvn japicmp:cmp</code></li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Javadoc"></a>Javadoc</h3>
<ul>
@@ -1417,20 +1368,18 @@ Lucky RM </pre></div>
<li>Ensure that all new classes and methods have appropriate @since Javadoc tags.</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Code_Style"></a>Code Style</h3>
<p>
Many projects enforce coding styles using the CheckStyle or PMD tools. If your
project does this, don't forget to check the output and fix any problems.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Class_File_Format"></a>Class File Format</h3>
<a name="classfileformat"></a>
@@ -1449,8 +1398,8 @@ Lucky RM </pre></div>
<p>
The Maven build has been modified to include two <b><i>non standard</i></b> attributes
- in the jar's manifest to indicate the <tt>maven.compile.source</tt> and
- <tt>maven.compile.target</tt> properties used to create the jar. This serves two purposes:
+ in the jar's manifest to indicate the <code>maven.compile.source</code> and
+ <code>maven.compile.target</code> properties used to create the jar. This serves two purposes:
</p>
<ul>
@@ -1468,27 +1417,24 @@ Lucky RM </pre></div>
X-Compile-Target-JDK: 1.3
</pre></div>
These values should be checked to ensure that the release has been built for the appropriate JVM.
- If they are not present or no values are specified then the <tt>Build-Jdk</tt> entry should
+ If they are not present or no values are specified then the <code>Build-Jdk</code> entry should
be checked to ensure the release has been built with the appropriate JDK.
- </div>
+ </section>
- </div>
+ </section>
-
-<div class="section">
-<h2><a name="What_next"></a>What next?</h2>
-
-<div class="section">
+ <section>
+<h2><a name="What_next.3F"></a>What next?</h2>
+ <section>
<h3><a name="Vote_succeeded"></a>Vote succeeded</h3>
<p>
If the vote succeeded, please see the page <a href="release.html">Publishing the Release</a>
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="Vote_failed"></a>Vote failed</h3>
<p>
@@ -1504,11 +1450,10 @@ Lucky RM </pre></div>
</ul>
If a new RC is to be created, restart the process as described above.
- </div>
- </div>
+ </section>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Feedback"></a>Feedback</h2>
<p>
@@ -1519,7 +1464,7 @@ Lucky RM </pre></div>
Comments, critiques and error reports -
post them any and all to the dev mailing list at commons.apache.org. Please prefix with [doc].
</p>
- </div>
+ </section>
</td>
@@ -1531,7 +1476,7 @@ Lucky RM </pre></div>
<p>Copyright © 2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
-
+ <?xml version="1.0" encoding="UTF-8"?>
<div class="center">Apache Commons, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
Modified: websites/staging/commons/trunk/content/releases/publish-site.html
==============================================================================
--- websites/staging/commons/trunk/content/releases/publish-site.html (original)
+++ websites/staging/commons/trunk/content/releases/publish-site.html Fri Aug 7 12:14:11 2020
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 26 July 2020
+ | Generated by Apache Maven Doxia at 07 August 2020
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -8,7 +8,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20200726" />
+ <meta name="Date-Revision-yyyymmdd" content="20200807" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Commons – Publishing The Site</title>
@@ -25,7 +25,7 @@
</head>
<body class="composite">
- <a href=".././" id="bannerLeft" title="Apache Commons logo">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
<img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
</a>
<div class="clear"></div>
@@ -33,11 +33,11 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
- <a class="brand" href="http://commons.apache.org/">Apache Commons ™</a>
+ <a class="brand" href="https://commons.apache.org/">Apache Commons ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 26 July 2020</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 19</li>
+ <li id="publishDate">Last Published: 07 August 2020</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 23</li>
</ul>
<div class="pull-right"> <ul class="nav">
<li>
@@ -86,7 +86,7 @@
Mailing Lists</a>
</li>
<li class="none">
- <a href="../team-list.html" title="PMC">
+ <a href="../team.html" title="PMC">
PMC</a>
</li>
<li class="collapsed">
@@ -205,30 +205,17 @@
</div>
</td>
<td class="content">
- <!-- 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. -->
+
-<div class="section">
+<section>
<h2><a name="Publishing_The_Website"></a>Publishing The Website</h2>
<p>
<b>Due to the use of svnpubsub system please refer to pages located here <a href="../site-publish.html">../site-publish.html</a></b>
</p>
-</div>
+</section>
@@ -241,7 +228,7 @@
<p>Copyright © 2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
-
+ <?xml version="1.0" encoding="UTF-8"?>
<div class="center">Apache Commons, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
Modified: websites/staging/commons/trunk/content/releases/release.html
==============================================================================
--- websites/staging/commons/trunk/content/releases/release.html (original)
+++ websites/staging/commons/trunk/content/releases/release.html Fri Aug 7 12:14:11 2020
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 26 July 2020
+ | Generated by Apache Maven Doxia at 07 August 2020
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -8,7 +8,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20200726" />
+ <meta name="Date-Revision-yyyymmdd" content="20200807" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Commons – Publishing The Release</title>
@@ -25,7 +25,7 @@
</head>
<body class="composite">
- <a href=".././" id="bannerLeft" title="Apache Commons logo">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
<img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
</a>
<div class="clear"></div>
@@ -33,11 +33,11 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
- <a class="brand" href="http://commons.apache.org/">Apache Commons ™</a>
+ <a class="brand" href="https://commons.apache.org/">Apache Commons ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 26 July 2020</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 19</li>
+ <li id="publishDate">Last Published: 07 August 2020</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 23</li>
</ul>
<div class="pull-right"> <ul class="nav">
<li>
@@ -86,7 +86,7 @@
Mailing Lists</a>
</li>
<li class="none">
- <a href="../team-list.html" title="PMC">
+ <a href="../team.html" title="PMC">
PMC</a>
</li>
<li class="collapsed">
@@ -205,37 +205,23 @@
</div>
</td>
<td class="content">
- <!-- 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. -->
+
-<div class="section">
+<section>
<h2><a name="Publishing_The_Release_-_Step_By_Step"></a>Publishing The Release - Step By Step</h2>
-
-<div class="section">
+ <section>
<h3><a name="Introduction"></a>Introduction</h3>
<p>
This document gives step-by-step instructions for publishing a release. These instructions
- assume that the component uses <tt>Maven</tt> to build the site.
+ assume that the component uses <code>Maven</code> to build the site.
</p>
<p>
The starting point for this document is that a release candidate has been created and a
- <tt>[VOTE]</tt> successfully passed. Guidelines for these preparations can be
+ <code>[VOTE]</code> successfully passed. Guidelines for these preparations can be
found <a href="prepare.html">here</a>.
</p>
@@ -255,20 +241,19 @@
</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a1_Move_Releases_Into_Distribution_Directories"></a>1 Move Releases Into Distribution Directories</h3>
<p>
The distribution area of commons releases is populated from
<a class="externalLink" href="https://dist.apache.org/repos/dist/release/commons/">https://dist.apache.org/repos/dist/release/commons/</a>
via svnpubsub. In order to publish the release, you must move the distributions files
- from <tt>dev</tt> to <tt>release</tt>.
+ from <code>dev</code> to <code>release</code>.
</p>
-<p>You can perform multiple <tt>svn mv</tt> operations (with or without local
+<p>You can perform multiple <code>svn mv</code> operations (with or without local
working copies) or you can use <a class="externalLink" href="http://svnbook.red-bean.com/en/1.8/svn.ref.svnmucc.re.html">svnmucc</a>,
for example:</p>
@@ -295,15 +280,14 @@
mv dev/commons/foo/source/commons-foo-1.2-src.zip.sha1 release/commons/foo/source/commons-foo-1.2-src.zip.sha1 \
-m "Publish commons-foo 1.2 Release"
</pre></div>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a2_Update_Release_Directory"></a>2 Update Release Directory</h3>
<p>
<b>Update README</b><br />
- The contents of the <tt>README.html</tt> are displayed at the bottom of the html
+ The contents of the <code>README.html</code> are displayed at the bottom of the html
showing the directory listing. This document should be updated to reflect the new release.
If this is the first release of the component or if this document is not present, then copy
one from an existing release directory and edit that. The README must be located at
@@ -330,15 +314,14 @@
<p>
<a name="Check_KEYS_file"></a>
<b>Check KEYS file</b><br />
- Check the <tt>KEYS</tt> file located in the main release directory. This should contain all the
+ Check the <code>KEYS</code> file located in the main release directory. This should contain all the
public keys which have been used to sign Commons' releases. Make sure that this file exists and
- that it contains the public key you've used to sign these releases. The <tt>KEYS</tt> file
+ that it contains the public key you've used to sign these releases. The <code>KEYS</code> file
gives instructions on how to do this.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a3_Deploy_Maven_Artifacts"></a>3 Deploy Maven Artifacts</h3>
<p>Login to the <a class="externalLink" href="https://repository.apache.org">Nexus web interface</a>, select your staging
@@ -349,10 +332,9 @@
The files placed here will be mirrored (after some delay) to the public distribution
repository on <a class="externalLink" href="https://repo.maven.apache.org/maven2/">https://repo.maven.apache.org/maven2/</a>.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a4_Create_SCM_Tag_for_the_Final_Release"></a>4 Create SCM Tag for the Final Release</h3>
<p>Copy the release candidate tag in subversion to a name without RC in its name:</p>
@@ -394,15 +376,14 @@
</pre></div>
<p>Make sure, that your release tags follows the naming conventions of the component.</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a5_Test_Main_Site_Downloads"></a>5 Test Main Site Downloads</h3>
<p>
Wait until the release files are available from the main Apache web site
- (<tt>https://www.apache.org/dist/commons/foo/</tt>), then confirm things are good.
+ (<code>https://www.apache.org/dist/commons/foo/</code>), then confirm things are good.
</p>
<p>
@@ -412,19 +393,19 @@
<li>
Examine the directory listing page. At the bottom should be found the information you
- entered into the <tt>README.html</tt>. Please check that this is correct.
+ entered into the <code>README.html</code>. Please check that this is correct.
</li>
<li>
- Check the <tt>KEYS</tt> file
+ Check the <code>KEYS</code> file
</li>
<li>
- Check the <tt>RELEASE-NOTES.txt</tt>
+ Check the <code>RELEASE-NOTES.txt</code>
</li>
<li>Download and verify the current distributions, the following might help
- <tt>committers/tools/releases/verify_sigs.sh</tt>. </li>
+ <code>committers/tools/releases/verify_sigs.sh</code>. </li>
</ol>
@@ -432,18 +413,17 @@
Follow the links to the binaries and source directories.
Check them in a similar manner.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a6_Update_Component_Build_and_Website"></a>6 Update Component Build and Website</h3>
<ul>
<li>
<b>Update trunk version</b>
- Update current version found in <tt>pom.xml</tt> in the trunk if it has not already been done.
- This should be updated to a <tt>SNAPSHOT</tt> release, eg change "1.2" to "1.3-SNAPSHOT". If
+ Update current version found in <code>pom.xml</code> in the trunk if it has not already been done.
+ This should be updated to a <code>SNAPSHOT</code> release, eg change "1.2" to "1.3-SNAPSHOT". If
the component maintains an Ant build and the version is specified in build.xml, make sure to update
this as well.
</li>
@@ -453,10 +433,9 @@
per the instructions <a href="../site-publish.html">here</a>.
</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a7_Create_Announcements"></a>7 Create Announcements</h3>
<p>
@@ -465,7 +444,7 @@
<p>
Please remember to give a brief description of your component. Please also remember to remind people
- about verifying the signatures. The subject should be something like <tt>[ANNOUNCEMENT] Foo 1.2 Released</tt>.
+ about verifying the signatures. The subject should be something like <code>[ANNOUNCEMENT] Foo 1.2 Released</code>.
Send this mail from your Apache account. Please spell check the document!
</p>
@@ -499,10 +478,9 @@
<li>user@commons.apache.org</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a8_Update_Main_Website"></a>8 Update Main Website</h3>
<ul>
@@ -512,10 +490,9 @@
<li><a href="../site-publish.html#Main_site">Stage and publish</a> the main website using the CMS.</li>
</ul>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h3><a name="a9_Post_Release_Cleanup"></a>9 Post Release Cleanup</h3>
<p>
@@ -553,7 +530,7 @@
<li>Ensure that you click the "advanced" search option.</li>
<li>
- In the search field enter <tt>project={component_name (e.g. lang)} AND status=resolved</tt>, replacing
+ In the search field enter <code>project={component_name (e.g. lang)} AND status=resolved</code>, replacing
what we have in the curly braces with the appropriate component name.
</li>
@@ -600,9 +577,9 @@
needs to be added to <a class="externalLink" href="https://reporter.apache.org/addrelease.html?commons">https://reporter.apache.org/addrelease.html?commons</a>
</li>
</ul>
- </div>
+ </section>
-</div>
+</section>
@@ -615,7 +592,7 @@
<p>Copyright © 2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
-
+ <?xml version="1.0" encoding="UTF-8"?>
<div class="center">Apache Commons, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
Modified: websites/staging/commons/trunk/content/releases/versioning.html
==============================================================================
--- websites/staging/commons/trunk/content/releases/versioning.html (original)
+++ websites/staging/commons/trunk/content/releases/versioning.html Fri Aug 7 12:14:11 2020
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 26 July 2020
+ | Generated by Apache Maven Doxia at 07 August 2020
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -10,7 +10,7 @@
<meta name="author" content="Commons Documentation Team" />
<meta name="author" content="Morgan Delagrange" />
<meta name="author" content="Rodney Waldhoff" />
- <meta name="Date-Revision-yyyymmdd" content="20200726" />
+ <meta name="Date-Revision-yyyymmdd" content="20200807" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Commons – Versioning Guidelines</title>
@@ -27,7 +27,7 @@
</head>
<body class="composite">
- <a href=".././" id="bannerLeft" title="Apache Commons logo">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
<img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
</a>
<div class="clear"></div>
@@ -35,11 +35,11 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
- <a class="brand" href="http://commons.apache.org/">Apache Commons ™</a>
+ <a class="brand" href="https://commons.apache.org/">Apache Commons ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 26 July 2020</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 19</li>
+ <li id="publishDate">Last Published: 07 August 2020</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 23</li>
</ul>
<div class="pull-right"> <ul class="nav">
<li>
@@ -88,7 +88,7 @@
Mailing Lists</a>
</li>
<li class="none">
- <a href="../team-list.html" title="PMC">
+ <a href="../team.html" title="PMC">
PMC</a>
</li>
<li class="collapsed">
@@ -207,22 +207,9 @@
</div>
</td>
<td class="content">
- <!-- 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. --><!-- $Id: versioning.xml 1876104 2020-04-03 22:05:06Z ggregory $ -->
+
- <div class="section">
+ <section>
<h2><a name="Overview"></a>Overview</h2>
<p>This document provides:</p>
@@ -247,9 +234,8 @@
incompatibilities to users and developers.
</li>
</ul>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Interface_Types"></a>Interface Types</h2>
<p>
@@ -257,8 +243,7 @@
within a component: <i>external</i>, <i>internal</i>
and <i>private</i>.
</p>
-
-<div class="section">
+ <section>
<h3><a name="The_External_Interface"></a>The External Interface</h3>
<p>
@@ -275,14 +260,13 @@
<p>
The external interface of a component <i>may</i> correspond to
- the <tt>public</tt> scope classes and members, but this is not
- always the case. For example, a <tt>protected</tt> method of a class
+ the <code>public</code> scope classes and members, but this is not
+ always the case. For example, a <code>protected</code> method of a class
designed to be extended by the clients of a component may
be deemed part of the external interface.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="The_Internal_Interface"></a>The Internal Interface</h3>
<p>
@@ -296,25 +280,24 @@
<p>
The internal interface of a component <i>may</i> correspond to
- the <tt>package</tt> and <tt>private</tt> scope classes
+ the <code>package</code> and <code>private</code> scope classes
and members of the component, but this is not always the case.
For example, a component implementation may be split over
- multiple packages and hence require <tt>protected</tt> scope
+ multiple packages and hence require <code>protected</code> scope
members, or may, for design reasons, include an interface
intended primarily for internal use.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="The_Private_Interface"></a>The Private Interface</h3>
<p>
The <i>private</i> interface of a component is just that--the set
of classes, methods and attributes that have "package" or
- <tt>private</tt> scope and hence cannot be used by external clients
+ <code>private</code> scope and hence cannot be used by external clients
by virtue of the Java Language Specification.
</p>
- </div>
+ </section>
<p>
Whenever a class, interface or member is considered part of the
@@ -323,9 +306,8 @@
documentation for the component. (We may want to consider
adding custom JavaDoc tags for this purpose.)
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="Types_of_Change"></a>Types of Change</h2>
<p>
@@ -335,8 +317,7 @@
categories: <i>fully-compatible</i>, <i>interface-compatible</i>,
and <i>external-interface-compatible</i>.
</p>
-
-<div class="section">
+ <section>
<h3><a name="Fully-Compatible_Changes"></a>Fully-Compatible Changes</h3>
<p>
@@ -345,25 +326,25 @@
in (<a href="#note1">nearly</a>) all circumstances
and deployments without changing the client code or
configuration, and without changing the semantics of any
- <tt>public</tt> or <tt>protected</tt> member.
+ <code>public</code> or <code>protected</code> member.
</p>
<p>Examples of fully-compatible changes include:</p>
<ul>
-<li>adding a non-<tt>abstract</tt> method to a class</li>
+<li>adding a non-<code>abstract</code> method to a class</li>
<li>adding a class or interface to a component</li>
<li>
- changing a member from <tt>private</tt> to
- <tt>protected</tt>
+ changing a member from <code>private</code> to
+ <code>protected</code>
</li>
<li>
- changing a <tt>private</tt> attribute to
- a <tt>private</tt> method
+ changing a <code>private</code> attribute to
+ a <code>private</code> method
</li>
<li>
@@ -372,8 +353,8 @@
</li>
<li>
- changing a method or class from <tt>final</tt> to
- non-<tt>final</tt>
+ changing a method or class from <code>final</code> to
+ non-<code>final</code>
</li>
<li>
@@ -400,7 +381,7 @@
</li>
<li>
- changing a <tt>public</tt> or <tt>protected</tt> method signature
+ changing a <code>public</code> or <code>protected</code> method signature
</li>
<li>
@@ -427,9 +408,8 @@
add classes, methods and attributes whose use is optional
to both internal and external interface clients.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Interface-Compatible_Changes"></a>Interface-Compatible Changes</h3>
<p>
@@ -437,8 +417,8 @@
Release <i>A</i> if (<a href="#note1">nearly</a>) all clients
that can be compiled with <i>A</i> in the classpath can
also be compiled with <i>B</i> in the classpath,
- without changing the semantics of any <tt>public</tt> or
- <tt>protected</tt> member. A configuration or
+ without changing the semantics of any <code>public</code> or
+ <code>protected</code> member. A configuration or
classpath change may be required.
</p>
@@ -487,9 +467,8 @@
attributes whose use is optional to both
internal and external interface clients.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="External-Interface-Compatible_Changes"></a>External-Interface-Compatible Changes</h3>
<p>
@@ -560,10 +539,9 @@
optional classes, interfaces or members to the
external interface.
</p>
- </div>
- </div>
-
-<div class="section">
+ </section>
+ </section>
+ <section>
<h2><a name="Release_Types"></a>Release Types</h2>
<p>
@@ -576,8 +554,7 @@
stronger type whenever the nature or scope of the change
warrants it.
</p>
-
-<div class="section">
+ <section>
<h3><a name="Major_Releases"></a>Major Releases</h3>
<p>
@@ -587,9 +564,8 @@
<i>must</i> perform a major release whenever the new release
is not at least interface-compatible with the previous release.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Minor_Releases"></a>Minor Releases</h3>
<p>
@@ -605,9 +581,8 @@
release, it will work with all subsequent minor releases
within that major release.
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Point_Releases"></a>Point Releases</h3>
<p>
@@ -623,9 +598,8 @@
with a given point release, it will work with all
subsequent point releases within that minor release.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Beta_Releases"></a>Beta Releases</h3>
<p>
@@ -648,9 +622,8 @@
released code, "beta" releases are essentially provided
as-is with no guarantees of stability or maintenance.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Milestone_Releases"></a>Milestone Releases</h3>
<p>
@@ -669,22 +642,19 @@
provided as-is with no guarantees of stability or
maintenance.
</p>
- </div>
- </div>
-
-<div class="section">
+ </section>
+ </section>
+ <section>
<h2><a name="Release_Numbers"></a>Release Numbers</h2>
-
-<div class="section">
+ <section>
<h3><a name="Initial_Release_Number"></a>Initial Release Number</h3>
<p>
A component's initial release number is generally
1.0[.0], unless there have been versioned beta releases.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Dissecting_the_Release_Number"></a>Dissecting the Release Number</h3>
<p>
@@ -693,7 +663,7 @@
point release number. Here is a sample release number:
</p>
-<p><tt>2.0.4</tt></p>
+<p><code>2.0.4</code></p>
<p>and it can be broken into three parts:</p>
@@ -719,9 +689,8 @@
not three <i>digits</i>. Hence if the current release is
3.9.4, the next minor release is 3.10.0.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Beta_Release_Numbers"></a>Beta Release Numbers</h3>
<p>
@@ -731,9 +700,8 @@
developer wished to preview the next major release, the
release would be labeled 3.0-beta1.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Milestone_Release_Numbers"></a>Milestone Release Numbers</h3>
<p>
@@ -743,18 +711,16 @@
developer wished to preview the next major release, the
release would be labeled 3.0-M1.
</p>
- </div>
- </div>
-
-<div class="section">
+ </section>
+ </section>
+ <section>
<h2><a name="Development_States"></a>Development States</h2>
<p>
We identify four possible states: "in development", "beta",
"released", and "unsupported".
</p>
-
-<div class="section">
+ <section>
<h3><a name="In_Development_State"></a>In Development State</h3>
<p>
@@ -768,9 +734,8 @@
make the features currently implemented more widely
available for testing in a more stable test version.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Beta_State"></a>Beta State</h3>
<p>
@@ -787,9 +752,8 @@
and go directly to "released", if the component is
sufficiently stable.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Released_State"></a>Released State</h3>
<p>
@@ -801,9 +765,8 @@
when new releases are initiated. The only exception is in
the case of "unsupported" components.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h3><a name="Unsupported_State"></a>Unsupported State</h3>
<p>
@@ -815,10 +778,9 @@
states will simply be terminated after a brief warning
period.
</p>
- </div>
- </div>
-
-<div class="section">
+ </section>
+ </section>
+ <section>
<h2><a name="Comments"></a>Comments</h2>
<p>
@@ -845,9 +807,8 @@
(or 3.0) is released will Bar's developers have to
re-evaluate.
</p>
- </div>
-
-<div class="section">
+ </section>
+ <section>
<h2><a name="End_Notes"></a>End Notes</h2>
<dl>
@@ -865,7 +826,7 @@
their subclass.
</dd>
</dl>
- </div>
+ </section>
</td>
@@ -877,7 +838,7 @@
<p>Copyright © 2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
-
+ <?xml version="1.0" encoding="UTF-8"?>
<div class="center">Apache Commons, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
Modified: websites/staging/commons/trunk/content/sandbox.html
==============================================================================
--- websites/staging/commons/trunk/content/sandbox.html (original)
+++ websites/staging/commons/trunk/content/sandbox.html Fri Aug 7 12:14:11 2020
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 26 July 2020
+ | Generated by Apache Maven Doxia at 07 August 2020
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
@@ -8,7 +8,7 @@
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20200726" />
+ <meta name="Date-Revision-yyyymmdd" content="20200807" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Commons – Sandbox</title>
@@ -25,7 +25,7 @@
</head>
<body class="composite">
- <a href="./" id="bannerLeft" title="Apache Commons logo">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
<img class="logo-left" src="images/commons-logo.png" alt="Apache Commons logo"/>
</a>
<div class="clear"></div>
@@ -33,11 +33,11 @@
<div class="navbar">
<div class="navbar-inner">
<div class="container-fluid">
- <a class="brand" href="http://commons.apache.org/">Apache Commons ™</a>
+ <a class="brand" href="https://commons.apache.org/">Apache Commons ™</a>
<ul class="nav">
- <li id="publishDate">Last Published: 26 July 2020</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 19</li>
+ <li id="publishDate">Last Published: 07 August 2020</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 23</li>
</ul>
<div class="pull-right"> <ul class="nav">
<li>
@@ -86,7 +86,7 @@
Mailing Lists</a>
</li>
<li class="none">
- <a href="team-list.html" title="PMC">
+ <a href="team.html" title="PMC">
PMC</a>
</li>
<li class="collapsed">
@@ -275,22 +275,9 @@
</div>
</td>
<td class="content">
- <!-- 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. -->
+
- <div class="section">
+ <section>
<h2><a name="The_Apache_Commons_Sandbox"></a>The Apache Commons Sandbox</h2>
<p>
@@ -303,7 +290,7 @@
<table border="0" class="bodyTable">
- <!-- This list should agree with ../../site.xml -->
+
<tr class="a">
<th>Sandbox</th>
@@ -394,10 +381,9 @@
<td>Provides a set of pipeline utilities designed around work queues that run in parallel to sequentially process data objects data objects.</td></tr>
</table>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="The_Apache_Commons_Sandbox_-_Google_Summer_of_Code_Projects"></a>The Apache Commons Sandbox - Google Summer of Code Projects</h2>
<p>
@@ -411,10 +397,9 @@
See the <a href="gsoc/index.html">Google Summer of Code space in Commons Sandbox</a>
for details.
</p>
- </div>
+ </section>
-
-<div class="section">
+ <section>
<h2><a name="Status_of_the_Sandbox_Components"></a>Status of the Sandbox Components</h2>
<p>
@@ -447,7 +432,7 @@
no active development for a sustained period of time.
</p>
- </div>
+ </section>
@@ -460,7 +445,7 @@
<p>Copyright © 2020
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.</p>
-
+ <?xml version="1.0" encoding="UTF-8"?>
<div class="center">Apache Commons, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>