1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
==================
Releasing Numexpr
==================
:Author: Francesc Alted
:Contact: faltet@gmail.com
:Date: 2009-06-02
Following are notes useful for releasing Numexpr.
Preliminaries
-------------
- Make sure that ``RELEASE_NOTES.txt`` and ``ANNOUNCE.txt`` are up to
date with the latest news in the release.
- Check that ``release=True`` in ``numexpr/version.py``.
- Do a commit and a push:
$ git commit -a -m"Getting ready for release X.Y.Z"
$ git push
Testing
-------
- Run the test suite in different platforms (at least Linux and
Windows) and make sure that all tests passes.
- Re-compile with MKL support and see if all tests passes as well.
- Run all the benchmarks in ``bench/`` directory and see if the
speed-ups are the expected ones.
Packaging
---------
- Make the tarball with the command:
$ python setup.py sdist
Do a quick check that the tarball is sane.
Releasing
---------
- Create a tag ``vX.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
$ git push --tags
Uploading
---------
- Upload it in the PyPi repository:
$ python setup.py sdist upload
$ python setup.py register
Announcing
----------
- Update the release notes in the numexpr site:
https://github.com/pydata/numexpr/wiki/Release-Notes
- Send an announcement to the NumPy list and python-announce list.
Use the ``ANNOUNCE.rst`` file as skeleton (or possibly as the
definitive version).
Post-release actions
--------------------
- Edit ``numexpr/version.py`` to add the patch-level
revision (i.e. X.Y --> X.Y.1). Set the `release` variable to False.
- Create new headers for adding new features in ``RELEASE_NOTES.txt``
and empty the release-specific information in ``ANNOUNCE.txt`` and
add this place-holder instead:
#XXX version-specific blurb XXX#
That's all folks!
.. Local Variables:
.. mode: rst
.. coding: utf-8
.. fill-column: 70
.. End:
|