updated release procedure to match what is currently being done;

made entries not covered by release.sh boldface


git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2908 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

1 files changed, 102 insertions, 102 deletions

diff --git a/docutils/docs/dev/release.txt b/docutils/docs/dev/release.txt
index 26f152d5f..3082f775b 100644
--- a/docutils/docs/dev/release.txt
+++ b/docutils/docs/dev/release.txt
@@ -1,7 +1,7 @@
 =============================
  Docutils_ Release Procedure
 =============================
-:Author: David Goodger; open to all Docutils developers
+:Author: David Goodger; Felix Wiemann; open to all Docutils developers
 :Contact: goodger@python.org
 :Date: $Date$
 :Revision: $Revision$
@@ -10,148 +10,148 @@
 .. _Docutils: http://docutils.sourceforge.net/
 
 
-1. Announce a checkin freeze on Docutils-develop.
+(Steps in boldface text are *not* covered by the release script at
+sandbox/felixwiemann/release.sh.  "Not covered" means that you aren't
+even reminded of them.)
 
-2. Bump the version number in the following files:
+* **Announce a checkin freeze on Docutils-develop.  Post a list of
+  major changes since the last release and ask for additions.**
 
-   * docutils/setup.py
-   * docutils/HISTORY.txt
-   * docutils/docutils/__init__.py
+  .. _CHANGES.txt:
 
-3. Run ``test/test_functional.py``.  If it fails (due to the bumped
-   version number), update the files in ``test/functional/expected/``.
+  **You may want to save this list of changes in a file
+  (e.g. CHANGES.txt) to have it at hand when you need it for posting
+  announcements or pasting it into forms.**
 
-4. Run the test suite: ``cd test ; python alltests.py``.  Do this for
-   all supported Python versions.
+* Bump the _`version number` in the following files:
 
