You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by hu...@apache.org on 2004/05/03 02:29:40 UTC
cvs commit: jakarta-commons/docs/releases release.html
husted 2004/05/02 17:29:40
Modified: docs/releases release.html
Log:
Change references from daedalus to minotaur
Revision Changes Path
1.35 +72 -72 jakarta-commons/docs/releases/release.html
Index: release.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/releases/release.html,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- release.html 14 Mar 2004 20:35:05 -0000 1.34
+++ release.html 3 May 2004 00:29:40 -0000 1.35
@@ -18,7 +18,7 @@
<!-- Content Stylesheet for Site -->
-
+
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
@@ -30,14 +30,14 @@
<meta name="author" value="Commons Documentation Team">
<meta name="email" value="commons-dev@jakarta.apache.org">
-
-
-
-
+
+
+
+
<title>Commons - Cutting The Release</title>
</head>
- <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
@@ -53,11 +53,11 @@
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
-
+
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top" nowrap="true">
-
+
<!-- ============================================================ -->
<p><strong>About Us</strong></p>
@@ -139,7 +139,7 @@
<blockquote>
<p>
This document gives step-by-step instructions for cutting a release. These instructions
- assume that the component uses an <code>Ant</code> based master build. If the component
+ assume that the component uses an <code>Ant</code> based master build. If the component
being released uses a <code>Maven</code> based master build then you'll need to improvise a little!
Any patches for <code>Maven</code> based master builds will be gratefully received.
</p>
@@ -157,16 +157,16 @@
<tr><td>
<blockquote>
<p>
- Throughout this document, the <code>example text</code> consistently assumes that version <em>1.2</em>
+ Throughout this document, the <code>example text</code> consistently assumes that version <em>1.2</em>
of component <em>foo</em> is being released by release manager <em>rdonkin</em>.
</p>
<p>
The starting point for this document is that all the preparations for the release have been completed,
- a release candidate created and a release <code>[VOTE]</code> successfully passed.
+ a release candidate created and a release <code>[VOTE]</code> successfully passed.
Guidelines for these preparations can be found <a href="prepare.html">here</a>.
</p>
<p>
- In particular, the build version for the component must have been updated to the release number.
+ In particular, the build version for the component must have been updated to the release number.
This is found in <code>build.xml</code>. The component should also be tested and the documentation
reviewed.
</p>
@@ -183,7 +183,7 @@
<tr><td>
<blockquote>
<p>
- Prepare a local working directory to do all the zipping, signing and so on.
+ Prepare a local working directory to do all the zipping, signing and so on.
The <code>examples</code> assume this directory is called <code>release/foo</code>.
</p>
</blockquote>
@@ -199,8 +199,8 @@
<tr><td>
<blockquote>
<p>
- The release code should already have been tagged. Update the CVS checkout
- (from which the release will be cut) to this tagged version.
+ The release code should already have been tagged. Update the CVS checkout
+ (from which the release will be cut) to this tagged version.
</p>
<pre>
$ cd jakarta-commons/foo/
@@ -223,7 +223,7 @@
<tr><td>
<blockquote>
<p>
- Clean build the binary distribution in the standard way.
+ Clean build the binary distribution in the standard way.
</p>
<pre>
$ ant clean
@@ -245,7 +245,7 @@
<tr><td>
<blockquote>
<p>
-Move the binary distributions (created above) to the local working directory
+Move the binary distributions (created above) to the local working directory
and then create compressed binary releases:
<pre>
$ mv dist ~/jakarta/release/foo/commons-foo-1.2
@@ -282,7 +282,7 @@
Logging in to :pserver:anoncvs@cvs.apache.org:/home/cvspublic
CVS password: (anoncvs)
-$ cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic export -r FOO_1_2 jakarta-commons
+$ cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic export -r FOO_1_2 jakarta-commons
</pre>
</li>
<li>
@@ -290,12 +290,12 @@
<pre>
$ mv jakarta-commons/foo ../commons-foo-1.2-src
$ cd ..
-$ rm -rf temp
+$ rm -rf temp
</pre>
</li>
<li>
Create tar.gz and zipped source releases:
-<pre>
+<pre>
$ 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
</pre>
@@ -315,8 +315,8 @@
<tr><td>
<blockquote>
<p>
-MD5 is the standard hash algorithm used by Apache to allow users to verify the integrity of releases.
-There are various applications which can be used to create md5 checksums.
+MD5 is the standard hash algorithm used by Apache to allow users to verify the integrity of releases.
+There are various applications which can be used to create md5 checksums.
</p>
<p>
For example md5sum (on Linux):
@@ -330,7 +330,7 @@
to <code>a76169177e7a9b58118bcd993aff4a5e</code>).
</p>
<p>
-Create md5 sums for the binary and source releases, both tarred and zipped versions.
+Create md5 sums for the binary and source releases, both tarred and zipped versions.
These should be stored in files whose names are formed by suffixing the original <code>.md5</code>.
So, you should end up with the following files:
</p>
@@ -354,38 +354,38 @@
<blockquote>
<p>
OpenPGP (RFC2440) compatible detached signatures needed to be created for all releases.
-Various applications can be used to create these signatures.
+Various applications can be used to create these signatures.
For example,
<a href="http://www.gnupg.org">Gnu Privacy Guard</a> on linux:
</p>
<p>
-General instructions about signing releases can be found
+General instructions about signing releases can be found
<a href="http://nagoya.apache.org/wiki/apachewiki.cgi?SigningReleases">here</a>.
</p>
<pre>
-$ gpg --armor --output commons-foo-1.2-src.tar.gz.asc --detach-sig commons-foo-1.2-src.tar.gz
+$ gpg --armor --output commons-foo-1.2-src.tar.gz.asc --detach-sig commons-foo-1.2-src.tar.gz
You need a passphrase to unlock the secret key for
user: "Robert Burrell Donkin (CODE SIGNING KEY) <rdonkin@apache.org>"
1024-bit DSA key, ID B1313DE2, created 2003-01-15
</pre>
<p>
-Signatures for all varieties of release need to be create. The signature files should be
+Signatures for all varieties of release need to be create. The signature files should be
named after the original with <code>.asc</code> suffixed.
</p>
<pre>
-$ gpg --armor --output commons-foo-1.2-src.tar.gz.asc --detach-sig commons-foo-1.2-src.tar.gz
+$ gpg --armor --output commons-foo-1.2-src.tar.gz.asc --detach-sig commons-foo-1.2-src.tar.gz
$ gpg --armor --output commons-foo-1.2-src.zip.asc --detach-sig commons-foo-1.2-src.zip
$ gpg --armor --output commons-foo-1.2.zip.asc --detach-sig commons-foo-1.2.zip
$ gpg --armor --output commons-foo-1.2.tar.gz.asc --detach-sig commons-foo-1.2.tar.gz
</pre>
<p>
-If this is the first release you've cut for this component, then the code signing public key
+If this is the first release you've cut for this component, then the code signing public key
must be added to the <a href="#Check KEYS file"><code>KEYS</code> file for the component</a>.
-This can be found on Daedelus (www.apache.org) at
+This can be found on minotaur (www.apache.org) at
<pre>
/www/www.apache.org/dist/jakarta/commons/logging/foo/KEYS
</pre>
-If this file is not present, it needs to be created.
+If this file is not present, it needs to be created.
</p>
</blockquote>
</td></tr>
@@ -436,10 +436,10 @@
% openssl md5 <commons-foo-1.2.tar.gz
460fa7ad1e9ee2b5c4acab4971402395
-% cat commons-foo-1.2.tar.gz.md5
+% cat commons-foo-1.2.tar.gz.md5
460fa7ad1e9ee2b5c4acab4971402395
-% openssl md5 <commons-foo-1.2.zip
+% openssl md5 <commons-foo-1.2.zip
d5f98c73f2450e09cc2b1af9509934f0
% cat commons-foo-1.2.zip.md5
d5f98c73f2450e09cc2b1af9509934f0
@@ -459,7 +459,7 @@
<tr><td>
<blockquote>
<p>
-Upload the following to your home directory on daedalus:
+Upload the following to your home directory on minotaur:
<ul>
<li>all the release distributions</li>
<li>the detached signature files (<code>.asc</code>) for these releases</li>
@@ -473,12 +473,12 @@
</p>
<pre>
% scp release.tar.gz rdonkin@www.apache.org:~/
-release.tar.gz 100% |*********************************| 841 KB 00:46
+release.tar.gz 100% |*********************************| 841 KB 00:46
% ssh -l rdonkin www.apache.org
</pre>
<p>
-Untar in a working directory (named <code>release</code>, say).
-Remember to make sure that the group is <em>jakarta</em>,
+Untar in a working directory (named <code>release</code>, say).
+Remember to make sure that the group is <em>jakarta</em>,
that they are world readable and that they are group read-writable.
</p>
<pre>
@@ -499,22 +499,22 @@
<tr><td>
<blockquote>
<p>
-Change directory to the main mirrored distribution directory for your component.
-If this is missing, then this is the first mirrored release for this component.
+Change directory to the main mirrored distribution directory for your component.
+If this is missing, then this is the first mirrored release for this component.
Read <a href="mirror.html">these guidelines</a> before continuing.
</p>
<pre>
> cd /www/www.apache.org/dist/jakarta/commons/foo/
</pre>
<p>
-Move source distributions, their detached signatures and md5 sums into position.
+Move source distributions, their detached signatures and md5 sums into position.
All source versions live in the source subdirectory.
</p>
<pre>
> mv ~/release/commons-foo-1.2-src* source
</pre>
<p>
-Move the binary distributions, their detached signatures and md5 sums into position.
+Move the binary distributions, their detached signatures and md5 sums into position.
All binary versions live in the <em>binaries</em> subdirectory.
</p>
<pre>
@@ -538,16 +538,16 @@
<ul>
<li>
<strong>Update README.html</strong>
- The contents of the <code>README.html</code> 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 document is not present, then copy one from an existing commons mirrored release directory
and edit that.
<pre>
-> vi README.html
+> vi README.html
</pre>
Update the latest release number. Please also read through and correct any mistakes you find
-and fix other items (eg. urls) which need updating. If your component is missing a <code>README.html</code>
+and fix other items (eg. urls) which need updating. If your component is missing a <code>README.html</code>
then add a new one modeled on a copy in another component.
</li>
<li>
@@ -561,7 +561,7 @@
<li>
<a name="Check KEYS file" />
<strong>Check KEYS file</strong>
-Check the <code>KEYS</code> file located in the main release directory. This should contain all the public keys
+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 the component's releases. Make sure that this file exists and that it contains
the public key you've used to sign these releases. (The <code>KEYS</code> file should give instructions about
how to do this.)
@@ -579,7 +579,7 @@
</li>
<li>recreate links to current distribution
<pre>
-> ln -s source/commons-foo-1.2-src.tar.gz commons-foo-current-src.tar.gz
+> ln -s source/commons-foo-1.2-src.tar.gz commons-foo-current-src.tar.gz
> ln -s source/commons-foo-1.2-src.tar.gz.asc commons-foo-current-src.tar.gz.asc
> ln -s source/commons-foo-1.2-src.tar.gz.md5 commons-foo-current-src.tar.gz.md5
> ln -s source/commons-foo-1.2-src.zip commons-foo-current-src.zip
@@ -591,7 +591,7 @@
> ln -s binaries/commons-foo-1.2.zip commons-foo-current.zip
> ln -s binaries/commons-foo-1.2.zip.md5 commons-foo-current.zip.md5
> ln -s binaries/commons-foo-1.2.zip.asc commons-foo-current.zip.asc
-</pre>
+</pre>
</li>
<li>Please test that these links function correctly.</li>
</ol>
@@ -604,7 +604,7 @@
</pre>
Check that they are the right ones:
<pre>
-> less RELEASE-NOTES.txt
+> less RELEASE-NOTES.txt
</pre>
</li>
</ul>
@@ -621,8 +621,8 @@
<tr><td>
<blockquote>
<p>
- You should now be able to get the new release from the main apache web site
- (<code>http://www.apache.org/dist/jakarta/commons/foo/</code>).
+ You should now be able to get the new release from the main apache web site
+ (<code>http://www.apache.org/dist/jakarta/commons/foo/</code>).
</p>
<p>
Check the main directory:
@@ -655,31 +655,31 @@
<tr><td>
<blockquote>
<p>
-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).
+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).
Remember to <code>cvs up -d -P</code> before you edit.
</p>
<ul>
<li>
<strong>Update Jakarta Download Pages</strong>
-Update the Jakarta binary (<code>jakarta-site2/xdocs/site/binindex.xml</code>) and
+Update the Jakarta binary (<code>jakarta-site2/xdocs/site/binindex.xml</code>) and
source (jakarta-site2/<code>xdocs/site/sourceindex.xml</code>) download pages.
If your component is already listed then you just need to correct the version number.
-If your component is not listed then you need to add links to your component.
+If your component is not listed then you need to add links to your component.
(Instructions are given in <a href="mirror.html">First Time Mirroring</a>.)
</li>
<li>
<strong>Update News Page</strong>
Add a standard news item announcing the release to the Jakarta news page
-(<code>jakarta-site2/xdocs/site/news.xml</code>).
-This should be similar to the announcement you'll post later to email lists.
-Please remember to include a description of your component.
+(<code>jakarta-site2/xdocs/site/news.xml</code>).
+This should be similar to the announcement you'll post later to email lists.
+Please remember to include a description of your component.
Please also add a reminder about verifying signature.
</li>
<li>
<strong>Update Welcome Page</strong>
Add a link to the news item to Jakarta welcome page (<code>jakarta-site2/xdocs/index.xml</code>)
-in the 'Product News' section. You might like to trim older items off the bottom of this
+in the 'Product News' section. You might like to trim older items off the bottom of this
list. (Leave at least 5 items of news.)
</li>
<li>
@@ -688,15 +688,15 @@
<pre>
% ant
</pre>
-Check the generated documents (<code>jakarta-site2/docs</code>) for spelling mistakes
+Check the generated documents (<code>jakarta-site2/docs</code>) for spelling mistakes
and also check that the links to the releases on the main site are working.
Don't worry about links to the mirrors at this stage since they won't be working.
-Once everything looks good, commit the changes.
+Once everything looks good, commit the changes.
<pre>
% cvs -q ci -m "Update to reflect commons-foo 1.2 release"
</pre>
-If you have an account on daedalus, log in and update the web site.
+If you have karma to jakarta-site2, log in and update the web site.
(If not, you'll need to ask on commons-dev or general@jakarta.)
<pre>
@@ -721,7 +721,7 @@
<ul>
<li>
<strong>Update Links</strong>.
- Update the API Docs and Release notes links (whilst you're still logged in on daedalus)
+ Update the API Docs and Release notes links (whilst you're still logged in on minotaur)
<pre>
> cd /www/jakarta.apache.org/commons/foo
> rm RELEASE-NOTES.txt
@@ -734,14 +734,14 @@
</li>
<li>
<strong>Update Shared Pages</strong>.
- (You can log off daedalus now.)
+ (You can log off minotaur now.)
Edit the commons components page (<code>jakarta-commons/xdocs/components.xml</code>) to reflect the
new release. Add the new release to the list under the component description. If the list of releases
for your component is getting long then please consider removing some of the older ones.
Check, commit and then update the web site in the normal manner.
<pre>
> cd /www/jakarta.apache.org/commons/
-> cvs -q up
+> cvs -q up
</pre>
</li>
<li>
@@ -750,8 +750,8 @@
</li>
<li>
<strong>Check commons release directory</strong>
-Check the commons release directory for your component on Daedalus
-(<code>www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/</code>).
+Check the commons release directory for your component on minotaur
+(<code>www/jakarta.apache.org/builds/jakarta-commons/release/commons-foo/</code>).
Make sure that it has a <code>README.html</code> telling users that new release should be
obtained through the mirrors.
If this file does not exist, please create one.
@@ -771,12 +771,12 @@
<tr><td>
<blockquote>
<p>
-Announce the availability of the new release.
+Announce the availability of the new release.
You can probably use the news item create earlier as a basis for the announcement body.
</p>
<p>
-Please remember to give a brief description of you component. Please also remember to remind people
-about verifying the signatures. The subject should be something like <code>[ANNOUNCEMENT] Foo 1.2 Released</code>.
+Please remember to give a brief description of you component. Please also remember to remind people
+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>
<p>
@@ -838,8 +838,8 @@
<tr><td>
<blockquote>
<p>
-Check in bugzilla for all bugs which have been marked <code>LATER</code> and reopen them.
-If you need some changes made to bugzilla (for example, a new version number adding)
+Check in bugzilla for all bugs which have been marked <code>LATER</code> and reopen them.
+If you need some changes made to bugzilla (for example, a new version number adding)
please contact Martin van den Bemt (mvdb at apache.org).
</p>
<p>
@@ -863,7 +863,7 @@
<tr><td>
<blockquote>
<p>
- Feedback - yes please!
+ Feedback - yes please!
</p>
<p>
Comments, critiques and error reports -
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org