You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bu...@apache.org on 2013/10/14 21:03:36 UTC
svn commit: r882581 [4/4] - in /websites/staging/commons/trunk/content: ./
downloads/ gsoc/ gsoc/2010/ releases/
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 Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -13,7 +13,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -32,7 +32,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="../components.html" title="Components">Components</a>
|
@@ -167,25 +167,34 @@
-<div class="section"><h2>Publishing The Release - Step By Step<a name="Publishing_The_Release_-_Step_By_Step"></a></h2>
- <div class="section"><h3>Introduction<a name="Introduction"></a></h3>
- <p>
+<div class="section">
+<h2>Publishing The Release - Step By Step<a name="Publishing_The_Release_-_Step_By_Step"></a></h2>
+
+<div class="section">
+<h3>Introduction<a name="Introduction"></a></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.
</p>
- <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
found <a href="prepare.html">here</a>.
</p>
- <p>
+
+<p>
In particular, it is assumed:
- </p><ul>
- <li>
+ </p>
+<ul>
+
+<li>
The signed release candidate source and binary distributions and release notes are available
in https://dist.apache.org/repos/dist/dev/commons/foo.
</li>
- <li>
+
+<li>
The maven artifacts associated with the release are available in a closed Nexus staging
repository.
</li>
@@ -193,17 +202,23 @@
</div>
- <div class="section"><h3>1 Move Releases Into Distribution Directories<a name="a1_Move_Releases_Into_Distribution_Directories"></a></h3>
- <p>
+
+<div class="section">
+<h3>1 Move Releases Into Distribution Directories<a name="a1_Move_Releases_Into_Distribution_Directories"></a></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>.
</p>
- <p>You can perform multiple <tt>svn mv</tt> operations (with or without local
+
+<p>You can perform multiple <tt>svn mv</tt> 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>
- <div><pre>
+
+<div>
+<pre>
svnmucc -U https://dist.apache.org/repos/dist \
mv dev/commons/foo/RELEASE-NOTES.txt release/commons/foo \
mv dev/commons/foo/binaries/commons-foo-1.2-bin.tar.gz release/commons/foo/binaries \
@@ -226,20 +241,26 @@
</pre></div>
</div>
- <div class="section"><h3>2 Update Release Directory<a name="a2_Update_Release_Directory"></a></h3>
- <p>
+
+<div class="section">
+<h3>2 Update Release Directory<a name="a2_Update_Release_Directory"></a></h3>
+
+<p>
<b>Update README</b><br />
The contents of the <tt>README.html</tt> are displayed at the bottom of the html
showing the directory listing. This document should be updated to reflect the new release.
If this document is not present, then copy one from an existing release directory
and edit that.
</p>
- <p>The README must be https://dist.apache.org/repos/dist/release/commons/foo/README.html</p>
- <p>
+
+<p>The README must be https://dist.apache.org/repos/dist/release/commons/foo/README.html</p>
+
+<p>
Update the latest release number. Please also read through and correct any mistakes you find
and fix other items (eg. urls) which need updating.
</p>
- <p>
+
+<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
@@ -249,101 +270,142 @@
</p>
</div>
- <div class="section"><h3>3 Deploy Maven Artifacts<a name="a3_Deploy_Maven_Artifacts"></a></h3>
- <p>Login to the Nexus web interface, select your staging repository and
+
+<div class="section">
+<h3>3 Deploy Maven Artifacts<a name="a3_Deploy_Maven_Artifacts"></a></h3>
+
+<p>Login to the Nexus web interface, select your staging repository and
<a class="externalLink" href="http://www.apache.org/dev/publishing-maven-artifacts.html#promote">promote</a> it.</p>
- <p>
+
+<p>
The files placed here will be mirrored (after some delay) to the public distribution
repository on <a class="externalLink" href="http://repo1.maven.org/maven2/">http://repo1.maven.org/maven2/</a>.
</p>
</div>
- <div class="section"><h3>4 Create Subversion Tag for the Final Release<a name="a4_Create_Subversion_Tag_for_the_Final_Release"></a></h3>
- <p>Copy the release candidate tag in subversion to a name without RC in its name.</p>
+
+<div class="section">
+<h3>4 Create Subversion Tag for the Final Release<a name="a4_Create_Subversion_Tag_for_the_Final_Release"></a></h3>
+
+<p>Copy the release candidate tag in subversion to a name without RC in its name.</p>
</div>
- <div class="section"><h3>5 Test Main Site Downloads<a name="a5_Test_Main_Site_Downloads"></a></h3>
- <p>
+
+<div class="section">
+<h3>5 Test Main Site Downloads<a name="a5_Test_Main_Site_Downloads"></a></h3>
+
+<p>
Wait until the release files are available from the main Apache web site
(<tt>http://www.apache.org/dist/commons/foo/</tt>), then confirm things are good.
</p>
- <p>
+
+<p>
Check the main directory:
- </p><ol style="list-style-type: decimal">
- <li>
+ </p>
+<ol style="list-style-type: decimal">
+
+<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.
</li>
- <li>
+
+<li>
Check the <tt>KEYS</tt> file
</li>
- <li>
+
+<li>
Check the <tt>RELEASE-NOTES.txt</tt>
</li>
- <li>Download and verify the current distributions, the following might help
+
+<li>Download and verify the current distributions, the following might help
<tt>committers/tools/releases/verify_sigs.sh</tt>. </li>
</ol>
- <p>
+
+<p>
Follow the links to the binaries and source directories.
Check them in a similar manner.
</p>
</div>
- <div class="section"><h3>6 Update Component Build and Website<a name="a6_Update_Component_Build_and_Website"></a></h3>
- <ul>
- <li>
+
+<div class="section">
+<h3>6 Update Component Build and Website<a name="a6_Update_Component_Build_and_Website"></a></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
the component maintains an Ant build and the version is specified in build.xml, make sure to update
this as well.
</li>
- <li>
+
+<li>
<b>Publish the website</b>,
per the instructions <a href="../site-publish.html">here</a>.
</li>
</ul>
</div>
- <div class="section"><h3>7 Create Announcements<a name="a7_Create_Announcements"></a></h3>
- <p>
+
+<div class="section">
+<h3>7 Create Announcements<a name="a7_Create_Announcements"></a></h3>
+
+<p>
Announce the availability of the new release.
</p>
- <p>
+
+<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>.
Send this mail from your Apache account. Please spell check the document!
</p>
- <p>
+
+<p>
Wait to send the release announcement until you have verified that
- </p><ol style="list-style-type: decimal">
- <li>The release artifacts are available on the mirrors.</li>
- <li>The component website including the updated download page has been updated on the public site
+ </p>
+<ol style="list-style-type: decimal">
+
+<li>The release artifacts are available on the mirrors.</li>
+
+<li>The component website including the updated download page has been updated on the public site
http://commons.apache.org/proper/foo.</li>
- <li>If the component publishes maven artifacts, these artifacts have been replicated to the central
+
+<li>If the component publishes maven artifacts, these artifacts have been replicated to the central
maven repo at repo1.maven.org. (Clear your local repo of the release artifacts and either activate
the clirr report with the updated version info or update a local project with a dependency to the new
release version to get maven to try to download the release artifacts. Or just access repo1 using a web
browser.)</li>
</ol>
- <p>
+
+<p>
The release announcement should go to (at least) the following mailing lists:
- </p><ul>
- <li>announce@apache.org</li>
- <li>dev@commons.apache.org</li>
- <li>user@commons.apache.org</li>
+ </p>
+<ul>
+
+<li>announce@apache.org</li>
+
+<li>dev@commons.apache.org</li>
+
+<li>user@commons.apache.org</li>
</ul>
</div>
- <div class="section"><h3>8 Post Release Cleanup<a name="a8_Post_Release_Cleanup"></a></h3>
- <p>
+
+<div class="section">
+<h3>8 Post Release Cleanup<a name="a8_Post_Release_Cleanup"></a></h3>
+
+<p>
That's it! The release is out there - but there is still some tidying up to be done.
</p>
- <ul>
- <li>
+
+<ul>
+
+<li>
<b>Remove Obsolete Releases</b><br />
Unless old versions are especially required, remove them from the dist directory. This
will cause the files to also be deleted from the mirrors and
@@ -355,18 +417,22 @@
them from the archive dist directories so users will
still be able to access old files even when they are not available from the mirrors.
</li>
- <li>
+
+<li>
<b>Update JIRA</b>
Mark the release as released in the JIRA project admin and CLOSE all issues RESOLVED
in this release. Make sure the FIX VERSION for all issues closed with this release
is set correctly to this version. If this has not already been done, create a JIRA version
for the next release.
</li>
- <li>
+
+<li>
<b>Update DOAP file</b>
Update the component's <a class="externalLink" href="http://projects.apache.org/guidelines.html">DOAP file</a>
and add a new entry with details of the released version:
- <div><pre>
+
+<div>
+<pre>
<release>
<Version>
<name>x.y.z</name>
@@ -375,7 +441,8 @@
</Version>
</release> </pre></div>
</li>
- <li>
+
+<li>
<b>Update changes.xml</b>
If the component uses the maven changes plugin to maintain its changelog, fill in the release
date for the just released version and create a new release element for the next release.
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 Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -15,7 +15,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="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -34,7 +34,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="../components.html" title="Components">Components</a>
|
@@ -167,44 +167,58 @@
See the License for the specific language governing permissions and
limitations under the License. --><!-- $Id: versioning.xml 932074 2010-04-08 19:39:55Z sebb $ -->
- <div class="section"><h2>Overview<a name="Overview"></a></h2>
- <p>This document provides:</p>
- <ul>
- <li>
+ <div class="section">
+<h2>Overview<a name="Overview"></a></h2>
+
+<p>This document provides:</p>
+
+<ul>
+
+<li>
a set of guidelines intended to help the Apache Commons
team balance the need to provide a stable interface to
clients with the growth and evolution of components over
time,
</li>
- <li>
+
+<li>
a language for describing the changes to a component
and the types of incompatibilities such changes may
create,
</li>
- <li>
+
+<li>
and a protocol for communicating those changes and
incompatibilities to users and developers.
</li>
</ul>
</div>
- <div class="section"><h2>Interface Types<a name="Interface_Types"></a></h2>
- <p>
+
+<div class="section">
+<h2>Interface Types<a name="Interface_Types"></a></h2>
+
+<p>
We identify three distinct categories of interfaces or APIs
within a component: <i>external</i>, <i>internal</i>
and <i>private</i>.
</p>
- <div class="section"><h3>The External Interface<a name="The_External_Interface"></a></h3>
- <p>
+
+<div class="section">
+<h3>The External Interface<a name="The_External_Interface"></a></h3>
+
+<p>
The <i>external</i> interface of component is composed of the
public-facing classes, interfaces, methods and attributes
provided by the component--those that are likely to be
used by clients to the component.
</p>
- <p>
+
+<p>
For obvious reasons, we try to avoid or at least
acknowledge changes to the external interface.
</p>
- <p>
+
+<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
@@ -212,8 +226,11 @@
be deemed part of the external interface.
</p>
</div>
- <div class="section"><h3>The Internal Interface<a name="The_Internal_Interface"></a></h3>
- <p>
+
+<div class="section">
+<h3>The Internal Interface<a name="The_Internal_Interface"></a></h3>
+
+<p>
The <i>internal</i> interface of a component is composed of the
classes, methods and attributes that are primarily or
exclusively intended for use by the component
@@ -221,7 +238,8 @@
unlikely to use or be concerned with the internal
interface.
</p>
- <p>
+
+<p>
The internal interface of a component <i>may</i> correspond to
the <tt>package</tt> and <tt>private</tt> scope classes
and members of the component, but this is not always the case.
@@ -231,15 +249,19 @@
intended primarily for internal use.
</p>
</div>
- <div class="section"><h3>The Private Interface<a name="The_Private_Interface"></a></h3>
- <p>
+
+<div class="section">
+<h3>The Private Interface<a name="The_Private_Interface"></a></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
by virtue of the Java Language Specification.
</p>
</div>
- <p>
+
+<p>
Whenever a class, interface or member is considered part of the
external or internal interface of a component, it should be
clearly indicated as such in the JavaDoc comments or other
@@ -247,16 +269,22 @@
adding custom JavaDoc tags for this purpose.)
</p>
</div>
- <div class="section"><h2>Types of Change<a name="Types_of_Change"></a></h2>
- <p>
+
+<div class="section">
+<h2>Types of Change<a name="Types_of_Change"></a></h2>
+
+<p>
We can categorize the changes to a component according to
the degree to which these changes are compatible with
previous releases of the component. We define three such
categories: <i>fully-compatible</i>, <i>interface-compatible</i>,
and <i>external-interface-compatible</i>.
</p>
- <div class="section"><h3>Fully-Compatible Changes<a name="Fully-Compatible_Changes"></a></h3>
- <p>
+
+<div class="section">
+<h3>Fully-Compatible Changes<a name="Fully-Compatible_Changes"></a></h3>
+
+<p>
Release <i>B</i> is said to be <i>fully-compatible</i>
with Release <i>A</i> if <i>B</i> can simply replace <i>A</i>
in (<a href="#note1">nearly</a>) all circumstances
@@ -264,71 +292,92 @@
configuration, and without changing the semantics of any
<tt>public</tt> or <tt>protected</tt> 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 class or interface to a component</li>
- <li>
+
+<p>Examples of fully-compatible changes include:</p>
+
+<ul>
+
+<li>adding a non-<tt>abstract</tt> 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>
</li>
- <li>
+
+<li>
changing a <tt>private</tt> attribute to
a <tt>private</tt> method
</li>
- <li>
+
+<li>
changing an implementation such that a given external
library is no longer needed by the component
</li>
- <li>
+
+<li>
changing a method or class from <tt>final</tt> to
non-<tt>final</tt>
</li>
- <li>
+
+<li>
deprecating, but not otherwise changing, a class, inteface
or member
</li>
- <li>
+
+<li>
changing a component in order to fix a defect (a
deviation from the documented or reasonably expected
behavior), assuming no other incompatibilities are
introduced
</li>
</ul>
- <p>Examples of changes which are not fully-compatible include:</p>
- <ul>
- <li>
+
+<p>Examples of changes which are not fully-compatible include:</p>
+
+<ul>
+
+<li>
a release that no longer supports the same set of JREs,
or that requires new libraries to be added to the
classpath
</li>
- <li>
+
+<li>
changing a <tt>public</tt> or <tt>protected</tt> method signature
</li>
- <li>
+
+<li>
changing the default value of an attribute in a
behaviour-impacting way
</li>
- <li>
+
+<li>
removing a class, interface, method or attribute
from either the internal or external interface of
the component
</li>
</ul>
- <p>
+
+<p>
Note that not every non-fully-compatible change
will cause compilation or readily apparent
run-time problems.
</p>
- <p>
+
+<p>
Generally speaking, a fully-compatible change will at
most change the private interface of a component, or simply
add classes, methods and attributes whose use is optional
to both internal and external interface clients.
</p>
</div>
- <div class="section"><h3>Interface-Compatible Changes<a name="Interface-Compatible_Changes"></a></h3>
- <p>
+
+<div class="section">
+<h3>Interface-Compatible Changes<a name="Interface-Compatible_Changes"></a></h3>
+
+<p>
Release <i>B</i> is said to be "interface-compatible" with
Release <i>A</i> if (<a href="#note1">nearly</a>) all clients
that can be compiled with <i>A</i> in the classpath can
@@ -337,36 +386,46 @@
<tt>protected</tt> member. A configuration or
classpath change may be required.
</p>
- <p>
+
+<p>
Examples of interface-compatible changes include:
</p>
- <ul>
- <li>all fully-compatible changes</li>
- <li>
+
+<ul>
+
+<li>all fully-compatible changes</li>
+
+<li>
changing a component such that it now depends
upon an additional external library or
configuration file
</li>
</ul>
- <p>
+
+<p>
Examples of changes which are not interface-compatible
include:
</p>
- <ul>
- <li>
+
+<ul>
+
+<li>
changing a public or protected method signature
</li>
- <li>
+
+<li>
changing the default value of an attribute in a
behaviour changing way
</li>
- <li>
+
+<li>
removing a class, interface, method or attribute
from either the internal or external interface of the
component
</li>
</ul>
- <p>
+
+<p>
Generally speaking, an interface-compatible change
will at most change the private interface of a
component, or simply add classes, methods and
@@ -374,8 +433,11 @@
internal and external interface clients.
</p>
</div>
- <div class="section"><h3>External-Interface-Compatible Changes<a name="External-Interface-Compatible_Changes"></a></h3>
- <p>
+
+<div class="section">
+<h3>External-Interface-Compatible Changes<a name="External-Interface-Compatible_Changes"></a></h3>
+
+<p>
Release <i>B</i> is said to be "external-interface-compatible"
with Release <i>A</i> if (<a href="#note1">nearly</a>) all
clients that depend only on the external interface of a
@@ -385,46 +447,58 @@
<i>external</i> interface. A configuration or classpath
change may be required.
</p>
- <p>
+
+<p>
Examples of external-interface-compatible changes include:
</p>
- <ul>
- <li>all interface-compatible changes</li>
- <li>
+
+<ul>
+
+<li>all interface-compatible changes</li>
+
+<li>
removing a class, interface, method or attribute from
the internal interface of the component
</li>
- <li>
+
+<li>
a change to the internal or private interface of a
component that requires a change in configuration
settings or in the external libraries required to
use the component
</li>
- <li>
+
+<li>
changes to the internal or private interface of a
component without impacting the external interface
</li>
</ul>
- <p>
+
+<p>
Examples of changes which are not
external-interface-compatible include:
</p>
- <ul>
- <li>
+
+<ul>
+
+<li>
changing the method signature of any method that is
part of the external interface of the component
</li>
- <li>
+
+<li>
changing the default value of any attribute that is
part of the external interface of the component in a
behaviour changing way
</li>
- <li>
+
+<li>
removing a class, interface, method or attribute from
external interface of the component
</li>
</ul>
- <p>
+
+<p>
Generally speaking, external-interface-compatible
changes correspond to changes to at most the internal
interface of the component or the addition of
@@ -433,18 +507,25 @@
</p>
</div>
</div>
- <div class="section"><h2>Release Types<a name="Release_Types"></a></h2>
- <p>
+
+<div class="section">
+<h2>Release Types<a name="Release_Types"></a></h2>
+
+<p>
We identify five types of releases: "Major", "Minor",
"Point", "Beta" and "Milestone".
</p>
- <p>
+
+<p>
Developers are encouraged to "upgrade" a release to a
stronger type whenever the nature or scope of the change
warrants it.
</p>
- <div class="section"><h3>Major Releases<a name="Major_Releases"></a></h3>
- <p>
+
+<div class="section">
+<h3>Major Releases<a name="Major_Releases"></a></h3>
+
+<p>
Major releases signify significant changes to a component.
Developers <i>may</i> perform a major release if there have been
substantial improvements to the component. Developers
@@ -452,13 +533,17 @@
is not at least interface-compatible with the previous release.
</p>
</div>
- <div class="section"><h3>Minor Releases<a name="Minor_Releases"></a></h3>
- <p>
+
+<div class="section">
+<h3>Minor Releases<a name="Minor_Releases"></a></h3>
+
+<p>
Minor releases signify enhancements to a component that do
not necessitate a major release. Developers <i>may</i> perform a
minor release if the release is at least
external-interface-compatible with the previous release.
- <p>
+
+<p>
</p>
In other words, whenever a client depends upon at most
the external interface of a component with a given minor
@@ -466,39 +551,54 @@
within that major release.
</div>
- <div class="section"><h3>Point Releases<a name="Point_Releases"></a></h3>
- <p>
+
+<div class="section">
+<h3>Point Releases<a name="Point_Releases"></a></h3>
+
+<p>
A point release typically involves simple bug fixes or
optimizations that do not introduce new features.
Developers <i>may</i> perform a point release if the release
is at least interface-compatible with the
previous release.
</p>
- <p>
+
+<p>
In other words, whenever a client depends upon a component
with a given point release, it will work with all
subsequent point releases within that minor release.
</p>
</div>
- <div class="section"><h3>Beta Releases<a name="Beta_Releases"></a></h3>
- <p>
+
+<div class="section">
+<h3>Beta Releases<a name="Beta_Releases"></a></h3>
+
+<p>
Developers may, at their option, perform a beta preview of
any major, minor or point release. Beta releases may be
performed for a variety of purposes such as:
</p>
- <ul>
- <li>Showcasing new, untested features</li>
- <li>Providing early corrections of critical bugs</li>
- <li>Generating a stable version before large-scale changes</li>
+
+<ul>
+
+<li>Showcasing new, untested features</li>
+
+<li>Providing early corrections of critical bugs</li>
+
+<li>Generating a stable version before large-scale changes</li>
</ul>
- <p>
+
+<p>
While every effort should be made to ensure the quality of
released code, "beta" releases are essentially provided
as-is with no guarantees of stability or maintenance.
</p>
</div>
- <div class="section"><h3>Milestone Releases<a name="Milestone_Releases"></a></h3>
- <p>
+
+<div class="section">
+<h3>Milestone Releases<a name="Milestone_Releases"></a></h3>
+
+<p>
Developers may, at their option, offer a milestone
preview of any major release. A milestone release is
appropriate when part of the overall component is
@@ -507,7 +607,8 @@
remaining to be implemented should be clearly defined and
documented.
</p>
- <p>
+
+<p>
While every effort should be made to ensure the quality of
released code, "milestone" releases are essentially
provided as-is with no guarantees of stability or
@@ -515,41 +616,60 @@
</p>
</div>
</div>
- <div class="section"><h2>Release Numbers<a name="Release_Numbers"></a></h2>
- <div class="section"><h3>Initial Release Number<a name="Initial_Release_Number"></a></h3>
- <p>
+
+<div class="section">
+<h2>Release Numbers<a name="Release_Numbers"></a></h2>
+
+<div class="section">
+<h3>Initial Release Number<a name="Initial_Release_Number"></a></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"><h3>Dissecting the Release Number<a name="Dissecting_the_Release_Number"></a></h3>
- <p>
+
+<div class="section">
+<h3>Dissecting the Release Number<a name="Dissecting_the_Release_Number"></a></h3>
+
+<p>
A release number is comprised of 3 components: the major
release number, the minor release number, and an optional
point release number. Here is a sample release number:
</p>
- <p><tt>2.0.4</tt></p>
- <p>and it can be broken into three parts:</p>
- <ul>
- <li>major release: 2</li>
- <li>minor release: 0</li>
- <li>point release: 4</li>
+
+<p><tt>2.0.4</tt></p>
+
+<p>and it can be broken into three parts:</p>
+
+<ul>
+
+<li>major release: 2</li>
+
+<li>minor release: 0</li>
+
+<li>point release: 4</li>
</ul>
- <p>
+
+<p>
The next release of this component would increment the
appropriate part of the release number, depending on the
type of release (major, minor, or point). For example, a
subsequent minor release would be version 2.1, or a
subsequent major release would be 3.0.
</p>
- <p>
+
+<p>
Note that release numbers are composed of three _integers_,
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"><h3>Beta Release Numbers<a name="Beta_Release_Numbers"></a></h3>
- <p>
+
+<div class="section">
+<h3>Beta Release Numbers<a name="Beta_Release_Numbers"></a></h3>
+
+<p>
Beta releases are denoted by adding
"B<beta version number>" after the release number. For
example, if the current release version is 2.0.4, and a
@@ -557,8 +677,11 @@
release would be labeled 3.0-B1.
</p>
</div>
- <div class="section"><h3>Milestone Release Numbers<a name="Milestone_Release_Numbers"></a></h3>
- <p>
+
+<div class="section">
+<h3>Milestone Release Numbers<a name="Milestone_Release_Numbers"></a></h3>
+
+<p>
Milestone releases are denoted by adding
"M<milestone version number>" after the release number. For
example, if the current release version is 2.0.4, and a
@@ -567,13 +690,19 @@
</p>
</div>
</div>
- <div class="section"><h2>Development States<a name="Development_States"></a></h2>
- <p>
+
+<div class="section">
+<h2>Development States<a name="Development_States"></a></h2>
+
+<p>
We identify four possible states: "in development", "beta",
"released", and "unsupported".
</p>
- <div class="section"><h3>In Development State<a name="In_Development_State"></a></h3>
- <p>
+
+<div class="section">
+<h3>In Development State<a name="In_Development_State"></a></h3>
+
+<p>
When a component is "in development", it is new and still
relatively unstable. Typically components in this state
do not have any binary releases available beyond the
@@ -585,8 +714,11 @@
available for testing in a more stable test version.
</p>
</div>
- <div class="section"><h3>Beta State<a name="Beta_State"></a></h3>
- <p>
+
+<div class="section">
+<h3>Beta State<a name="Beta_State"></a></h3>
+
+<p>
When a component has made significant progress toward
release-quality code, the committers may vote to perform
a "beta" release. At this point, the component state will
@@ -594,14 +726,18 @@
remain in this state until it is ready for its first major
release.
</p>
- <p>
+
+<p>
Note that developers may skip vote to skip the "beta" state
and go directly to "released", if the component is
sufficiently stable.
</p>
</div>
- <div class="section"><h3>Released State<a name="Released_State"></a></h3>
- <p>
+
+<div class="section">
+<h3>Released State<a name="Released_State"></a></h3>
+
+<p>
When a new component is finally production-quality, the
developers may vote to perform the first major release.
At this point, the component status will be changed from
@@ -611,8 +747,11 @@
the case of "unsupported" components.
</p>
</div>
- <div class="section"><h3>Unsupported State<a name="Unsupported_State"></a></h3>
- <p>
+
+<div class="section">
+<h3>Unsupported State<a name="Unsupported_State"></a></h3>
+
+<p>
Under rare circumstances, committers may vote to make a
component "unsupported", if there are no resources to
maintain the library or if it has been completely
@@ -623,13 +762,17 @@
</p>
</div>
</div>
- <div class="section"><h2>Comments<a name="Comments"></a></h2>
- <p>
+
+<div class="section">
+<h2>Comments<a name="Comments"></a></h2>
+
+<p>
Using this approach it is possible to very precisely and
concisely define the dependencies between a component and
its clients.
</p>
- <p>
+
+<p>
For example, suppose that the application Foo depends
(only) upon features of the commons-superwidget component
that are part of the external interface in release 2.3.0.
@@ -637,7 +780,8 @@
certainty that Foo will work with any 2.x release of
superwidget (x >= 3).
</p>
- <p>
+
+<p>
Similarly, suppose the application Bar depends upon
features of superwidget that were part of the internal
interface of release 2.3.0. Then the maintainers of Bar
@@ -647,10 +791,15 @@
re-evaluate.
</p>
</div>
- <div class="section"><h2>End Notes<a name="End_Notes"></a></h2>
- <dl>
- <dt><a name="note1">Note 1</a></dt>
- <dd>
+
+<div class="section">
+<h2>End Notes<a name="End_Notes"></a></h2>
+
+<dl>
+
+<dt><a name="note1">Note 1</a></dt>
+
+<dd>
We say "nearly" here since there are rare
or unusual circumstances in which changes that are usually
"safe" may cause problems for a small number of users.
Modified: websites/staging/commons/trunk/content/sandbox.html
==============================================================================
--- websites/staging/commons/trunk/content/sandbox.html (original)
+++ websites/staging/commons/trunk/content/sandbox.html Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -13,7 +13,7 @@
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -32,7 +32,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="components.html" title="Components">Components</a>
|
@@ -218,82 +218,145 @@
See the License for the specific language governing permissions and
limitations under the License. -->
- <div class="section"><h2>The Apache Commons Sandbox<a name="The_Apache_Commons_Sandbox"></a></h2>
- <p>
+ <div class="section">
+<h2>The Apache Commons Sandbox<a name="The_Apache_Commons_Sandbox"></a></h2>
+
+<p>
The Sandbox is a Subversion repository for Commons committers to
function as an open workspace for sharing and collaboration.
The Sandbox serves as a staging ground for project which are
destined for what is known as the Commons Proper.
</p>
- <table border="0" class="bodyTable">
+
+<table border="0" class="bodyTable">
<!-- This list should agree with ../../site.xml -->
- <tr class="a"><th>Sandbox</th><th></th></tr>
- <tr class="b"><td><a href="sandbox/commons-beanutils2/">BeanUtils2</a></td>
- <td>Redesign of Commons BeanUtils.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-classscan/">ClassScan</a></td>
- <td>Find Class interfaces, methods, fields, and annotations without loading.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-cli2">CLI2</a></td>
- <td>Redesign of Commons CLI.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-convert/">Convert</a></td>
- <td>Commons-Convert aims to provide a single library dedicated to the task of converting an object of one type to another.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-finder/">Finder</a></td>
- <td>Java library inspired by the UNIX find command.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-flatfile/">Flatfile</a></td>
- <td>Java library for working with flat data structures.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-graph/">Graph</a></td>
- <td>A general purpose Graph APIs and algorithms.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-i18n/">I18n</a></td>
- <td>Adds the feature of localized message bundles that consist of one or many localized texts that belong together. Think of an error message that consists of title, text, summary and error details.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-id/">Id</a></td>
- <td>Id is a component used to generate identifiers.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-javaflow/">Javaflow</a></td>
- <td>Continuation implementation to capture the state of the application.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-jnet/">JNet</a></td>
- <td>JNet allows to use dynamically register url stream handlers through the java.net API.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-monitoring/">Monitoring</a></td>
- <td>Monitoring provides a simple, lightweight toolkit to instrument java application monitoring capabilities, including performances and thread concurrency.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-nabla/">Nabla</a></td>
- <td>Nabla provides automatic differentiation classes that can generate derivative of any function implemented in the Java language.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-openpgp/">OpenPGP</a></td>
- <td>Interface to signing and verifying data using OpenPGP.</td></tr>
- <tr class="b"><td><a href="sandbox/commons-performance/">Performance</a></td>
- <td>A small framework for microbenchmark clients, with implementations for Commons DBCP and Pool.</td></tr>
- <tr class="a"><td><a href="sandbox/commons-pipeline/">Pipeline</a></td>
- <td>Provides a set of pipeline utilities designed around work queues that run in parallel to sequentially process data objects data objects.</td></tr>
+
+<tr class="a">
+<th>Sandbox</th>
+<th></th></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-beanutils2/">BeanUtils2</a></td>
+
+<td>Redesign of Commons BeanUtils.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-classscan/">ClassScan</a></td>
+
+<td>Find Class interfaces, methods, fields, and annotations without loading.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-cli2">CLI2</a></td>
+
+<td>Redesign of Commons CLI.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-convert/">Convert</a></td>
+
+<td>Commons-Convert aims to provide a single library dedicated to the task of converting an object of one type to another.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-finder/">Finder</a></td>
+
+<td>Java library inspired by the UNIX find command.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-flatfile/">Flatfile</a></td>
+
+<td>Java library for working with flat data structures.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-graph/">Graph</a></td>
+
+<td>A general purpose Graph APIs and algorithms.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-i18n/">I18n</a></td>
+
+<td>Adds the feature of localized message bundles that consist of one or many localized texts that belong together. Think of an error message that consists of title, text, summary and error details.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-id/">Id</a></td>
+
+<td>Id is a component used to generate identifiers.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-javaflow/">Javaflow</a></td>
+
+<td>Continuation implementation to capture the state of the application.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-jnet/">JNet</a></td>
+
+<td>JNet allows to use dynamically register url stream handlers through the java.net API.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-monitoring/">Monitoring</a></td>
+
+<td>Monitoring provides a simple, lightweight toolkit to instrument java application monitoring capabilities, including performances and thread concurrency.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-nabla/">Nabla</a></td>
+
+<td>Nabla provides automatic differentiation classes that can generate derivative of any function implemented in the Java language.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-openpgp/">OpenPGP</a></td>
+
+<td>Interface to signing and verifying data using OpenPGP.</td></tr>
+
+<tr class="b">
+<td><a href="sandbox/commons-performance/">Performance</a></td>
+
+<td>A small framework for microbenchmark clients, with implementations for Commons DBCP and Pool.</td></tr>
+
+<tr class="a">
+<td><a href="sandbox/commons-pipeline/">Pipeline</a></td>
+
+<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>
- <div class="section"><h2>The Apache Commons Sandbox - Google Summer of Code Projects<a name="The_Apache_Commons_Sandbox_-_Google_Summer_of_Code_Projects"></a></h2>
- <p>
+
+<div class="section">
+<h2>The Apache Commons Sandbox - Google Summer of Code Projects<a name="The_Apache_Commons_Sandbox_-_Google_Summer_of_Code_Projects"></a></h2>
+
+<p>
<a class="externalLink" href="http://code.google.com/soc/">Google Summer of Code</a><sup>TM</sup>
is a global program that offers student developers stipends to write code for various
open source software projects. The Apache Software Foundation participates in
the program every year.
</p>
- <p>
+
+<p>
See the <a href="gsoc/index.html">Google Summer of Code space in Commons Sandbox</a>
for details.
</p>
</div>
- <div class="section"><h2>Status of the Sandbox Components<a name="Status_of_the_Sandbox_Components"></a></h2>
- <p>
+
+<div class="section">
+<h2>Status of the Sandbox Components<a name="Status_of_the_Sandbox_Components"></a></h2>
+
+<p>
Check the status of a sandbox component on
<a class="externalLink" href="http://wiki.apache.org/commons/TheSandbox">the sandbox wiki page</a>
or just ask on one of
<a href="mail-lists.html">the commons mailing lists</a>.
</p>
- <p>
+
+<p>
A Sandbox component is considered active if there is a definite plan
for promotion to the Commons Proper and there is an active group of
existing committers working on a component.
</p>
- <p>
+
+<p>
A Commons Sandbox component is considered dormant if there is little
recent development activity and no individual or group of individual
commiters has emerged to champion its ultimate promotion to
@@ -302,7 +365,8 @@
webpage for a list of Commons components currently considered dormant.
</p>
- <p>
+
+<p>
A Commons Sandbox component is considered inactive if there is
no active development for a sustained period of time.
</p>
Modified: websites/staging/commons/trunk/content/site-publish.html
==============================================================================
--- websites/staging/commons/trunk/content/site-publish.html (original)
+++ websites/staging/commons/trunk/content/site-publish.html Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -13,7 +13,7 @@
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -32,7 +32,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="components.html" title="Components">Components</a>
|
@@ -166,8 +166,10 @@
limitations under the License. -->
- <div class="section"><h2>Introduction<a name="Introduction"></a></h2>
- <p>
+ <div class="section">
+<h2>Introduction<a name="Introduction"></a></h2>
+
+<p>
Due to svnpubsub migration, the procedure to publish sites has been changed.
Commons sites use a solution based on both <a class="externalLink" href="http://apache.org/dev/cmsref.html">Apache CMS</a> (for the main site)
and svnpubsub publication based on the <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/">maven-scm-publish-plugin</a>
@@ -175,58 +177,90 @@
</p>
</div>
- <div class="section"><h2>Main site<a name="Main_site"></a></h2>
- <p>The Apache CMS UI can be used to modify and publish main web site: <a class="externalLink" href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
+
+<div class="section">
+<h2>Main site<a name="Main_site"></a></h2>
+
+<p>The Apache CMS UI can be used to modify and publish main web site: <a class="externalLink" href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
More documentation is available <a class="externalLink" href="http://apache.org/dev/cmsref.html">here</a>
</p>
- <p>
+
+<p>
The main site content is now located in svn: https://svn.apache.org/repos/asf/commons/cms-site/trunk/ .<br />
You can test your changes locally using:
- </p><div><pre>mvn clean site</pre></div>
+ </p>
+<div>
+<pre>mvn clean site</pre></div>
- <p>After you commit, and <a class="externalLink" href="http://ci.apache.org/builders/commons-site-staging">buildbot</a> handles the site generation, you can test your changes, and any others in the pipeline, at <a class="externalLink" href="http://commons.staging.apache.org/">http://commons.staging.apache.org/</a>.
+
+<p>After you commit, and <a class="externalLink" href="http://ci.apache.org/builders/commons-site-staging">buildbot</a> handles the site generation, you can test your changes, and any others in the pipeline, at <a class="externalLink" href="http://commons.staging.apache.org/">http://commons.staging.apache.org/</a>.
Once satisfied, you can <a class="externalLink" href="https://cms.apache.org/commons/publish">publish</a> via the CMS site.
Note that the staging site is shared, so if any other changes have been made to the site by other developers, these will also be published.
</p>
</div>
- <div class="section"><h2>Components<a name="Components"></a></h2>
- <p>
+
+<div class="section">
+<h2>Components<a name="Components"></a></h2>
+
+<p>
Components use the maven-scm-publish-plugin. The maven generated site is checked in to:
- </p><ul>
- <li>proper: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/</li>
- <li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/</li>
- <li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/</li>
+ </p>
+<ul>
+
+<li>proper: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/</li>
+
+<li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/</li>
+
+<li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/</li>
</ul>
- <p>
+
+<p>
Components must use parent 28 (sandbox parent: 10) or later.
</p>
- <p>Maven will create a working copy of the site svn directory (<tt>~/commons-sites/</tt>
+
+<p>Maven will create a working copy of the site svn directory (<tt>~/commons-sites/</tt>
by default) publish your site to it and commit the changes. It will not prompt you for your svn
password so the commit will fail unless subversion is configured to store your password. If it
fails, you can commit the changes manually.</p>
- <p>In order to publish the site of a single module project use</p>
- <div><pre>
+
+<p>In order to publish the site of a single module project use</p>
+
+<div>
+<pre>
mvn clean site-deploy
</pre></div>
- <p>and for a multi modules project use</p>
- <div><pre>
+
+<p>and for a multi modules project use</p>
+
+<div>
+<pre>
mvn clean site site:stage scm-publish:publish-scm
</pre></div>
- <div class="section"><h3>Configuration<a name="Configuration"></a></h3>
- <p>
+
+<div class="section">
+<h3>Configuration<a name="Configuration"></a></h3>
+
+<p>
Default deployment targets are:
- </p><ul>
- <li>propers: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/${project.artifactId}</li>
- <li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/${project.artifactId}</li>
- <li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/${project.artifactId}</li>
+ </p>
+<ul>
+
+<li>propers: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/${project.artifactId}</li>
+
+<li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/${project.artifactId}</li>
+
+<li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/${project.artifactId}</li>
</ul>
- <p>
+
+<p>
The maven-scm-publish-plugin will delete any content not generated by the Maven site plugin.
To avoid deletion of previous apis javadocs or other static content, the pom needs some configuration:</p>
- <div><pre>
+
+<div>
+<pre>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -240,7 +274,8 @@
</plugin>
</pre></div>
- <p>All declared paths won't be deleted from svn but rather have to be imported manually.</p>
+
+<p>All declared paths won't be deleted from svn but rather have to be imported manually.</p>
</div>
</div>
Modified: websites/staging/commons/trunk/content/svninfo.html
==============================================================================
--- websites/staging/commons/trunk/content/svninfo.html (original)
+++ websites/staging/commons/trunk/content/svninfo.html Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -13,7 +13,7 @@
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="The Apache Commons Documentation Team" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -32,7 +32,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="components.html" title="Components">Components</a>
|
@@ -167,7 +167,9 @@ limitations under the License. -->
-<div class="section"><h2>Download the Source<a name="Download_the_Source"></a></h2>
+<div class="section">
+<h2>Download the Source<a name="Download_the_Source"></a></h2>
+
<p>
Most users of the source code probably don't need to have day to
@@ -178,41 +180,56 @@ link on the Commons page.
</div>
-<div class="section"><h2>Access the Version Control System (quick info)<a name="Access_the_Version_Control_System_quick_info"></a></h2>
+
+<div class="section">
+<h2>Access the Version Control System (quick info)<a name="Access_the_Version_Control_System_quick_info"></a></h2>
+
<p>
Enter the following URL into a web browser to browse the latest source code,
or pass that same url to a subversion client application to check the code out
to your local machine, after replacing {component-name} with the appropriate
value.
-</p><div><pre>
+</p>
+<div>
+<pre>
http://svn.apache.org/repos/asf/commons/proper/{component-name}/trunk
</pre></div>
+
<p>
Alternatively, enter the following URL into a web browser to browse the latest
source code including history and commit information. Note that despite the
name "viewvc" appearing in this link, the information <i>is</i> from the
ASF Subversion repository.
-</p><div><pre>
+</p>
+<div>
+<pre>
http://svn.apache.org/viewvc/commons/proper/{component-name}/trunk
</pre></div>
</div>
-<div class="section"><h2>Access the Version Control System (details)<a name="Access_the_Version_Control_System_details"></a></h2>
+
+<div class="section">
+<h2>Access the Version Control System (details)<a name="Access_the_Version_Control_System_details"></a></h2>
+
<p>
The root url of the ASF Subversion repository is <b>http://svn.apache.org/repos/asf/</b>
for read-only access and <b>https://svn.apache.org/repos/asf/</b> for committers.
</p>
+
<p>
The URLs for direct access to the commons section of that repository are:
-</p><ul>
+</p>
+<ul>
+
<li>
<a class="externalLink" href="http://svn.apache.org/repos/asf/commons">
http://svn.apache.org/repos/asf/commons
</a>
for non-committers, and
</li>
+
<li>
<a class="externalLink" href="https://svn.apache.org/repos/asf/commons">
https://svn.apache.org/repos/asf/commons
@@ -221,10 +238,12 @@ The URLs for direct access to the common
</li>
</ul>
+
<p>
The "proper" subdirectory leads to the code for official commons components.
The "sandbox" subdirectory leads to the code for experimental commons components.
</p>
+
<p>
Subdirectories "trunks-proper" and "trunks-sandbox" are special directories that
should be ignored by most users; they have Subversion "external attributes"
@@ -234,6 +253,7 @@ of every commons or sandbox project. Thi
building the commons website. Most users can ignore these directories and access
the trunk of a project via the "proper" or "sandbox" directory.
</p>
+
<p>
You can directly browse the <i>latest</i> version of ASF the code in Subversion by entering
one of the above URLs into a standard web browser. Once you have found a directory of
@@ -241,18 +261,24 @@ interest, you can pass the same URL to a
out the files locally.
</p>
+
<p>
As an alternative, you can browse the repository (including access to file history)
via one of the links below. Once you have found a file or directory of
interest, replace the url prefix "http://svn.apache.org/viewvc" with the
appropriate subversion root url (see above).
-</p><ul>
+</p>
+<ul>
+
<li><a class="externalLink" href="http://svn.apache.org/viewvc/commons/proper">browse proper components via viewer</a></li>
+
<li><a class="externalLink" href="http://svn.apache.org/viewvc/commons/sandbox">browse sandbox components via viewer</a></li>
+
<li><a class="externalLink" href="http://svn.apache.org/viewvc/commons/dormant">browse dormant components via viewer</a></li>
</ul>
+
<p><b>Important!</b> When checking out a directory in subversion, ensure that you
do not check out a directory that has "tags" and "branches" subdirectories, as this will
result in getting a complete copy of the code for every branch and tag ever made.
@@ -262,6 +288,7 @@ listed above, as different projects may
For example, some projects which support multiple versions of Java may use
<b>{component-name}/branches/{branch-name}</b> as well as {component-name}/trunk.
</p>
+
<p>
<b>Important!</b> At the current time, selecting by date in subversion within the
ASF repository isn't reliable. The reason is that when converting a date to a revision
@@ -274,6 +301,7 @@ even in directories unrelated to the one
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>
+
<p>
For more information on connecting to the ASF Subversion repository, see the
<a class="externalLink" href="http://www.apache.org/dev/version-control.html">ASF version control page</a>.
@@ -281,7 +309,10 @@ For more information on connecting to th
</div>
-<div class="section"><h2>About Subversion<a name="About_Subversion"></a></h2>
+
+<div class="section">
+<h2>About Subversion<a name="About_Subversion"></a></h2>
+
<p>
Subversion is an open-source version control system designed to be "a better CVS".
More information about subversion can be found at
Modified: websites/staging/commons/trunk/content/team-list.html
==============================================================================
--- websites/staging/commons/trunk/content/team-list.html (original)
+++ websites/staging/commons/trunk/content/team-list.html Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -11,7 +11,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -30,7 +30,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="components.html" title="Components">Components</a>
|
@@ -148,7 +148,161 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>The Team<a name="The_Team"></a></h2><a name="The_Team"></a><p>A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.</p><p>The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.</p><div class="section"><h3>Members<a name="Members"></a></h3><a name="Members"></a><p>The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.</p><table border="0" class="bodyTable"><tr class="a"><th>Id</th><th>Name</th><th>Roles</th></tr><tr class="b"><td><a name="britter">
</a>britter</td><td>Benedikt Ritter</td><td>PMC Member</td></tr><tr class="a"><td><a name="bspeakmon"></a>bspeakmon</td><td>Benjamin Speakmon</td><td>PMC Member</td></tr><tr class="b"><td><a name="billbarker"></a>billbarker</td><td>Bill Barker</td><td>PMC Member</td></tr><tr class="a"><td><a name="brentworden"></a>brentworden</td><td>Brent Worden</td><td>PMC Member</td></tr><tr class="b"><td><a name="grobmeier"></a>grobmeier</td><td>Christian Grobmeier</td><td>PMC Member</td></tr><tr class="a"><td><a name="dfs"></a>dfs</td><td>Daniel Savarese</td><td>PMC Member</td></tr><tr class="b"><td><a name="dennisl"></a>dennisl</td><td>Dennis Lundberg</td><td>PMC Member</td></tr><tr class="a"><td><a name="ebourg"></a>ebourg</td><td>Emmanuel Bourg</td><td>PMC Member</td></tr><tr class="b"><td><a name="ggregory"></a>ggregory</td><td>Gary Gregory</td><td>PMC Member</td></tr><tr class="a"><td><a name="henrib"></a>henrib</td><td>Henri Biestro</td><td>PMC Member</td></tr><tr class="b"><td><a name="b
ayard"></a>bayard</td><td>Henri Yandell</td><td>PMC Member</td></tr><tr class="a"><td><a name="jcarman"></a>jcarman</td><td>James Carman</td><td>PMC Member</td></tr><tr class="b"><td><a name="jochen"></a>jochen</td><td>Jochen Wiedmann</td><td>PMC Member</td></tr><tr class="a"><td><a name="pietsch"></a>pietsch</td><td>Joerg Pietschmann</td><td>PMC Member</td></tr><tr class="b"><td><a name="joehni"></a>joehni</td><td>Joerg Schaible</td><td>PMC Member</td></tr><tr class="a"><td><a name="luc"></a>luc</td><td>Luc Maisonobe</td><td>PMC Chair</td></tr><tr class="b"><td><a name="imario"></a>imario</td><td>Mario Ivankovits</td><td>PMC Member</td></tr><tr class="a"><td><a name="markt"></a>markt</td><td>Mark Thomas</td><td>PMC Member</td></tr><tr class="b"><td><a name="martinc"></a>martinc</td><td>Martin Cooper</td><td>PMC Member (emeritus)</td></tr><tr class="a"><td><a name="mvdb"></a>mvdb</td><td>Martin van den Bemt</td><td>PMC Member</td></tr><tr class="b"><td><a name="mbenson"></a>mbenson<
/td><td>Matt Benson</td><td>PMC Member</td></tr><tr class="a"><td><a name="mturk"></a>mturk</td><td>Mladen Turk</td><td>PMC Member</td></tr><tr class="b"><td><a name="niallp"></a>niallp</td><td>Niall Pemberton</td><td>PMC Member</td></tr><tr class="a"><td><a name="oheger"></a>oheger</td><td>Oliver Heger</td><td>PMC Member</td></tr><tr class="b"><td><a name="psteitz"></a>psteitz</td><td>Phil Steitz</td><td>PMC Member (emeritus)</td></tr><tr class="a"><td><a name="rahul"></a>rahul</td><td>Rahul Akolkar</td><td>PMC Member</td></tr><tr class="b"><td><a name="rgoers"></a>rgoers</td><td>Ralph Goers</td><td>PMC Member</td></tr><tr class="a"><td><a name="rwinston"></a>rwinston</td><td>Rory Winston</td><td>PMC Member</td></tr><tr class="b"><td><a name="sebb"></a>sebb</td><td>Sebastian Bazley</td><td>PMC Member</td></tr><tr class="a"><td><a name="sgoeschl"></a>sgoeschl</td><td>Siegfried Goeschl</td><td>PMC Member</td></tr><tr class="b"><td><a name="simonetripodi"></a>simonetripodi</td><td>Sim
one Tripodi</td><td>PMC Member</td></tr><tr class="a"><td><a name="skitching"></a>skitching</td><td>Simon Kitching</td><td>PMC Member</td></tr><tr class="b"><td><a name="bodewig"></a>bodewig</td><td>Stefan Bodewig</td><td>PMC Member</td></tr><tr class="a"><td><a name="scolebourne"></a>scolebourne</td><td>Stephen Colebourne</td><td>PMC Member</td></tr><tr class="b"><td><a name="tcurdt"></a>tcurdt</td><td>Torsten Curdt</td><td>PMC Member</td></tr></table></div><div class="section"><h3>Contributors<a name="Contributors"></a></h3><a name="Contributors"></a><p>There are no contributors listed for this project. Please check back again later.</p><script type="text/javascript">
+ <div class="section">
+<h2>The Team<a name="The_Team"></a></h2><a name="The_Team"></a>
+<p>A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.</p>
+<p>The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.</p>
+<div class="section">
+<h3>Members<a name="Members"></a></h3><a name="Members"></a>
+<p>The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.</p>
+<table border="0" class="bodyTable">
+<tr class="a">
+<th>Id</th>
+<th>Name</th>
+<th>Roles</th></tr>
+<tr class="b">
+<td><a name="britter"></a>britter</td>
+<td>Benedikt Ritter</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="bspeakmon"></a>bspeakmon</td>
+<td>Benjamin Speakmon</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="billbarker"></a>billbarker</td>
+<td>Bill Barker</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="brentworden"></a>brentworden</td>
+<td>Brent Worden</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="grobmeier"></a>grobmeier</td>
+<td>Christian Grobmeier</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="dfs"></a>dfs</td>
+<td>Daniel Savarese</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="dennisl"></a>dennisl</td>
+<td>Dennis Lundberg</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="ebourg"></a>ebourg</td>
+<td>Emmanuel Bourg</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="ggregory"></a>ggregory</td>
+<td>Gary Gregory</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="henrib"></a>henrib</td>
+<td>Henri Biestro</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="bayard"></a>bayard</td>
+<td>Henri Yandell</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="jcarman"></a>jcarman</td>
+<td>James Carman</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="jochen"></a>jochen</td>
+<td>Jochen Wiedmann</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="pietsch"></a>pietsch</td>
+<td>Joerg Pietschmann</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="joehni"></a>joehni</td>
+<td>Joerg Schaible</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="luc"></a>luc</td>
+<td>Luc Maisonobe</td>
+<td>PMC Chair</td></tr>
+<tr class="b">
+<td><a name="imario"></a>imario</td>
+<td>Mario Ivankovits</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="markt"></a>markt</td>
+<td>Mark Thomas</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="martinc"></a>martinc</td>
+<td>Martin Cooper</td>
+<td>PMC Member (emeritus)</td></tr>
+<tr class="a">
+<td><a name="mvdb"></a>mvdb</td>
+<td>Martin van den Bemt</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="mbenson"></a>mbenson</td>
+<td>Matt Benson</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="mturk"></a>mturk</td>
+<td>Mladen Turk</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="niallp"></a>niallp</td>
+<td>Niall Pemberton</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="oheger"></a>oheger</td>
+<td>Oliver Heger</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="psteitz"></a>psteitz</td>
+<td>Phil Steitz</td>
+<td>PMC Member (emeritus)</td></tr>
+<tr class="a">
+<td><a name="rahul"></a>rahul</td>
+<td>Rahul Akolkar</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="rgoers"></a>rgoers</td>
+<td>Ralph Goers</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="rwinston"></a>rwinston</td>
+<td>Rory Winston</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="sebb"></a>sebb</td>
+<td>Sebastian Bazley</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="sgoeschl"></a>sgoeschl</td>
+<td>Siegfried Goeschl</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="simonetripodi"></a>simonetripodi</td>
+<td>Simone Tripodi</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="skitching"></a>skitching</td>
+<td>Simon Kitching</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="bodewig"></a>bodewig</td>
+<td>Stefan Bodewig</td>
+<td>PMC Member</td></tr>
+<tr class="a">
+<td><a name="scolebourne"></a>scolebourne</td>
+<td>Stephen Colebourne</td>
+<td>PMC Member</td></tr>
+<tr class="b">
+<td><a name="tcurdt"></a>tcurdt</td>
+<td>Torsten Curdt</td>
+<td>PMC Member</td></tr></table></div>
+<div class="section">
+<h3>Contributors<a name="Contributors"></a></h3><a name="Contributors"></a>
+<p>There are no contributors listed for this project. Please check back again later.</p><script type="text/javascript">
function offsetDate(id, offset) {
var now = new Date();
var nowTime = now.getTime();
Modified: websites/staging/commons/trunk/content/volunteering.html
==============================================================================
--- websites/staging/commons/trunk/content/volunteering.html (original)
+++ websites/staging/commons/trunk/content/volunteering.html Mon Oct 14 19:03:35 2013
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Sep 25, 2013 ( $Revision: 1080083 $ ) -->
+<!-- Generated by Apache Maven Doxia at 14 October 2013 ( $Revision: 1080083 $ ) -->
<!-- $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-skin/trunk/src/main/resources/META-INF/maven/site.vm $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
@@ -14,7 +14,7 @@
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="Robert Burrell Donkin" />
<meta name="author" content="Craig R. McClanahan" />
- <meta name="Date-Revision-yyyymmdd" content="20130925" />
+ <meta name="Date-Revision-yyyymmdd" content="20131014" />
<meta http-equiv="Content-Language" content="en" />
</head>
@@ -33,7 +33,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 25 September 2013</span>
+ <span id="publishDate">Last Published: 14 October 2013</span>
</div>
<div class="xright"> <a href="components.html" title="Components">Components</a>
|
@@ -166,26 +166,33 @@
See the License for the specific language governing permissions and
limitations under the License. -->
- <div class="section"><h2>On Volunteering<a name="On_Volunteering"></a></h2>
+ <div class="section">
+<h2>On Volunteering<a name="On_Volunteering"></a></h2>
+
<p>
Apache Commons is a little bit different from other Apache projects. It's an assembly of
components each with its own little community of users, developers and committers.
Of course, there is some overlap between components and an <i>espirit de corps</i>
but Commons is a big, busy Bazaar.
</p>
+
<p>
So, one FAQ is - <i>I'd like to help but how do I volunteer?</i>
Hopefully people asking this have already browsed through the
<a class="externalLink" href="http://www.apache.org/foundation/getinvolved.html">
general Apache documentation</a> but are having troubles getting a grip on Commons.
</p>
+
<p>
Luckily Craig R. McClanahan posted an excellent answer to this very question to
the commons-dev list - <i>so why not get involved?!</i>
</p>
<tt>
+
<p>
-</p><div><pre>
+</p>
+<div>
+<pre>
Prabhat Kumar wrote:
>I was wondering if I could contribute in any way towards this project. I am
@@ -199,8 +206,11 @@ Prabhat Kumar wrote:
>Prabhat.
</pre></div>
+
<p>
-</p><div><pre>Hello Prabhat,
+</p>
+<div>
+<pre>Hello Prabhat,
The best way to contribute is to identify for yourself things that you
think are broken, or could be improved, and then propose a patch. A