Skip to content

Commit 8b4c882

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

File tree

1 file changed

+31
-39
lines changed

1 file changed

+31
-39
lines changed

doc/source/devel/make_release.rst

Lines changed: 31 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,32 @@ 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+
* Force builds of your local branch on the win32 and amd64 binaries on
128+
buildbot::
129+
130+
try_branch.py nibabel-bdist32-27
131+
try_branch.py nibabel-bdist32-34
132+
try_branch.py nibabel-bdist64-27
133+
134+
Check the builds completed without error on their respective web-pages:
135+
136+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-27
137+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist32-34
138+
* https://nipy.bic.berkeley.edu/builders/nibabel-bdist64-27
139+
140+
Then get the built binaries in:
141+
142+
* https://nipy.bic.berkeley.edu/nibabel-dist
143+
144+
When you've done the release to pypi, you can upload them to pypi with the
145+
admin files interface.
146+
147+
If you are already on a Windows machine, you could have done the manual
148+
command to build instead: ``python setup.py bdist_wininst``.
149+
145150
* The release should now be ready.
146151

147152
* Edit ``nibabel/info.py`` to set ``_version_extra`` to ``''``; commit.
@@ -178,26 +183,13 @@ Release checklist
178183

179184
git push --tags
180185

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-
197186
* Now the version number is OK, push the docs to github pages with::
198187

199188
make upload-html
200189

190+
* Finally (for the release uploads) upload the Windows binaries you built with
191+
``try_branch.py`` above;
192+
201193
* Set up maintenance / development branches
202194

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

0 commit comments

Comments
 (0)