updated

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

1 files changed, 67 insertions, 46 deletions

diff --git a/docs/dev/release.txt b/docs/dev/release.txt
index 3be30bec6..b907817a8 100644
--- a/docs/dev/release.txt
+++ b/docs/dev/release.txt
@@ -10,27 +10,29 @@
 .. _Docutils: http://docutils.sourceforge.net/
 
 
-1. Edit the version number in the following files:
+1. Announce a checkin freeze on Docutils-develop.
 
-   * docutils:
+2. Bump the version number in the following files:
 
-     - setup.py
-     - HISTORY.txt
-     - docutils/__init__.py
+   * docutils/setup.py
+   * docutils/HISTORY.txt
+   * docutils/docutils/__init__.py
 
-   * web: index.txt
+3. Run ``test/test_functional.py``.  If it fails (due to the bumped
+   version number), update the files in ``test/functional/expected/``.
 
-2. Run the test suite: ``cd test ; alltests.py``.
+4. Run the test suite: ``cd test ; python alltests.py``.  Do this for
+   all supported Python versions.
 
-3. Isolate from outside influence:
+5. Isolate from outside influence:
 
    (a) Remove the old installation from site-packages (including
        roman.py, and optparse.py, textwrap.py for pre-2.3
        installations).
 
    (b) Clear/unset the PYTHONPATH environment variable.
-
-4. Create the release tarball:
+   
+6. Create the release tarball:
 
    (a) Create a new empty directory and ``cd`` into it.
 
@@ -44,44 +46,44 @@
            cd docutils
            python setup.py sdist
 
-5. Expand and install the release tarball **in isolation** (as per
-   step 3 above):
+7. Expand and install the release tarball **in isolation** (as per
+   step 5 above):
 
    (a) Expand the tarball in a new location, not over any existing
        files.
 
    (b) Install from expanded directory::
 
-           cd docutils-X.Y
+           cd docutils-X.Y.Z
            python setup.py install
 
        The "install" command may require root permissions.
 
-6. Run the test suite from the expanded archive directory: ``cd test ;
-   alltests.py``.
+8. Run the test suite from the expanded archive directory with all
+   supported Python versions: ``cd test ; python alltests.py``.
 
-7. Run ``cd tools ; buildhtml.py ..`` to confirm that there are no
+9. Run ``cd tools ; buildhtml.py ..`` to confirm that there are no
    unexpected issues with the docs.
 
-8. Upload the release tarball::
-
-       $ 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
-
-9. Log in to the SourceForge web interface.
-
-10. Access the file release system on SourceForge (Admin interface).
+10. Upload the release tarball::
+
+        $ 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
+
+11. Log in to the SourceForge web interface.
+
+12. Access the file release system on SourceForge (Admin interface).
     Fill in the fields:
 
         :Package ID:      docutils
@@ -96,29 +98,48 @@
 
         Also check the "Preserve my pre-formatted text" box.
 
-11. Wait up to 30 minutes for the file to become available on
+13. Wait up to 30 minutes for the file to become available on
     SourceForge.
 
-12. Download the release tarball and verify its integrity by walking
+14. Download the release tarball and verify its integrity by walking
     through an installation, as outlined above (steps 5, 6, & 7).
 
-13. Add a SourceForge News item, with title "Docutils 0.x released"
+15. Update the web page:
+
+    * 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::
+
+          cd tools/
+          ./buildhtml.py ..
+          cd ..
+          tar -cjvf docutils-docs.tar.bz2 `find -name test -type d -prune -o -name \*.css -print -o -name \*.html -print -o -name \*.txt -print`
+          ssh <username>@shell.sourceforge.net 'cat > docutils-docs.tar.bz2' < docutils-docs.tar.bz2
+
+      Now log in to shell.sourceforge.net and ``tar -xjvf
+      ~/docutils-docs.tar.bz2`` in the newly created ``htdocs/X.Y.Z``
+      directory.
+
+16. Bump the version number again (as per step 1).
+
+17. Announce the release and the end of the checkin freeze on
+    Docutils-develop.
+
+18. Add a SourceForge News item, with title "Docutils X.Y.Z released"
     and containing the release tarball's download URL.
 
-14. Send announcement email to:
+19. Send announcement email to:
 
-    * docutils-develop@lists.sourceforge.net
     * docutils-users@lists.sourceforge.net
     * doc-sig@python.org
-    * python-list@python.org
     * python-announce@python.org
 
-15. Register
+20. Register
 
-    (a) with PyPI (Fill in details.  ``python setup.py register``?
-        How to log in?)
-    (b) with Vaults of Parnassus
-    (c) with FreshMeat?
+    * with PyPI (``python setup.py register``)
+    * with FreshMeat
 
 
 ..