Skip to content

Commit 1ca2da4

Browse files
committed
DOC: update release-making instructions
Update instructions in preparation for new release.
1 parent 263bcc3 commit 1ca2da4

File tree

1 file changed

+21
-55
lines changed

1 file changed

+21
-55
lines changed

doc/source/devel/make_release.rst

Lines changed: 21 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,20 @@ Release checklist
4747
* Review and update the release notes. Review and update the ``Changelog``
4848
file. Get a partial list of contributors with something like::
4949

50-
git log 1.2.0.. | grep '^Author' | cut -d' ' -f 2- | sort | uniq
50+
git log 1.3.0.. | grep '^Author' | cut -d' ' -f 2- | sort | uniq
5151

52-
where ``1.2.0`` was the last release tag name.
52+
where ``1.3.0`` was the last release tag name.
5353

5454
Then manually go over ``git shortlog 1.2.0..`` to make sure the release notes
5555
are as complete as possible and that every contributor was recognized.
5656

57-
* Update thanks to authors in ``doc/source/index.rst`` and consider any updates
58-
to the ``AUTHOR`` file.
57+
* Look at ``doc/source/index.rst`` and add any authors not yet acknowledged.
5958

60-
* Use the opportunity to update the ``.mailmap`` file if there are any duplicate
61-
authors listed from ``git shortlog -nse``.
59+
* Update thanks to authors in ``doc/source/index.rst`` and consider any
60+
updates to the ``AUTHOR`` file.
61+
62+
* Use the opportunity to update the ``.mailmap`` file if there are any
63+
duplicate authors listed from ``git shortlog -nse``.
6264

6365
* Check the copyright year in ``doc/source/conf.py``
6466

@@ -70,8 +72,8 @@ Release checklist
7072
becase this will be the output used by pypi_
7173

7274
* Check the dependencies listed in ``nibabel/info.py`` (e.g.
73-
``NUMPY_MIN_VERSION``) and in ``doc/source/installation.rst``. They should at
74-
least match. Do they still hold?
75+
``NUMPY_MIN_VERSION``) and in ``doc/source/installation.rst``. They should
76+
at least match. Do they still hold?
7577

7678
* Do a final check on the `nipy buildbot`_
7779

@@ -96,10 +98,6 @@ Release checklist
9698

9799
make sdist-tests
98100

99-
and bdist_egg::
100-
101-
make bdist-egg-tests
102-
103101
and the three ways of installing (from tarball, repo, local in repo)::
104102

105103
make check-version-info
@@ -124,50 +122,18 @@ Release checklist
124122

125123
Fix ``setup.py`` to carry across any files that should be in the distribution.
126124

127-
* You probably have virtualenvs for different python versions. Check the tests
128-
pass for different configurations. If you have pytox_ and a network
129-
connnection, and lots of pythons installed, you might be able to do::
130-
131-
tox
132-
133-
and get tests for python 2.5, 2.6, 2.7, 3.2. I (MB) have my own set of
134-
virtualenvs installed and I've set them up to run with::
135-
136-
tox -e python25,python26,python27,python32,np-1.2.1
137-
138-
The trick was only to define these ``testenv`` sections in ``tox.ini``.
139-
140-
These two above run with::
141-
142-
make tox-fresh
143-
make tox-stale
144-
145-
respectively.
146-
147-
The long-hand not-tox way looks like this::
125+
* You probably have virtualenvs for different Python versions. Check the
126+
tests pass for different configurations. The long-hand way looks like this::
148127

149128
workon python26
129+
make distclean
150130
make sdist-tests
151131
deactivate
152132

153133
etc for the different virtualenvs.
154134

155-
* Check on different platforms, particularly windows and PPC. I have wine
156-
installed on my Mac, and git bash installed under wine. I run bash and the
157-
tests like this::
158-
159-
wineconsole bash
160-
# in wine bash
161-
make sdist-tests
162-
163-
For the PPC I have to log into an old Mac G5 in Berkeley at
164-
``jerry.bic.berkeley.edu``. Here's an example session::
165-
166-
ssh jerry.bic.berkeley.edu
167-
cd dev_trees/nibabel
168-
git co main-master
169-
git pull
170-
make sdist-tests
135+
* Check on different platforms, particularly windows and PPC. Look at the
136+
`nipy buildbot`_ automated test runs for this.
171137

172138
* Check the documentation doctests::
173139

@@ -187,8 +153,8 @@ Release checklist
187153
make source-release
188154

189155
* Once everything looks good, you are ready to upload the source release to
190-
PyPi. See `setuptools intro`_. Make sure you have a file ``\$HOME/.pypirc``,
191-
of form::
156+
PyPi. See `setuptools intro`_. Make sure you have a file
157+
``\$HOME/.pypirc``, of form::
192158

193159
[distutils]
194160
index-servers =
@@ -207,9 +173,9 @@ Release checklist
207173
python setup.py register
208174
python setup.py sdist --formats=gztar,zip upload
209175

210-
* Tag the release with tag of form ``1.1.0``::
176+
* Tag the release with tag of form ``1.4.0``::
211177

212-
git tag -am 'Second main release' 1.1.0
178+
git tag -am 'Fourth main release' 1.4.0
213179

214180
* Push the tag and any other changes to trunk with::
215181

@@ -220,13 +186,13 @@ Release checklist
220186
* http://nipy.bic.berkeley.edu/builders/nibabel-bdist32
221187
* http://nipy.bic.berkeley.edu/builders/nibabel-bdist64
222188

223-
For each of these, enter the revision number (e.g. "1.3.0") in the field
189+
For each of these, enter the revision number (e.g. "1.4.0") in the field
224190
"Revision to build". Then get the built binaries in:
225191

226192
* http://nipy.bic.berkeley.edu/dist-32
227193
* http://nipy.bic.berkeley.edu/dist-64
228194

229-
and upload them to pypi with the admin files interface.
195+
and upload them to pypi with the admin files interface, or using twine_.
230196

231197
If you are already on a windows machine, you could have done the manual
232198
command to upload instead: ``python setup.py bdist_wininst upload``.

0 commit comments

Comments
 (0)