source: thirdparty/blosc/RELEASING.rst @ 00587dc

Revision 00587dc, 2.1 KB checked in by Hal Finkel <hfinkel@…>, 9 years ago (diff)

Initial Commit (gio-base-20150317)

  • Property mode set to 100644
RevLine 
[00587dc]1================
2Releasing Blosc
3================
4
5:Author: Francesc Alted
6:Contact: [email protected]
7:Date: 2012-09-16
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
18Testing
19-------
20
21Go to the test/ directory and issue::
22
23  $ make test
24
25These tests are very basic, and only valid for platforms where GNU
26make/gcc tools are available.  To actually test Blosc the hard way,
27look at the end of:
28
29http://blosc.org/trac/wiki/SyntheticBenchmarks
30
31where instructions on how to intensively test (and benchmark) Blosc
32are given.
33
34Packaging
35---------
36
37- Unpack the archive of the repository in a temporary directory::
38
39  $ export VERSION="the version number"
40  $ mkdir /tmp/blosc-$VERSION
41  # IMPORTANT: make sure that you are at the root of the repo now!
42  $ git archive master | tar -x -C /tmp/blosc-$VERSION
43
44- And package the repo::
45
46  $ cd /tmp
47  $ tar cvfz blosc-$VERSION.tar.gz blosc-$VERSION
48
49Do a quick check that the tarball is sane.
50
51
52Uploading
53---------
54
55- Go to the downloads section in blosc.org and upload the source
56  tarball.
57
58
59Tagging
60-------
61
62- Create a tag ``X.Y.Z`` from ``master``.  Use the next message::
63
64    $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
65
66- Push the tag to the github repo::
67
68    $ git push --tags
69
70
71Announcing
72----------
73
74- Update the release notes in the github wiki:
75
76https://github.com/FrancescAlted/blosc/wiki/Release-notes
77
78- Send an announcement to the blosc, pytables, carray and
79  comp.compression lists.  Use the ``ANNOUNCE.rst`` file as skeleton
80  (possibly as the definitive version).
81
82Post-release actions
83--------------------
84
85- Edit *VERSION* symbols in blosc/blosc.h in master to increment the
86  version to the next minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev).
87
88- Create new headers for adding new features in ``RELEASE_NOTES.rst``
89  and empty the release-specific information in ``ANNOUNCE.rst`` and
90  add this place-holder instead:
91
92  #XXX version-specific blurb XXX#
93
94
95That's all folks!
96
97
98.. Local Variables:
99.. mode: rst
100.. coding: utf-8
101.. fill-column: 70
102.. End:
Note: See TracBrowser for help on using the repository browser.