Skip to content

Latest commit

 

History

History
134 lines (79 loc) · 2.85 KB

RELEASING.rst

File metadata and controls

134 lines (79 loc) · 2.85 KB

Releasing bcolz

Author: Francesc Alted
Contact: [email protected]
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.
  • Tag the version.
  • Once a year: check that the copyright in LICENSES/BCOLZ.txt and doc/conf.py.

Tagging

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

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

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

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

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

    $ git push origin X.Y.Z

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

  • Build the html:

    $ python setup.py build_sphinx

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

    $ export UPSTREAM="/home/blosc/srv/www/bcolz.blosc.org"
$ ssh [email protected] "mv $UPSTREAM/docs/html $UPSTREAM/docs/html.bck"
$ scp -r build/sphinx/html [email protected]:$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 [email protected] "rm -r $UPSTREAM/docs/html.bck"

Packaging

Note

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

  • Make sure that you are in a clean directory. The best way is to re-clone and re-build:

    $ cd /tmp
$ git clone [email protected]:Blosc/bcolz.git
$ cd bcolz
$ python setup.py build_ext

  • 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

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 rejoice!

Post-release actions

  • 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#

  • Commit your changes with:

    $ git commit -a -m"Post X.Y.Z release actions done"

That's all folks!