123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111 |
- ================
- Releasing Blosc
- ================
- :Author: Francesc Alted
- :Contact: francesc@blosc.org
- :Date: 2014-01-15
- 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.
- - Commit the changes::
- $ git commit -a -m"Getting ready for X.Y.Z release"
- Testing
- -------
- Create a new build/ directory, change into it and issue::
- $ cmake ..
- $ cmake --build .
- $ ctest
- To actually test Blosc the hard way, look at the end of:
- http://blosc.org/synthetic-benchmarks.html
- where instructions on how to intensively test (and benchmark) Blosc
- are given.
- Forward compatibility testing
- -----------------------------
- First, go to the compat/ directory and generate a file with the current
- version::
- $ cd ../compat
- $ export LD_LIBRARY_PATH=../build/blosc
- $ gcc -o filegen filegen.c -L$LD_LIBRARY_PATH -lblosc -I../blosc
- $ ./filegen compress lz4 blosc-lz4-1.y.z.cdata
- In order to make sure that we are not breaking forward compatibility,
- link and run the `compat/filegen` utility against different versions of
- the Blosc library (suggestion: 1.3.0, 1.7.0, 1.11.1, 1.14.1).
- You can compile the utility with different blosc shared libraries with::
- $ export LD_LIBRARY_PATH=shared_blosc_library_path
- $ gcc -o filegen filegen.c -L$LD_LIBRARY_PATH -lblosc -Iblosc.h_include_path
- Then, test the file created with the new version with::
- $ ./filegen decompress blosc-lz4-1.y.z.cdata
- Repeat this for every codec shipped with Blosc (blosclz, lz4, lz4hc, snappy,
- zlib and zstd).
- 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 previous commits and tag to the github repo::
- $ git push
- $ git push --tags
- Announcing
- ----------
- - Send an announcement to the blosc, pytables-dev, bcolz 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 add this place-holder instead:
- #XXX version-specific blurb XXX#
- - Commit the changes::
- $ git commit -a -m"Post X.Y.Z release actions done"
- $ git push
- That's all folks!
- .. Local Variables:
- .. mode: rst
- .. coding: utf-8
- .. fill-column: 70
- .. End:
|