releasing.txt

Instructions for releasing a new version of bcolz
=================================================

- Verify that the version number is correct in ``VERSION``
  as well as in ``ANNOUNCE.txt`` and ``doc/conf.py``.

- Make sure that ``ANNOUNCE.txt`` and ``RELEASE-NOTES.txt``
  do contain the most relevant notes for the release.

- Generate a tarball of manual of the version to release:
  + $ cd /tmp
  + $ git clone git://github.com/Blosc/bcolz.git
  + $ cd bcolz
  + $ paver sdist
  + $ export VERSION="x.y.z"    # x.y.z is the version to release
  + $ mv dist/bcolz-$VERSION.tar.gz ..
  + $ cd ..
  + $ tar xvfz bcolz-$VERSION.tar.gz
  + $ tar cvfz bcolz-manual-$VERSION-html.tar.gz bcolz-$VERSION/doc/html/

- Update the on-line HTML manual
  + $ scp bcolz-manual* xodo.blosc.org:/tmp
  + Log-in in xodo as user blosc
  + $ cd ~/srv/www/bcolz.blosc.org/docs
  + $ export VERSION="x.y.z"    # x.y.z is the version to release
  + $ tar xvfz /tmp/bcolz-manual-$VERSION-html.tar.gz
  + $ mv bcolz-$VERSION/doc/html bcolz-$VERSION
  + $ rm -r bcolz-$VERSION
  + $ rm manual; ln -sf manual-$VERSION manual
  + Check that the manual is accessible at:
      http://bcolz.blosc.org/
- Add the 'RELEASE_NOTES' to::
    https://github.com/Blosc/bcolz/wiki/Release-Notes

- Announcing
  + Register the new package in PyPI::
    $ paver register
  + Announce to bcolz@googlegroups.com with copy to pytables-users
  + Wait about 24 hours to give time to people there to test the package
  + If everything goes well, do the post-release actions ("post-release.txt")
  + Do a more general annoucement to:
    - blosc@googlegroups.com (https://groups.google.com/forum/#!forum/blosc)
    - numpy-discussion@scipy.org (with copy to scipy-user@scipy.org)
    - python-announce@python.org
    (remember to put a prefix ANN: in the mail subject).


.. Local Variables:
.. mode: rst
.. coding: utf-8
.. End: