Skip to content

Commit ed40f34

Browse files
committed
DOC: update release docs to use try_branch.py
Also, remove some emphasis on outdated check scripts.
1 parent 853f5fb commit ed40f34

File tree

1 file changed

+43
-39
lines changed

1 file changed

+43
-39
lines changed

doc/source/devel/make_release.rst

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

77
This is a guide for developers who are doing a nibabel release.
88

9-
.. _release-tools:
10-
11-
Release tools
12-
=============
13-
14-
There are some release utilities that come with nibabel. nibabel should
15-
install these as the ``nisext`` package, and the testing stuff is
16-
understandably in the ``testers`` module of that package. nibabel has
17-
Makefile targets for their use. The relevant targets are::
18-
19-
make check-version-info
20-
make check-files
21-
make sdist-tests
22-
23-
The first installs the code from a git archive, from the repository, and for
24-
in-place use, and runs the ``get_info()`` function to confirm that
25-
installation is working and information parameters are set correctly.
26-
27-
The second (``sdist-tests``) makes an sdist source distribution archive,
28-
installs it to a temporary directory, and runs the tests of that install.
29-
309
.. _release-checklist:
3110

3211
Release checklist
@@ -117,8 +96,8 @@ Release checklist
11796
Fix ``setup.py`` to carry across any files that should be in the
11897
distribution.
11998

120-
* You probably have virtualenvs for different Python versions. Check the
121-
tests pass for different configurations. The long-hand way looks like this::
99+
* You may have virtualenvs for different Python versions. Check the tests
100+
pass for different configurations. The long-hand way looks like this::
122101

123102
workon python26
124103
make distclean
@@ -142,6 +121,44 @@ Release checklist
142121

143122
python -m compileall .
144123

124+
* Make sure you are set up to use the ``try_branch.py`` - see
125+
https://github.com/nipy/nibotmi/blob/master/install.rst#trying-a-set-of-changes-on-the-buildbots
126+
127+
* Make sure all your changes are committed or removed, because
128+
``try_branch.py`` pushes up the changes in the working tree;
129+
130+
* Force build of your release candidate branch with the slow and big-memory
131+
tests on the ``zibi`` buildslave::
132+
133+
try_branch.py nibabel-py2.7-osx-10.10
134+
135+
Check the build web-page for errors:
136+
137+
* https://nipy.bic.berkeley.edu/builders/nibabel-py2.7-osx-10.10
138+
139+
* Force builds of your local branch on the win32 and amd64 binaries on
140+
buildbot::
141+
142+
try_branch.py nibabel-bdist32-27
143+
try_branch.py nibabel-bdist32-34
144+
try_branch.py nibabel-bdist64-27
145+
146+
Check the builds completed without error on their respective web-pages:
147+
148+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-27
149+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-34
150+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist64-27
151+
152+
Then get the built binaries in:
153+
154+
* https://nipy.bic.berkeley.edu/nibabel-dist
155+
156+
When you've done the release to pypi, you can upload them to pypi with the
157+
admin files interface.
158+
159+
If you are already on a Windows machine, you could have done the manual
160+
command to build instead: ``python setup.py bdist_wininst``.
161+
145162
* The release should now be ready.
146163

147164
* Edit ``nibabel/info.py`` to set ``_version_extra`` to ``''``; commit.
@@ -178,26 +195,13 @@ Release checklist
178195

179196
git push --tags
180197

181-
* Force builds of the win32 and amd64 binaries from the buildbot. Go to pages:
182-
183-
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-27
184-
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-34
185-
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist64-27
186-
187-
For each of these, enter the revision number (e.g. "2.0.0") in the field
188-
"Revision to build". Then get the built binaries in:
189-
190-
* https://nipy.bic.berkeley.edu/nibabel-dist
191-
192-
and upload them to pypi with the admin files interface.
193-
194-
If you are already on a Windows machine, you could have done the manual
195-
command to upload instead: ``python setup.py bdist_wininst upload``.
196-
197198
* Now the version number is OK, push the docs to github pages with::
198199

199200
make upload-html
200201

202+
* Finally (for the release uploads) upload the Windows binaries you built with
203+
``try_branch.py`` above;
204+
201205
* Set up maintenance / development branches
202206

203207
If this is this is a full release you need to set up two branches, one for

0 commit comments

Comments
 (0)