You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2007/03/28 08:34:32 UTC
svn commit: r523195 [2/2] - in /forrest/site: ./ docs_0_80/ docs_0_80/howto/
procedures/release/
Modified: forrest/site/procedures/release/How_to_release.html
URL: http://svn.apache.org/viewvc/forrest/site/procedures/release/How_to_release.html?view=diff&rev=523195&r1=523194&r2=523195
==============================================================================
--- forrest/site/procedures/release/How_to_release.html (original)
+++ forrest/site/procedures/release/How_to_release.html Tue Mar 27 23:34:31 2007
@@ -266,7 +266,7 @@
<a href="#adjustDocs">Preparing docs for next release cycle</a>
</li>
<li>
-<a href="#BuildDist">Building the distribution</a>
+<a href="#BuildDist">Building the release candidate packages</a>
</li>
<li>
<a href="#vote">Testing the release candidate and voting</a>
@@ -318,7 +318,7 @@
<p>The RM could do the whole job alone, which enables speedy process.
There are not actually many tasks where assistants can help.
However it is a good idea to have an assistant so as to pass
- on the knowledge, to help document it, and to perceive potential flaws.
+ on the knowledge, to help document the process, and to perceive potential flaws.
More than one assistant would probably hinder.
</p>
<p>The RM should be comfortable with using SVN and be familiar with
@@ -481,9 +481,13 @@
<div class="label">Note</div>
<div class="content">There are various reasons for voting on the Release Plan, e.g. makes people aware that a code-freeze
is about to happen; encourage them to get involved with the release; ensure that the date is suitable
- and people will be around to test and then vote on the actual release. See a good discussion <a href="http://marc.theaimsgroup.com/?t=114296877800003">in the archives</a>
-
-</div>
+ and people will be around to test and then vote on the actual release.
+ This ensures that it is the PMC as a whole that prepares and issues the release,
+ rather than an individual. Such procedures give us the protection
+ accorded by the ASF being a corporation.
+ See a good discussion
+ <a href="http://marc.theaimsgroup.com/?t=114296877800003">in the archives</a>.
+ </div>
</div>
</div>
@@ -735,7 +739,7 @@
<a name="N101D6"></a><a name="BuildDist"></a>
-<h2 class="underlined_10">Building the distribution</h2>
+<h2 class="underlined_10">Building the release candidate packages</h2>
<div class="section">
<p>In this phase the Release Manager builds the release candidate to be tested.</p>
<div class="note">
@@ -862,16 +866,20 @@
</li>
<li>
-
-<p>Edit 4 files in tools/forrestbar to update the version number to match the new release: -
- install.rdf, line 24: <em:version>0.7</em:version> - install.js,
- line 19: var err = initInstall("ForrestBar", "forrestbar", "0.7"); -
- xpi/chrome/content/contents.rdf, line 27: chrome:displayName="ForrestBar 0.7"/> -
- xpi/chrome/content/forrestbarOverlay.xul, about line 40 edit the version number as well as
- change the link to point to the new release's docs: <menuitem label="Current
- Docs (0.7)"
- onclick="navigate('http://forrest.apache.org/docs_0_70/index.html');"
- /> </p>
+ Edit 4 files in tools/forrestbar to update the version number to match the new release:
+ <pre class="code">
+install.rdf, line 24: <em:version>0.7</em:version>
+
+install.js, line 19: var err = initInstall("ForrestBar", "forrestbar", "0.7");
+
+xpi/chrome/content/contents.rdf, line 27: chrome:displayName="ForrestBar 0.7"/>
+
+xpi/chrome/content/forrestbarOverlay.xul, about line 40 edit the version number
+ as well as change the link to point to the new release's docs:
+ <menuitem label="Current Docs (0.7)"
+ onclick="navigate('http://forrest.apache.org/docs_0_70/index.html');"/>
+
+ </pre>
<div class="fixme">
<div class="label">Fixme ()</div>
@@ -898,7 +906,7 @@
<li>
<p>Take note of the SVN revision number of your trunk by running <span class="codefrag">svn info</span> from the
- command line in the Release Candidates root dir and look at the "Last Changed Rev: ######".
+ command line in the Release Candidate's root dir and look at the "Last Changed Rev: ######".
This will be used later for the svn log message when the branch is created.
Also it is helpful for ensuring that no new commits have been made,
i.e. people forgetting the code freeze.
@@ -908,36 +916,14 @@
<li>
-<p>Now we will build the release candidates for Windows and Unix.</p>
-
-<div class="note">
-<div class="label">Note</div>
-<div class="content">The reason for creating two separate archives is the line-endings dilemma between Windows and
- UNIX. SVN ensures correct line-endings on each operating system (as long as committers have been
- diligent when adding/updating the repository).</div>
-</div>
+<p>Now we will build the release candidate packages for Windows and Unix.</p>
<ul>
<li>
-
-<p>On a UNIX machine:<br> Change to directory main and run <span class="codefrag">build release-dist</span>
- to generate the distributions on a UNIX machine.</p>
-
-<p> Two archives are created: apache-forrest-X.Y.tar.gz apache-forrest-X.Y.zip. Ignore the
- *.zip archive.</p>
-
-</li>
-
-<li>
-
-<p>On a Windows machine:<br> Change to directory main and run <span class="codefrag">build
- release-dist</span> to generate the distributions on a Windows machine.</p>
-
-<p> Two archives are created: apache-forrest-X.Y.tar.gz apache-forrest-X.Y.zip. Ignore the
- *.tar.gz archive.</p>
-
-</li>
+ Change to directory $FORREST_HOME/main and run <span class="codefrag">'build release-dist'</span>
+ to generate the release candidate packages.
+ </li>
</ul>
@@ -952,7 +938,7 @@
<li>
<a name="signing"></a>
-<p id="signing">Sign the Release Candidates distribution file and create the *.asc and *.md5 files.</p>
+<p id="signing">Sign the Release Candidate packages and create the *.asc and *.md5 files.</p>
<p>Here is one example when using <a href="http://www.gnupg.org/(en)/download/index.html">gpg</a>
and openssl from the command line. </p>
@@ -964,20 +950,19 @@
</div>
<pre class="code">
- gpg --recv-key <myKey>
- gpg --output crossley-apache-forrest-0.7.tar.gz.asc \
- --detach-sig --armor apache-forrest-0.7.tar.gz
- gpg --verify crossley-apache-forrest-0.7.tar.gz.asc \
- apache-forrest-0.7.tar.gz</pre>
+gpg --recv-key <myKey>
+gpg --output crossley-apache-forrest-0.7.tar.gz.asc \
+ --detach-sig --armor apache-forrest-0.7.tar.gz
+gpg --verify crossley-apache-forrest-0.7.tar.gz.asc \
+ apache-forrest-0.7.tar.gz</pre>
<p> ... should say "Good signature from ..."</p>
<pre class="code">
- openssl dgst -md5 -out apache-forrest-0.7.tar.gz.md5 \
- apache-forrest-0.7.tar.gz
- md5sum apache-forrest-0.7.tar.gz
- </pre>
+openssl dgst -md5 -out apache-forrest-0.7.tar.gz.md5 \
+apache-forrest-0.7.tar.gz
+md5sum apache-forrest-0.7.tar.gz</pre>
<p>... output should match that of the md5 file.</p>
@@ -996,7 +981,7 @@
where
'xy' is a compact form of the version (e.g. 04, 041, 05).
'#####' is the SVN revision number that the branch was created from,
- which was the revision that the release candidates were generated from.
+ which was the revision that the release candidate packages were generated from.
(Remember that you recorded this number earlier.)
</pre>
@@ -1010,18 +995,15 @@
</div>
-<a name="N102C8"></a><a name="vote"></a>
+<a name="N102B0"></a><a name="vote"></a>
<h2 class="underlined_10">Testing the release candidate and voting</h2>
<div class="section">
-<p>Get Forrest developers to test the actual distribution on various platforms.</p>
+<p>Get Forrest developers to test the actual packges on various platforms.</p>
<ol>
<li>
-
-<p>Upload the release candidates and signatures to a committer's webspace. Use the .tar.gz from the
- UNIX machine and .zip from the Windows machine.</p>
-
-</li>
+ Upload the release candidate packages and signatures to your committer's webspace.
+ </li>
<li>
@@ -1039,7 +1021,7 @@
<ul>
-<li>Make sure that people are reporting that the distributions unpack on different systems without problems.</li>
+<li>Make sure that people are reporting that the packages unpack on different systems without problems.</li>
<li>Make sure that people have followed the actual user instructions in the Forrest
distribution at README.txt and index.html</li>
@@ -1059,16 +1041,23 @@
introduce new problems.
</li>
-<li>If necessary start again with <a href="#BuildDist">Building the distribution</a> and build another
+<li>If necessary start again with <a href="#BuildDist">Building the packages</a> and build another
release candidate.</li>
<li>Tally the votes and report the result to the dev list.</li>
</ol>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+ It is vitally important that people review and vote against the actual final release packages
+ (and not just against their SVN working copy).
+ </div>
+</div>
</div>
-<a name="N10304"></a><a name="FinalRel"></a>
+<a name="N102EC"></a><a name="FinalRel"></a>
<h2 class="underlined_10">Finalizing the release</h2>
<div class="section">
<p>When a good release candidate has been achieved and affirmed by the vote, we'll finalize the release.</p>
@@ -1141,7 +1130,7 @@
</div>
-<a name="N1034E"></a><a name="UploadAndAnnounce"></a>
+<a name="N10336"></a><a name="UploadAndAnnounce"></a>
<h2 class="underlined_10">Upload and announcement</h2>
<div class="section">
<p>In this phase we'll upload the new Release, wait for it to be available on most mirror sites, then
@@ -1302,7 +1291,7 @@
</div>
-<a name="N10404"></a><a name="cleanup"></a>
+<a name="N103EC"></a><a name="cleanup"></a>
<h2 class="underlined_10">Cleanup</h2>
<div class="section">
<ol>
@@ -1391,14 +1380,14 @@
</li>
<li>
-<p>Remove the release candidates from your public_html directory.</p>
+<p>Remove the release candidate packages from your public_html directory.</p>
</li>
</ol>
</div>
-<a name="N10458"></a><a name="conclusion"></a>
+<a name="N10440"></a><a name="conclusion"></a>
<h2 class="underlined_10">Conclusion</h2>
<div class="section">
<p>All done!</p>
Modified: forrest/site/procedures/release/How_to_release.pdf
URL: http://svn.apache.org/viewvc/forrest/site/procedures/release/How_to_release.pdf?view=diff&rev=523195&r1=523194&r2=523195
==============================================================================
Binary files - no diff available.
Modified: forrest/site/procedures/release/announce_code_freeze.txt
URL: http://svn.apache.org/viewvc/forrest/site/procedures/release/announce_code_freeze.txt?view=diff&rev=523195&r1=523194&r2=523195
==============================================================================
--- forrest/site/procedures/release/announce_code_freeze.txt (original)
+++ forrest/site/procedures/release/announce_code_freeze.txt Tue Mar 27 23:34:31 2007
@@ -4,8 +4,8 @@
=================
Subject: [Important] code-freeze commenced
-The code-freeze is now happening to allow us to pack the
-release candidates and make them available for testing.
+The code-freeze is now happening to allow us to prepare the
+release candidate packages and make them available for testing.
Code-freeze means *no* non-essential commits to the trunk
or to the new release branch. Other branches are free to
@@ -34,7 +34,7 @@
* Actual release date is [date]
[www.timeanddate.com-URL]
-Now we will go and build the releases which might take
+Now we will go and build the packages which might take
some time. The next message will tell you where to get
-the release candidates and describe how to test.
+the release candidate packages and describe how to test.
Modified: forrest/site/procedures/release/test_and_vote_on_rel_cand.txt
URL: http://svn.apache.org/viewvc/forrest/site/procedures/release/test_and_vote_on_rel_cand.txt?view=diff&rev=523195&r1=523194&r2=523195
==============================================================================
--- forrest/site/procedures/release/test_and_vote_on_rel_cand.txt (original)
+++ forrest/site/procedures/release/test_and_vote_on_rel_cand.txt Tue Mar 27 23:34:31 2007
@@ -5,42 +5,53 @@
Subject: [Important] please test release candidate then vote
We need people to test the release candidate on your projects,
-especially on different operating systems. Just send a short
-reply to this thread that it works for you. See method below.
+especially on different operating systems and Java version.
+Just send a short reply to this thread that it works for you.
+See method below.
Download the release candidate and supporting files:
-http://people.apache.org/~[your apache user name]/release-forrest-07/
+http://people.apache.org/~[### your apache ID ###]/release-forrest-08/
For Windows get *.zip md5sum ################################
For UNIX get *.tar.gz md5sum ################################
Get the *.asc and *.md5 that match your chosen download.
It was packed from SVN revision ####
-Java [JavaVersion] or later is required.
+Java [### JavaVersion ###] or later is required.
-If you want to verify the download, then follow:
-http://forrest.apache.org/mirrors.cgi#verify
-
-Otherwise just get on with testing.
-
-Testing and vote period concludes [Date]
+Testing and vote period concludes [#### Date #####] [2].
Anyone can test and vote, not just PMC members.
-However only the PMC votes are binding.
+However only the PMC votes are binding [3].
+
When voting, quote the md5sum to ensure that we are all
-using the correct release candidate.
+using the correct release candidate package.
+
+PMC members need to satisfy themselves that the actual
+final release package meets the ASF principles.
+
+Please wait with voting until towards the end of the
+week, as we may need to build a second release candidate
+if there are any changes to the code or documentation [1].
+
+During this week we do need to hear about successes
+or failures. Please report your operating system
+and Java versions and Jetty/Tomcat versions.
So we have approximately 6 days.
Here are some hints:
- * Ensure that the compressed archive will unpack properly.
* Verfiy the release, especially if you are a committer.
+ Follow: http://forrest.apache.org/mirrors.cgi#verify
+ * Ensure that the compressed archive will unpack properly.
* Follow the README.txt and index.html
* Set $FORREST_HOME and $PATH appropriately.
+ * Try it with different Java versions.
+ * Try it with different versions of Apache Tomcat or Jetty.
* Many known issues are already recorded at our Jira.
* Don't worry too much about minor bugs. We are looking
for blockers, such as it will not run.
- * Please add minor issues to Jira.
+ * Please add other discovered issues to Jira.
* Make a fresh site ...
cd my-new-dir
@@ -62,4 +73,21 @@
* Try it on your own project, especially if you have
a project sitemap and use some extra plugins.
+
+* If you are a user of forrestbot then try that.
+
+* Try building and installing the forrestbar.
+
+------------------------------
+[1] create final release candidate
+Saturday 2007-04-14 at 22:00 UTC
+[### time-and-date URL ###]
+
+[2] end of vote on final release candidate and commence the upload phase
+Monday 2007-04-16 at 22:00 UTC
+[### time-and-date URL ###]
+
+[3] "A lazy majority vote requires
+3 binding +1 votes and more binding +1 votes than -1 votes".
+http://forrest.apache.org/guidelines.html#actions