Skip to content

Commit e3d13b8

Browse files
committed
DOC: update release instructions
Add reference to nipy buildbot, good old Jerry Update release description using shortlog Suggest travi-ci check
1 parent 65df67c commit e3d13b8

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

doc/source/devel/make_release.rst

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ A guide to making a nibabel release
66

77
A guide for developers who are doing a nibabel release
88

9-
* Edit :file:`info.py` and bump the version number
10-
119
.. _release-tools:
1210

1311
Release tools
@@ -41,23 +39,35 @@ the tests from the resulting directory.
4139
Release checklist
4240
=================
4341

44-
* Review the open list of `issues <http://github.com/nipy/nibabel/issues>`_ .
45-
Check whether there are outstanding issues that can be closed, and whether
46-
there are any issues that should delay the release. Label them !
42+
* Review the open list of `nibabel issues`_. Check whether there are
43+
outstanding issues that can be closed, and whether there are any issues that
44+
should delay the release. Label them !
4745

4846
* Review and update the release notes. Review and update the :file:`Changelog`
4947
file. Get a partial list of contributors with something like::
5048

51-
git log 0.9.0.. | grep '^Author' | cut -d' ' -f 2- | sort | uniq
49+
git log 1.2.0.. | grep '^Author' | cut -d' ' -f 2- | sort | uniq
50+
51+
where ``1.2.0`` was the last release tag name.
5252

53-
where ``0.9.0`` was the last release tag name.
53+
Then manually go over ``git shortlog 1.2.0..`` to make sure the release notes
54+
are as complete as possible and that every contributor was recognized.
5455

55-
Then manually go over the *git log* to make sure the release notes are
56-
as complete as possible and that every contributor was recognized.
56+
* Use the opportunity to update the ``.mailmap`` file if there are any duplicate
57+
authors listed from ``git shortlog``.
5758

5859
* Check the ``long_description`` in ``nibabel/info.py``. Check it matches the
5960
``README`` in the root directory.
6061

62+
* Do a final check on the `nipy buildbot`_
63+
64+
* If you have travis-ci_ building set up you might want to push the code in it's
65+
current state to a branch that will build, e.g::
66+
67+
git branch -D pre-release-test # in case branch already exists
68+
git co -b pre-release-test
69+
git push origin pre-release-test
70+
6171
* Clean::
6272

6373
make distclean
@@ -127,10 +137,10 @@ Release checklist
127137
# in wine bash
128138
make sdist-tests
129139

130-
For the PPC I have to log into an old Mac G5 in Berkeley. It doesn't have a
131-
fixed IP even, but here's an example session::
140+
For the PPC I have to log into an old Mac G5 in Berkeley at
141+
``jerry.bic.berkeley.edu``. Here's an example session::
132142

133-
ssh 128.32.52.219
143+
ssh jerry.bic.berkeley.edu
134144
cd dev_trees/nibabel
135145
git co main-master
136146
git pull
@@ -180,7 +190,7 @@ Release checklist
180190
further substantial development (often called 'trunk') and another for
181191
maintenance releases.
182192

183-
* Branch to maintainance::
193+
* Branch to maintenance::
184194

185195
git co -b maint/1.0.x
186196

@@ -217,7 +227,7 @@ Release checklist
217227
This tag is used in the Makefile rules to create development snapshot
218228
releases to create proper versions for those. The version derives its name
219229
from the last available annotated tag, the number of commits since that, and
220-
an abbrevated SHA1. See the docs of ``git describe`` for more info.
230+
an abbreviated SHA1. See the docs of ``git describe`` for more info.
221231

222232
Please take a look at the Makefile rules ``devel-src``,
223233
``devel-dsc`` and ``orig-src``.
@@ -226,3 +236,6 @@ Release checklist
226236

227237
.. _pytox: http://codespeak.net/tox
228238
.. _setuptools intro: http://packages.python.org/an_example_pypi_project/setuptools.html
239+
.. _travis-ci: http://travis-ci.org
240+
241+
.. include:: ../links_names.txt

doc/source/links_names.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
.. _`nibabel github`: http://github.com/nipy/nibabel
1818
.. _`nibabel mailing list`: http://mail.scipy.org/mailman/listinfo/nipy-devel
1919
.. _nibabel pypi: http://pypi.python.org/pypi/nibabel
20+
.. _nibabel issues: http://github.com/nipy/nibabel/issues
2021

2122
.. other related projects
2223
.. _nipy community: http://nipy.org
@@ -27,6 +28,7 @@
2728
.. _nibabel: http://nipy.org/nibabel
2829
.. _nipy development guidelines: http://nipy.org/devel
2930
.. _`nipy github`: http://github.com/nipy/nipy
31+
.. _nipy buildbot: http://nipy.bic.berkeley.edu
3032

3133
.. Documentation tools
3234
.. _graphviz: http://www.graphviz.org/

0 commit comments

Comments
 (0)