Skip to content

Latest commit

 

History

History
104 lines (64 loc) · 2.19 KB

RELEASING.rst

File metadata and controls

104 lines (64 loc) · 2.19 KB

Releasing Blosc

Author: Francesc Alted
Contact: [email protected]
Date: 2012-09-16

Preliminaries

  • Make sure that RELEASE_NOTES.rst and ANNOUNCE.rst are up to date with the latest news in the release.
  • Check that VERSION symbols in blosc/blosc.h contains the correct info.

Testing

Go to the test/ directory and issue:

$ make test

These tests are very basic, and only valid for platforms where GNU make/gcc tools are available. To actually test Blosc the hard way, look at:

http://blosc.pytables.org/trac/wiki/SyntheticBenchmarks

where instructions on how to intensively test (and benchmark) Blosc are given.

Packaging

  • Unpack the archive of the repository in a temporary directory:

    $ export VERSION="the version number"
$ mkdir /tmp/blosc-$VERSION
$ git archive master | tar -x -C /tmp/blosc-$VERSION

  • And package the repo:

    $ cd /tmp
$ tar cvfz blosc-$VERSION.tar.gz blosc-$VERSION

Do a quick check that the tarball is sane.

Uploading

  • Go to the downloads section of the blosc project in github and upload the source tarball.
  • Also, for backward compatibility, upload a copy of the tarball in:

http://blosc.pytables.org/sources/

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"

  • Push the tag to the github repo:

    $ git push --tags

Announcing

  • Update the release notes in the github wiki:

https://github.com/FrancescAlted/blosc/wiki/Release-notes

  • Send an announcement to the blosc, pytables, carray and comp.compression lists. Use the ANNOUNCE.rst file as skeleton (possibly as the definitive version).

Post-release actions

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

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