Skip to content

RELEASING.rst

Latest commit

 

History

History
139 lines (81 loc) · 3.02 KB

RELEASING.rst

File metadata and controls

139 lines (81 loc) · 3.02 KB

Releasing bcolz

Author: Francesc Alted
Contact: faltet@blosc.io
Date: 2014-07-20

Preliminaries

  • Make sure that RELEASE_NOTES.rst and ANNOUNCE.rst are up to date with the latest news in the release.
  • Check that VERSION file contains the correct number.
  • Once a year: check that the copyright in LICENSES/BCOLZ.txt and doc/conf.py.

Testing

  • After compiling, run:

    $ PYTHONPATH=.   (or "set PYTHONPATH=." on Win)
$ export PYTHONPATH=.  (not needed on Win)
$ python -c "import bcolz; bcolz.test(heavy=True)"

  • Run the test suite in different platforms (at least Linux and Windows) and make sure that all tests passes.

Updating the online documentation site

Note

This instructions are currently out-of-date and are to be considered under construction.

  • Go to the doc directory:

    $ cd doc

  • Make sure that the version/release variables are updated in conf.py.

  • Make the html version of the docs:

    $ rm -rf _build/html
$ make html

  • Make a backup and upload the files in the doc site (xodo):

    $ export UPSTREAM="/home/blosc/srv/www/bcolz.blosc.org"
$ ssh blosc@xodo.blosc.org "mv $UPSTREAM/docs/html $UPSTREAM/docs/html.bck"
$ scp -r _build/html blosc@xodo.blosc.org:$UPSTREAM/docs

  • Check that the new manual is accessible in http://bcolz.blosc.org

  • If everything is fine, remove the backup of the previous manual:

    $ ssh blosc@xodo.blosc.org "rm -r $UPSTREAM/docs/html.bck"

  • Go up to the root directory for further proceeding with packaging:

    $ cd ..

Packaging

  • Check that all Cython generated *.c files are present.

  • Make the tarball with the command:

    $ python setup.py sdist

Do a quick check that the tarball is sane.

Uploading

  • Upload it also in the PyPi repository:

    $ python setup.py sdist upload

Tagging

  • Create a tag X.Y.Z from master. Use the next message:

    $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"

  • Or, alternatively, make a signed tag (requires gpg correctly configured):

    $ git tag -s vX.Y.Z -m "Tagging version X.Y.Z"

  • Push the tag to the Github repo (assuming origin is correct):

    $ git push origin vX.Y.Z

Announcing

  • Send an announcement to the bcolz, blosc, numpy, pandas and python-announce lists. Use the ANNOUNCE.rst file as skeleton (or possibly as the definitive version).
  • Tweet about the new release and enjoy!

Post-release actions

  • Edit VERSION in master to increment the version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev).

  • Also, update the version and release variables in doc/conf.py.

  • Create new headers for adding new features in RELEASE_NOTES.rst and empty the release-specific information in ANNOUNCE.rst and add this place-holder instead:

    #XXX version-specific blurb XXX#

That's all folks!