-
Notifications
You must be signed in to change notification settings - Fork 0
/
RELEASING.txt
127 lines (81 loc) · 3.17 KB
/
RELEASING.txt
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
==================
Releasing Numexpr
==================
:Author: Francesc Alted
:Contact: faltet@pytables.org
: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``.
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.
- Make the binary packages for supported Python versions (2.6 and 2.7
currently). Check that installer works correctly.
Uploading
---------
- Go to the downloads section of the Numexpr project in Google Code
and upload the source tarball and the binary packages.
- Upload it also in the PyPi repository.
* First, register the new version with:
$ python setup.py register
* Then upload the files manually using the PyPI web interface.
Announcing
----------
- Update the release notes in the numexpr site:
http://code.google.com/p/numexpr/wiki/ReleaseNotes
*WARNING*: Remember that the syntax for Google Code pages is
wiki-oriented and not rest-oriented. When copying the text from
``RELEASE_NOTES.txt`` to the wiki, double chek that it reads as it
should (the ``Preview`` button is your friend!).
- Send an announcement to the NumPy list and python-announce list.
Use the ``ANNOUNCE.txt`` file as skeleton (or possibly as the
definitive version).
Post-release actions
--------------------
Major/Minor versions
~~~~~~~~~~~~~~~~~~~~
- Create a new branch for possible patch level revisions. Call this
branch just ``/branches/X.Y``. You can use the next message::
Created X.Y branch for numexpr X.Y.
- Create a tag ``/tags/X.Y`` from ``/branches/X.Y`` (not from
trunk!). Use the next message::
Created X.Y tag for numexpr X.Y.
- Edit ``numexpr/version.py`` in trunk to increment the version to the
next minor one (i.e. X.Y --> X.(Y+1)). Set the `release` variable
to False.
- Edit ``numexpr/version.py`` in the new branch to add the patch-level
revision (i.e. X.Y --> X.Y.1). Set the `release` variable to False.
Patch level revisions
~~~~~~~~~~~~~~~~~~~~~
- Create a tag ``/tags/X.Y.Z`` from ``/branches/X.Y.Z``. Use
the next message::
Created X.Y.Z tag for numexpr X.Y.Z.
- Edit ``numexpr/version.py`` in branch X.Y to increment the version
to the next patch-level one (i.e. X.Y.Z --> X.Y.(Z+1)). Set the
`release` variable to False.
For all versions
~~~~~~~~~~~~~~~~
Do the next actions in trunk or any new branch (if applicable):
- 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: