source: thirdparty/blosc/RELEASING.rst @ 981e22c

Revision 981e22c, 1.6 KB checked in by Hal Finkel <hfinkel@…>, 8 years ago (diff)

Upgrade to latest blosc library

blosc git: e394f327ccc78319d90a06af0b88bce07034b8dd

  • Property mode set to 100644
RevLine 
[00587dc]1================
2Releasing Blosc
3================
4
5:Author: Francesc Alted
[981e22c]6:Contact: [email protected]
7:Date: 2014-01-15
[00587dc]8
9
10Preliminaries
11-------------
12
13- Make sure that ``RELEASE_NOTES.rst`` and ``ANNOUNCE.rst`` are up to
14  date with the latest news in the release.
15
16- Check that *VERSION* symbols in blosc/blosc.h contains the correct info.
17
[981e22c]18- Commit the changes::
19
20    $ git commit -a -m"Getting ready for X.Y.Z release"
21
22
[00587dc]23Testing
24-------
25
[981e22c]26Create a new build/ directory, change into it and issue::
[00587dc]27
[981e22c]28  $ cmake ..
29  $ cmake --build .
30  $ ctest
[00587dc]31
[981e22c]32To actually test Blosc the hard way, look at the end of:
[00587dc]33
[981e22c]34http://blosc.org/synthetic-benchmarks.html
[00587dc]35
36where instructions on how to intensively test (and benchmark) Blosc
37are given.
38
39
40Tagging
41-------
42
43- Create a tag ``X.Y.Z`` from ``master``.  Use the next message::
44
45    $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
46
47- Push the tag to the github repo::
48
49    $ git push --tags
50
51
52Announcing
53----------
54
[981e22c]55- Send an announcement to the blosc, pytables-dev, bcolz and
[00587dc]56  comp.compression lists.  Use the ``ANNOUNCE.rst`` file as skeleton
57  (possibly as the definitive version).
58
[981e22c]59
[00587dc]60Post-release actions
61--------------------
62
63- Edit *VERSION* symbols in blosc/blosc.h in master to increment the
64  version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev).
65
66- Create new headers for adding new features in ``RELEASE_NOTES.rst``
[981e22c]67  and add this place-holder instead:
[00587dc]68
69  #XXX version-specific blurb XXX#
70
[981e22c]71- Commit the changes::
72
73    $ git commit -a -m"Post X.Y.Z release actions done"
74    $ git push
75
[00587dc]76
77That's all folks!
78
79
80.. Local Variables:
81.. mode: rst
82.. coding: utf-8
83.. fill-column: 70
84.. End:
Note: See TracBrowser for help on using the repository browser.