You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2014/08/27 13:47:40 UTC
svn commit: r1620868 -
/commons/cms-site/trunk/content/xdoc/releases/release.xml
Author: britter
Date: Wed Aug 27 11:47:40 2014
New Revision: 1620868
URL: http://svn.apache.org/r1620868
Log:
Document how sym links have to be created for components that haven't been released before.
Modified:
commons/cms-site/trunk/content/xdoc/releases/release.xml
Modified: commons/cms-site/trunk/content/xdoc/releases/release.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/releases/release.xml?rev=1620868&r1=1620867&r2=1620868&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/release.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/release.xml Wed Aug 27 11:47:40 2014
@@ -22,7 +22,7 @@
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
-<body>
+<body>
<section name='Publishing The Release - Step By Step'>
<subsection name="Introduction">
@@ -31,8 +31,8 @@
assume that the component uses <code>Maven</code> to build the site.
</p>
<p>
- The starting point for this document is that a release candidate has been created and a
- <code>[VOTE]</code> successfully passed. Guidelines for these preparations can be
+ The starting point for this document is that a release candidate has been created and a
+ <code>[VOTE]</code> successfully passed. Guidelines for these preparations can be
found <a href='prepare.html'>here</a>.
</p>
<p>
@@ -87,22 +87,32 @@
<subsection name='2 Update Release Directory'>
<p>
<strong>Update README</strong><br/>
- 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 release directory
- and edit that.
+ If this is the first release of the component or if this document is not present, then copy
+ one from an existing release directory and edit that. The README must be located at
+ https://dist.apache.org/repos/dist/release/commons/foo/README.html. Furthermore symbolic links
+ have to be created to point from the binaries and source folders to the HEADER.html and
+ README.html files:
</p>
- <p>The README must be https://dist.apache.org/repos/dist/release/commons/foo/README.html</p>
+ <pre>
+ cd binaries
+ ln -s README.html ../README.html
+ ln -s HEADER.html ../HEADER.html
+ cd ../source
+ ln -s README.html ../README.html
+ ln -s HEADER.html ../HEADER.html
+ </pre>
<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.
+ Then update the latest release number in README.html. Please also read through and correct
+ any mistakes you find and fix other items (eg. urls) which need updating.
</p>
<p>
<a name='Check KEYS file'/>
<strong>Check KEYS file</strong><br/>
- Check the <code>KEYS</code> file located in the main release directory. This should contain all the
- public keys which have been used to sign Commons' releases. Make sure that this file exists and
- that it contains the public key you've used to sign these releases. The <code>KEYS</code> file
+ Check the <code>KEYS</code> file located in the main release directory. This should contain all the
+ public keys which have been used to sign Commons' releases. Make sure that this file exists and
+ that it contains the public key you've used to sign these releases. The <code>KEYS</code> file
gives instructions on how to do this.
</p>
</subsection>
@@ -119,16 +129,16 @@
<subsection name="4 Create Subversion Tag for the Final Release">
<p>Copy the release candidate tag in subversion to a name without RC in its name.</p>
</subsection>
-
+
<subsection name='5 Test Main Site Downloads'>
<p>
- Wait until the release files are available from the main Apache web site
+ Wait until the release files are available from the main Apache web site
(<code>http://www.apache.org/dist/commons/foo/</code>), then confirm things are good.
</p>
<p>
Check the main directory:
<ol>
- <li>
+ <li>
Examine the directory listing page. At the bottom should be found the information you
entered into the <code>README.html</code>. Please check that this is correct.
</li>
@@ -138,12 +148,12 @@
<li>
Check the <code>RELEASE-NOTES.txt</code>
</li>
- <li>Download and verify the current distributions, the following might help
+ <li>Download and verify the current distributions, the following might help
<code>committers/tools/releases/verify_sigs.sh</code>. </li>
</ol>
</p>
<p>
- Follow the links to the binaries and source directories.
+ Follow the links to the binaries and source directories.
Check them in a similar manner.
</p>
</subsection>
@@ -152,29 +162,29 @@
<ul>
<li>
<strong>Update trunk version</strong>
- Update current version found in <code>pom.xml</code> in the trunk if it has not already been done.
+ Update current version found in <code>pom.xml</code> in the trunk if it has not already been done.
This should be updated to a <code>SNAPSHOT</code> release, eg change "1.2" to "1.3-SNAPSHOT". If
the component maintains an Ant build and the version is specified in build.xml, make sure to update
this as well.
</li>
<li>
<strong>Publish the website</strong>,
- per the instructions <a href="../site-publish.html">here</a>.
+ per the instructions <a href="../site-publish.html">here</a>.
</li>
</ul>
</subsection>
<subsection name='7 Create Announcements'>
<p>
- Announce the availability of the new release.
+ Announce the availability of the new release.
</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 <code>[ANNOUNCEMENT] Foo 1.2 Released</code>.
+ 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 <code>[ANNOUNCEMENT] Foo 1.2 Released</code>.
Send this mail from your Apache account. Please spell check the document!
</p>
- <p>
- Wait to send the release announcement until you have verified that
+ <p>
+ Wait to send the release announcement until you have verified that
<ol>
<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
@@ -203,7 +213,7 @@
<li><a href="../site-publish.html#Main_site">Stage and publish</a> the main website using the CMS.</li>
</ul>
</subsection>
-
+
<subsection name='9 Post Release Cleanup'>
<p>
That's it! The release is out there - but there is still some tidying up to be done.
@@ -211,9 +221,9 @@
<ul>
<li>
<strong>Remove Obsolete Releases</strong><br/>
- Unless old versions are especially required, remove them from the dist directory. This
+ 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
- save them some diskspace as well as simplifying things for users.
+ save them some diskspace as well as simplifying things for users.
Note that the contents of the http://www.apache.org/dist directory is regularly copied to
http://archive.apache.org/dist.
Deleting files from the standard distribution directories