[z3-checkins] r25814 - z3/sqlos/trunk/doc

[jinty at codespeak.net]

Author: jinty
Date: Thu Apr 13 20:54:31 2006
New Revision: 25814

Added:
   z3/sqlos/trunk/doc/HowToMakeARealease.rst
Log:
Make a release howto.

Added: z3/sqlos/trunk/doc/HowToMakeARealease.rst
==============================================================================
--- (empty file)
+++ z3/sqlos/trunk/doc/HowToMakeARealease.rst	Thu Apr 13 20:54:31 2006
@@ -0,0 +1,60 @@
+How to make a SQLOS release
+===========================
+
+Firstly, this document is only a guide, feel free to correct/add to it.
+
+
+Major release
++++++++++++++
+
+Step 1 - Update Documentation
+-----------------------------
+
+Update the documents in the source:
+    1. trunk/src/sqlos/README.txt - Th compatibility matrix.
+
+
+Step 2 - Make a maintenance branch for the release
+--------------------------------------------------
+
+Copy the branch:
+    1. `svn cp https://codespeak.net/svn/z3/sqlos/trunk https://codespeak.net/svn/z3/sqlos/branch/x.y`
+
+Check it out:
+    1. `svn co https://codespeak.net/svn/z3/sqlos/branch/x.y x.y`
+    2. `cd x.y`
+
+Mark as a release as follows:
+    1. svn rm setup.cfg
+    2. update the version number in setup.py
+    3. set the Z3BRANCH makefile variable so that the makefile points at the
+       compatible zope release branch
+
+Test the branch against Zope3 and Zope2:
+    1. use `make test` to test the branch against the compatible version of Zope3
+    2. TODO - develop a procedure for testing against Zope2
+
+
+Step 3 - Tag the branch as a release
+------------------------------------
+
+Copy the branch:
+    1. `svn cp https://codespeak.net/svn/z3/sqlos/branch/x.y https://codespeak.net/svn/z3/sqlos/tag/x.y.z`
+
+Step 4 - Upload to the python cheese shop
+-----------------------------------------
+
+Simple:
+    1. `svn co https://codespeak.net/svn/z3/sqlos/tag/x.y.z`
+    2. cd x.y.z
+    3. pythonX.X setup.py register sdist bdist_egg upload
+
+Step 5 - Send announcements
+---------------------------
+
+To:
+    z3-sqlos at codespeak.net
+    TODO: More?
+
+Template:
+    TODO