craigmcc 01/07/14 19:05:17
Modified: docs beanutils.html charter.html commons.html
contributors.html directory.html index.html
license.html sandbox.html
xdocs/stylesheets project.xml
Added: docs releases.html
xdocs releases.xml
Log:
Add a document describing the generic process for releasing a Commons
package. This is (of course) subject to improvement -- comments welcome!
Revision Changes Path
1.10 +2 -0 jakarta-commons/docs/beanutils.html
Index: beanutils.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/beanutils.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- beanutils.html 2001/07/15 00:23:49 1.9
+++ beanutils.html 2001/07/15 02:05:12 1.10
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.10 +2 -0 jakarta-commons/docs/charter.html
Index: charter.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/charter.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- charter.html 2001/07/15 00:23:49 1.9
+++ charter.html 2001/07/15 02:05:12 1.10
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.8 +2 -0 jakarta-commons/docs/commons.html
Index: commons.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/commons.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- commons.html 2001/07/15 00:23:49 1.7
+++ commons.html 2001/07/15 02:05:12 1.8
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.9 +2 -0 jakarta-commons/docs/contributors.html
Index: contributors.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/contributors.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- contributors.html 2001/07/15 00:23:49 1.8
+++ contributors.html 2001/07/15 02:05:13 1.9
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.9 +2 -0 jakarta-commons/docs/directory.html
Index: directory.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/directory.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- directory.html 2001/07/15 00:23:49 1.8
+++ directory.html 2001/07/15 02:05:13 1.9
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.12 +2 -0 jakarta-commons/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/index.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- index.html 2001/07/15 00:25:45 1.11
+++ index.html 2001/07/15 02:05:13 1.12
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.9 +2 -0 jakarta-commons/docs/license.html
Index: license.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/license.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- license.html 2001/07/15 00:23:49 1.8
+++ license.html 2001/07/15 02:05:13 1.9
@@ -91,6 +91,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.12 +2 -0 jakarta-commons/docs/sandbox.html
Index: sandbox.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/sandbox.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- sandbox.html 2001/07/15 00:23:49 1.11
+++ sandbox.html 2001/07/15 02:05:14 1.12
@@ -90,6 +90,8 @@
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
+ <li> <a href="./releases.html">Releases</a>
+</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
1.1 jakarta-commons/docs/releases.html
Index: releases.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="author"
value="Commons Documentation Team">
<meta name="email" value="[EMAIL PROTECTED]">
<title>Commons - Creating Commons Package Releases</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td align="left">
<a href="http://jakarta.apache.org";><img
src="http://jakarta.apache.org/images/jakarta-logo.gif"; border="0"/></a>
</td>
<td align="right">
<a href="http://jakarta.apache.org/commons/";><img src="./images/logo.jpg"
alt="Commons" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top" nowrap="true">
<p><strong>Home</strong></p>
<ul>
<li> <a href="./index.html">Jakarta Commons</a>
</li>
</ul>
<p><strong>About Us</strong></p>
<ul>
<li> <a href="./contributors.html">Contributors</a>
</li>
<li> <a href="./license.html">License</a>
</li>
</ul>
<p><strong>Information</strong></p>
<ul>
<li> <a href="./index.html">Overview</a>
</li>
<li> <a href="./commons.html">Commons Proper</a>
</li>
<li> <a href="./directory.html">Directory</a>
</li>
<li> <a href="./sandbox.html">Sandbox</a>
</li>
</ul>
<p><strong>Components Repository</strong></p>
<ul>
<li> <a href="./beanutils.html">BeanUtils</a>
</li>
<li> <a href="./cactus/index.html">Cactus</a>
</li>
<li> <a
href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/collections/";>Collections</a>
</li>
<li> <a
href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/digester/";>Digester</a>
</li>
<li> <a
href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/dbcp/";>DBCP</a>
</li>
<li> <a
href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/httpclient/";>HTTP
Client</a>
</li>
<li> <a
href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/pool/";>Pool</a>
</li>
</ul>
<p><strong>Jakarta Community</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/getinvolved.html";>Get Involved</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/cvsindex.html";>CVS Repositories</a>
</li>
</ul>
<p><strong>Project Docs</strong></p>
<ul>
<li> <a href="./charter.html">Charter</a>
</li>
<li> <a href="./releases.html">Releases</a>
</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
<table
border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Introduction"><strong>Introduction</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>The <em>Jakarta Commons</em> project differs
from many other Jakarta
hosted projects because it is comprised of multiple, independently
released packages. Therefore, the release procedure for an individual
package needs to be documented so that package authors follow consistent
practices.</p>
<p>Individual packages (such as
Cactus) might vary from these practices
because they are somewhat larger than the typical Commons package, but
these steps should prove sufficient for the majority of cases.</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Step By Step Instructions"><strong>Step By Step
Instructions</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>The following steps are required to create
and deploy a release version
of a Commons library package. The <code>example text</code> consistently
assumes that we are releasing version <em>1.2</em> of the <em>foo</em>
package.</p>
<ol>
<li>Announce your proposed release of a particular package to the
<strong>[EMAIL PROTECTED]</strong> mailing list,
and ask for a vote. Per the Commons Project charter, votes of
committers on the particular package in question (as listed in the
<code>STATUS.html</code> file) are binding.<br /><br /></li>
<li>Log on to daedalus (via SSH) and create a new subdirectory for the
release you are about to create. For example:
<pre>
cd /www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/
mkdir v1.2
</pre></li>
<li>Check out and thoroughly test the package code that you plan to
release.<br /><br /></li>
<li>Update the project version number in the <code>build.xml</code>
file for this project. If the <code>foo</code> project follows
the usual <code>build.xml</code> conventions, there will be an
Ant property named <code>component.version</code> that would be
updated to <code>1.2</code>. Check in any files you have
modified.<br /><br /></li>
<li>Tag <strong>only</strong> the files in the subdirectory for this
package with the package name (in caps) and version number for the
package you are creating. For example,
<pre>
cd $JAKARTA_COMMONS_HOME/foo
cvs tag FOO_1_2
</pre></li>
<li>Regenerate the binary distribution of the code by running the
<code>dist</code> target. Review the generated documentation
to ensure that it correctly reflects the functionality (and the
version number) of this code.<br /><br /></li>
<li>Based on the contents of the <code>dist</code> subdirectory that
was created by the previous step, create the binary distributions
for this release. For example,
<pre>
cd $JAKARTA_COMMONS_HOME/foo
mv dist commons-foo-1.2
tar zcvf commons-foo-1.2.tar.gz commons-foo-1.2
zip -r commons-foo-1.2.zip commons-foo-1.2
mv commons-foo-1.2 dist
</pre></li>
<li>Upload the binary distribution files to the newly created directory
on daedalus. For example (where "xyz" is your login),
<pre>
cd $JAKARTA_COMMONS_HOME/foo
scp commons-foo-1.2.* \
[EMAIL PROTECTED]:/www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/v1.2/
</pre></li>
<li>Log in to daedalus and create the source distributions, based on the
tag specified earlier, and move these files to the distribution
directory as well. For example,
<pre>
mkdir temp
cd temp
cvs -d /home/cvspublic export -r FOO_1_2 jakarta-commons
mv jakarta-commons commons-foo-1.2-src
tar zcvf commons-foo-1.2-src.tar.gz commons-foo-1.2-src
zip -r commons-foo-1.2-src.zip commons-foo-1.2-src
rm -rf commons-foo-1.2-src
mv commons-foo-1.2-src.* \
/www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/v1.2/
</pre></li>
<li>Follow standard procedures to update the Jakarta web site (stored in
CVS repository <code>jakarta-site2</code> to reflect the availability
of the new release. Generally, you will be updating the following
pages:
<ul>
<li><code>xdocs/site/binindex.xml</code> - Create a link to the
release directory under the <strong>Release Builds</strong>
heading.</li>
<li><code>xdocs/site/sourceindex.xml</code> - Create a link to the
release directory under the <strong>Release Builds</strong>
heading.</li>
<li><code>xdocs/site/news.xml</code> - Create a news item that
describes the new release, and includes hyperlinks to the
release directory.</li>
</ul><br /><br /></li>
<li>Announce the availability of the new package on (at least) the
following mailing lists:
<ul>
<li>[EMAIL PROTECTED]</li>
<li>[EMAIL PROTECTED]</li>
<li>[EMAIL PROTECTED]</li>
</ul><br /><br /></li>
</ol>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2001, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
1.1 jakarta-commons/xdocs/releases.xml
Index: releases.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Creating Commons Package Releases</title>
<author email="[EMAIL PROTECTED]">Commons Documentation Team</author>
</properties>
<body>
<section name="Introduction">
<p>The <em>Jakarta Commons</em> project differs from many other Jakarta
hosted projects because it is comprised of multiple, independently
released packages. Therefore, the release procedure for an individual
package needs to be documented so that package authors follow consistent
practices.</p>
<p>Individual packages (such as Cactus) might vary from these practices
because they are somewhat larger than the typical Commons package, but
these steps should prove sufficient for the majority of cases.</p>
</section>
<section name="Step By Step Instructions">
<p>The following steps are required to create and deploy a release version
of a Commons library package. The <code>example text</code> consistently
assumes that we are releasing version <em>1.2</em> of the <em>foo</em>
package.</p>
<ol>
<li>Announce your proposed release of a particular package to the
<strong>[EMAIL PROTECTED]</strong> mailing list,
and ask for a vote. Per the Commons Project charter, votes of
committers on the particular package in question (as listed in the
<code>STATUS.html</code> file) are binding.<br/><br/></li>
<li>Log on to daedalus (via SSH) and create a new subdirectory for the
release you are about to create. For example:
<pre>
cd /www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/
mkdir v1.2
</pre></li>
<li>Check out and thoroughly test the package code that you plan to
release.<br/><br/></li>
<li>Update the project version number in the <code>build.xml</code>
file for this project. If the <code>foo</code> project follows
the usual <code>build.xml</code> conventions, there will be an
Ant property named <code>component.version</code> that would be
updated to <code>1.2</code>. Check in any files you have
modified.<br/><br/></li>
<li>Tag <strong>only</strong> the files in the subdirectory for this
package with the package name (in caps) and version number for the
package you are creating. For example,
<pre>
cd $JAKARTA_COMMONS_HOME/foo
cvs tag FOO_1_2
</pre></li>
<li>Regenerate the binary distribution of the code by running the
<code>dist</code> target. Review the generated documentation
to ensure that it correctly reflects the functionality (and the
version number) of this code.<br/><br/></li>
<li>Based on the contents of the <code>dist</code> subdirectory that
was created by the previous step, create the binary distributions
for this release. For example,
<pre>
cd $JAKARTA_COMMONS_HOME/foo
mv dist commons-foo-1.2
tar zcvf commons-foo-1.2.tar.gz commons-foo-1.2
zip -r commons-foo-1.2.zip commons-foo-1.2
mv commons-foo-1.2 dist
</pre></li>
<li>Upload the binary distribution files to the newly created directory
on daedalus. For example (where "xyz" is your login),
<pre>
cd $JAKARTA_COMMONS_HOME/foo
scp commons-foo-1.2.* \
[EMAIL PROTECTED]:/www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/v1.2/
</pre></li>
<li>Log in to daedalus and create the source distributions, based on the
tag specified earlier, and move these files to the distribution
directory as well. For example,
<pre>
mkdir temp
cd temp
cvs -d /home/cvspublic export -r FOO_1_2 jakarta-commons
mv jakarta-commons commons-foo-1.2-src
tar zcvf commons-foo-1.2-src.tar.gz commons-foo-1.2-src
zip -r commons-foo-1.2-src.zip commons-foo-1.2-src
rm -rf commons-foo-1.2-src
mv commons-foo-1.2-src.* \
/www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/v1.2/
</pre></li>
<li>Follow standard procedures to update the Jakarta web site (stored in
CVS repository <code>jakarta-site2</code> to reflect the availability
of the new release. Generally, you will be updating the following
pages:
<ul>
<li><code>xdocs/site/binindex.xml</code> - Create a link to the
release directory under the <strong>Release Builds</strong>
heading.</li>
<li><code>xdocs/site/sourceindex.xml</code> - Create a link to the
release directory under the <strong>Release Builds</strong>
heading.</li>
<li><code>xdocs/site/news.xml</code> - Create a news item that
describes the new release, and includes hyperlinks to the
release directory.</li>
</ul><br/><br/></li>
<li>Announce the availability of the new package on (at least) the
following mailing lists:
<ul>
<li>[EMAIL PROTECTED]</li>
<li>[EMAIL PROTECTED]</li>
<li>[EMAIL PROTECTED]</li>
</ul><br/><br/></li>
</ol>
</section>
</body>
</document>
1.9 +1 -0 jakarta-commons/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/xdocs/stylesheets/project.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- project.xml 2001/05/21 20:13:02 1.8
+++ project.xml 2001/07/15 02:05:16 1.9
@@ -40,6 +40,7 @@
</menu>
<menu name="Project Docs">
<item name="Charter" href="/charter.html"/>
+ <item name="Releases" href="/releases.html"/>
</menu>
</body>
</project>
![http://jakarta.apache.org/images/jakarta-logo.gif"](http://jakarta.apache.org/images/jakarta-logo.gif"){kind=link}