-5. Isolate from outside influence:
+  + docutils/setup.py
+  + docutils/docutils/__init__.py
+  + docutils/test/functional/expected/* ("Generator: Docutils X.Y.Z")
 
-   (a) Remove the old installation from site-packages (including
-       roman.py, and optparse.py, textwrap.py for pre-2.3
-       installations).
+* Close the "Changes Since ..." section in docutils/HISTORY.txt.
 
-   (b) Clear/unset the PYTHONPATH environment variable.
+* Clear/unset the PYTHONPATH environment variable.
    
-6. Create the release tarball:
+* Create the release tarball:
 
-   (a) Create a new empty directory and ``cd`` into it.
+  (a) Create a new empty directory and ``cd`` into it.
 
-   (b) Get a clean snapshot of the CVS files::
+  (b) Get a clean snapshot of the CVS files::
 
-           cvs -z3 -d:pserver:anonymous@cvs.sf.net:/cvsroot/docutils \
-               export -rHEAD docutils
+          cvs -z3 -d:pserver:anonymous@cvs.sf.net:/cvsroot/docutils \
+              export -rHEAD docutils
 
-   (c) Use Distutils to create the release tarball::
+  (c) Use Distutils to create the release tarball::
 
-           cd docutils
-           python setup.py sdist
+          cd docutils
+          python setup.py sdist
 
-7. Expand and install the release tarball **in isolation** (as per
-   step 5 above):
+* Expand and _`install` the release tarball in isolation:
 
-   (a) Expand the tarball in a new location, not over any existing
-       files.
+  (a) Expand the tarball in a new location, not over any existing
+      files.
 
-   (b) Install from expanded directory::
+  (b) Remove the old installation from site-packages (including
+      roman.py, and optparse.py, textwrap.py).
 
-           cd docutils-X.Y.Z
-           python setup.py install
+      Install from expanded directory::
 
-       The "install" command may require root permissions.
+          cd docutils-X.Y.Z
+          python setup.py install
 
-8. Run the test suite from the expanded archive directory with all
-   supported Python versions: ``cd test ; python alltests.py``.
+      The "install" command may require root permissions.
 
-9. Run ``cd tools ; buildhtml.py ..`` to confirm that there are no
-   unexpected issues with the docs.
+  (c) Repeat step b) for all supported Python versions.
 
-10. Upload the release tarball::
+* Run the _`test suite` from the expanded archive directory with all
+  supported Python versions: ``cd test ; python -u alltests.py``.
 
-        $ ftp upload.sourceforge.net
-        Connected to osdn.dl.sourceforge.net.
-        ...
-        Name (upload.sourceforge.net:david): anonymous
-        331 Anonymous login ok, send your complete e-mail address as password.
-        Password:
-        ...
-        230 Anonymous access granted, restrictions apply.
-        ftp> bin
-        200 Type set to I.
-        ftp> cd /incoming
-        250 CWD command successful.
-        ftp> put filename
+* Add a directory X.Y.Z (where X.Y.Z is the current version number
+  of Docutils) in the webroot (i.e. the ``htdocs/`` directory).
+  Put all documentation files into it::
 
-11. Log in to the SourceForge web interface.
+      cd docutils-X.Y.Z
+      rm -rf build
+      cd tools/
+      ./buildhtml.py ..
+      cd ..
+      find -name test -type d -prune -o -name \*.css -print0 \
+          -o -name \*.html -print0 -o -name \*.txt -print0 \
+          | tar -cjvf docutils-docs.tar.bz2 -T - --null
+      scp docutils-docs.tar.bz2 <username>@shell.sourceforge.net:
 
-12. Access the _`file release system` on SourceForge (Admin
-    interface).  Fill in the fields:
+  Now log in to shell.sourceforge.net and::
 
-        :Package ID:      docutils
-        :Release Name:    <use release number only, e.g. 0.3>
-        :Release Date:    <today's date>
-        :Status:          Active
-        :File Name:       <select the file just uploaded>
-        :File Type:       Source .gz
-        :Processor Type:  Platform-Independent
-        :Release Notes:   <insert README.txt file here>
-        :Change Log:      <insert summary from announcement>
+      cd /home/groups/d/do/docutils/htdocs/
+      mkdir -m g+rwxs X.Y.Z
+      cd X.Y.Z
+      tar -xjvf ~/docutils-docs.tar.bz2
+      rm ~/docutils-docs.tar.bz2
 
-        Also check the "Preserve my pre-formatted text" box.
+* Upload the release tarball::
 
-13. Wait up to 30 minutes for the file to become available on
-    SourceForge.
+      $ ftp upload.sourceforge.net
+      Connected to osdn.dl.sourceforge.net.
+      ...
+      Name (upload.sourceforge.net:david): anonymous
+      331 Anonymous login ok, send your complete e-mail address as password.
+      Password:
+      ...
+      230 Anonymous access granted, restrictions apply.
+      ftp> bin
+      200 Type set to I.
+      ftp> cd /incoming
+      250 CWD command successful.
+      ftp> put docutils-X.Y.Z.tar.gz
 
-14. Download the release tarball and verify its integrity by walking
-    through an installation, as outlined above (steps 7, 8, & 9).
+* Access the _`file release system` on SourceForge (Admin
+  interface).  Fill in the fields:
 
-15. Update the web page:
+      :Package ID:      docutils
+      :Release Name:    <use release number only, e.g. 0.3>
+      :Release Date:    <today's date>
+      :Status:          Active
+      :File Name:       <select the file just uploaded>
+      :File Type:       Source .gz
+      :Processor Type:  Platform-Independent
+      :Release Notes:   <insert README.txt file here>
+      :Change Log:      <insert summary from CHANGES.txt_>
 
-    * web/index.txt; afterwards run docutils-update on the server.
-    
-    * Add a directory X.Y.Z (where X.Y.Z is the current version number
-      of Docutils) in the webroot (i.e. the ``htdocs/`` directory).
-      Put all documentation files into it::
+      Also check the "Preserve my pre-formatted text" box.
 
-          cd docutils-X.Y.Z
-          rm -rf build
-          cd tools/
-          ./buildhtml.py ..
-          cd ..
-          find -name test -type d -prune -o -name \*.css -print0 \
-              -o -name \*.html -print0 -o -name \*.txt -print0 \
-              | tar -cjvf docutils-docs.tar.bz2 -T - --null
-          scp docutils-docs.tar.bz2 <username>@shell.sourceforge.net:
+* For verifying the integrity of the release, download the release
+  tarball (you may need to wait up to 30 minutes), install_ it, and
+  re-run the `test suite`_.
 
-      Now log in to shell.sourceforge.net and::
+* Register with PyPI (``python setup.py register``).
 
-          cd /home/groups/d/do/docutils/htdocs/
-          mkdir -m g+rwxs X.Y.Z
-          cd X.Y.Z
-          tar -xjvf ~/docutils-docs.tar.bz2
+* Bump the `version number`_ again.
 
-16. Bump the version number again (as per step 2) and update the files
-    in ``test/functional/expected/``.
+* Add a new empty section "Changes Since ..." in HISTORY.txt.
 
-17. Send announcement email to:
+* Update the web page (web/index.txt).
 
-    * docutils-develop@lists.sourceforge.net (also announcing the end
-      of the checkin freeze)
-    * docutils-users@lists.sourceforge.net
-    * doc-sig@python.org
-    * python-announce@python.org
+* Run docutils-update on the server.
+    
+* **Send announcement email to:**
 
-18. Add a SourceForge News item, with title "Docutils X.Y.Z released"
-    and containing the release tarball's download URL.
+  * docutils-develop@lists.sourceforge.net (also announcing the end
+    of the checkin freeze)
+  * docutils-users@lists.sourceforge.net
+  * doc-sig@python.org
+  * python-announce@python.org
 
-19. Register
+* **Add a SourceForge News item, with title "Docutils X.Y.Z released"
+  and containing the release tarball's download URL.**
 
-    * with PyPI (``python setup.py register``)
-    * with FreshMeat (add a `new release`__ for the `Docutils
-      project`__)
+* **Register with FreshMeat.** (Add a `new release`__ for the
+  `Docutils project`__).
 
-    __ http://freshmeat.net/add-release/48702/
-    __ http://freshmeat.net/projects/docutils/
+  __ http://freshmeat.net/add-release/48702/
+  __ http://freshmeat.net/projects/docutils/
 
+    
 
 ..
    Local Variables: