commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: jakarta-commons/xdocs/releases prepare.xml release.xml
Date Fri, 25 Apr 2003 10:26:45 GMT
rdonkin     2003/04/25 03:26:45

  Modified:    xdocs/releases prepare.xml release.xml
  Improved release documents
  Revision  Changes    Path
  1.3       +18 -3     jakarta-commons/xdocs/releases/prepare.xml
  Index: prepare.xml
  RCS file: /home/cvs/jakarta-commons/xdocs/releases/prepare.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- prepare.xml	7 Apr 2003 09:05:07 -0000	1.2
  +++ prepare.xml	25 Apr 2003 10:26:45 -0000	1.3
  @@ -19,6 +19,17 @@
       The <code>example text</code> consistently assumes that preparation are
being made to release 
       version <em>1.2</em> of component <em>foo</em>.
  +            <subsection name='Consider A Release Branch'>
  +                    <p>
  +Consider whether a release branch is needed. This is judgement call. A release branch increases
  +complexity of the release but can help to prevent misunderstandings. Usually, for a small
  +only good communication is needed. 
  +            </p>
  +                    <p>
  +These documents assume a release from <code>CVS HEAD</code>. Some small modification
to the procedure
  +may be needed when using a release branch.
  +            </p>
  +        </subsection>
     <section name="Preparations">
       <subsection name='Update The Jar Manifest'>
  @@ -55,7 +66,7 @@
       <subsection name='Release Notes'>
  -        <p>
  +            <p>
           Different components have their own ways of creating release notes. 
           Here's the hard way!
  @@ -63,6 +74,10 @@
           Go through the CVS logs for all source files which have changed since the last
           Analyse the log messages. Enhancements and new features need to be collated by
           Bugs fixed should be listed separately together with a short summary of the bug.
  +        A little time may be saved by checking the logs only for the source files.
  +        </p>
  +            <p>
  +Please remember to spell check the release notes. Please break lines at 80 characters.
       <subsection name='Test Against Listed Dependencies'>    
  @@ -98,7 +113,7 @@
           Now tag (for example <code>FOO_1_2_RC1</code>) and build distributions
from that tag 
  -        (as per full release). For commons components, it's usually unnecessary to post
  +        (as <a href='release.html'>per full release</a>). For commons components,
it's usually unnecessary to post the 
           release candidate on the main release site. (It's usually good enough to upload
           into the public folder <em>~/public_html</em> in your home directory

           on <code></code>.)
  @@ -122,7 +137,7 @@
       <subsection name='Final Preparations'>
           Once the vote has succeeded, then post a <code>[RESULT][VOTE] Release foo
1.0</code> email to 
  -        <strong></strong> and cc <strong></strong>.
  +        <strong></strong> and cc <strong></strong>.
           Tag the release now. (This will ensure that there are no problems with badly timed
  1.4       +1 -1      jakarta-commons/xdocs/releases/release.xml
  Index: release.xml
  RCS file: /home/cvs/jakarta-commons/xdocs/releases/release.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- release.xml	15 Apr 2003 11:48:38 -0000	1.3
  +++ release.xml	25 Apr 2003 10:26:45 -0000	1.4
  @@ -509,7 +509,7 @@
   Please remember to give a brief description of you component. Please also remember to remind
   about verifying the signatures. The subject should be something like <code>[ANNOUNCEMENT]
Foo 1.2 Released</code>. 
  -You might like to send this mail from your apache account. Please spell check the document!
  +Send this mail from your apache account. Please spell check the document!
   This should go to (at least) the following mailing lists:

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message