[CMF-checkins] CVS: CMF - RELEASE.txt:1.1 CHANGES.txt:1.291

[Jens Vagelpohl]

Update of /cvs-repository/CMF
In directory cvs.zope.org:/tmp/cvs-serv32678

Modified Files:
	CHANGES.txt 
Added Files:
	RELEASE.txt 
Log Message:
- To document how to create a CMF release from CMF a description is now
  included in RELEASE.txt at the root of the CMF package. This text can
  guide release managers or volunteers with the appropriate release
  privileges.



=== Added File CMF/RELEASE.txt ===
RELEASE.txt - notes for creating a CMF release

  Most of the work necessary to create a CMF release is done by the script
  'slurp_release.py', which can always be found in the root of the CMF 
  package on CVS-HEAD. The script will CVS export the CMF package, build the
  tarballs, and upload them and the respective READMEs to the CMF area on
  www.zope.org.

  Before running 'slurp_release.py' the respective branch needs to be cleaned
  up and tagged properly.


  **Naming conventions**

    In order to stay consistent the following naming conventions for CMF
    versions and for CVS tags used to tag releases should be used,
    demonstrated with the help of a notional 1.8.4 release:

      - CMF beta versions are '1.8.4beta' and '1.8.4beta2' for the second
        beta. The same is true for alpha releases if one is desired.
        '1.8.4alpha2' follows '1.8.4alpha'. Alpha releases should only
        be necessary for the first release off a new release branch. The final
        version would then be '1.8.4'

      - CVS tags follow the convention 'CMF-1_8_4-release' or
        'CMF-1_8_4-beta'. As with version numbers, 'CMF-1_8_4-beta2' would
        indicate the second beta release.

      - Branch tags in CVS look like 'CMF-1_8-branch' for the branch that
        would yield e.g. version 1.8.4


  **Preparing the branch**

    To release version '1.8.4beta2' off the 'CMF-1_8-branch' the following
    steps are needed. It is assumed the release manager is using the HEAD
    of the 'CMF-1_8-branch' to make these changes:

      - At the top of 'CHANGES.txt', enter the current date as YYYY/MM/DD
        in parentheses next to the CMF version number.

      - Find all 'version.txt' files throughout the CMF pacckage and adjust 
        the version number, in this case 'CMF-1.8.4beta2'.

      - Check these changes into the CVS repository

      - Tag the sandbox, in this case with the tag 'CMF-1_8_4beta2'


  **Creating and publishing the release**

    With CVS preparations done the 'slurp_release.py' script will do the
    remaining work. You run it with the CVS tag and version ID as parameters::

      slurp_release.py [options] release_tag version_id

    Without any options it will complete the whole procedure including upload
    to the zope.org site. Use 'slurp_release.py --help' to find out more.

    Once 'slurp_release.py' has completed the upload step you need to visit
    the uploaded files on zope.org and make sure they get published on the 
    site.


  **Announcing the release**

    An announcement email should go out to zope-announce at zope.org, 
    zope-cmf at zope.org and zope at zope.org. Also, a NewsItem for the release
    should be created on the zope.org site.


=== CMF/CHANGES.txt 1.290 => 1.291 ===
--- CMF/CHANGES.txt:1.290	Wed Mar 23 16:27:40 2005
+++ CMF/CHANGES.txt	Thu Mar 24 13:33:37 2005
@@ -57,6 +57,11 @@
 
   Others
 
+    - To document how to create a CMF release from CMF a description is now
+      included in RELEASE.txt at the root of the CMF package. This text can
+      guide release managers or volunteers with the appropriate release
+      privileges.
+
     - Added DeprecationWarning to the all_cmf_tests.py script. The canonical
       way to run the tests is using "zopectl test".
       (http://www.zope.org/Collectors/CMF/272)