DOC: update release procedure with buildbot

Add buildbot step to run the release checks.

Author: matthew-brett

doc/source/devel/make_release.rst

@@ -81,68 +81,78 @@ Release checklist
 
     nosetests --with-doctest nibabel
 
-* Make sure all tests pass from sdist::
+* Make sure you are set up to use the ``try_branch.py`` - see
+  https://github.com/nipy/nibotmi/blob/master/install.rst#trying-a-set-of-changes-on-the-buildbots
 
-    make sdist-tests
+* Make sure all your changes are committed or removed, because
+  ``try_branch.py`` pushes up the changes in the working tree;
 
-  and the three ways of installing (from tarball, repo, local in repo)::
+* The following checks get run with the ``nibabel-release-checks``, as in::
 
-    make check-version-info
+    try_branch.py nibabel-release-checks
 
-  The last may not raise any errors, but you should detect in the output
-  lines of this form::
+  Beware: this build does not usually error, even if the steps do not give the
+  expected output.  You need to check the output manually by going to
+  https://nipy.bic.berkeley.edu/builders/nibabel-release-checks after the
+  build has finished.
 
-    {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'archive substitution', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
-    /var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel/__init__.pyc
-    {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'installation', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
-    /Users/mb312/dev_trees/nibabel/nibabel/__init__.pyc
-    {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'repository', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/Users/mb312/dev_trees/nibabel/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
+  * Make sure all tests pass from sdist::
 
-* Check the ``setup.py`` file is picking up all the library code and scripts,
-  with::
+      make sdist-tests
 
-    make check-files
+    and the three ways of installing (from tarball, repo, local in repo)::
 
-  Look for output at the end about missed files, such as::
+      make check-version-info
 
-    Missed script files:  /Users/mb312/dev_trees/nibabel/bin/nib-dicomfs, /Users/mb312/dev_trees/nibabel/bin/nifti1_diagnose.py
+    The last may not raise any errors, but you should detect in the output
+    lines of this form::
 
-  Fix ``setup.py`` to carry across any files that should be in the
-  distribution.
+      {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'archive substitution', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
+      /var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel/__init__.pyc
+      {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'installation', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
+      /Users/mb312/dev_trees/nibabel/nibabel/__init__.pyc
+      {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'repository', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/Users/mb312/dev_trees/nibabel/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
 
-* You may have virtualenvs for different Python versions.  Check the tests
-  pass for different configurations. The long-hand way looks like this::
+  * Check the ``setup.py`` file is picking up all the library code and scripts,
+    with::
 
-    workon python26
-    make distclean
-    make sdist-tests
-    deactivate
+      make check-files
 
-  etc for the different virtualenvs.
+    Look for output at the end about missed files, such as::
 
-* Check on different platforms, particularly windows and PPC. Look at the
-  `nipy buildbot`_ automated test runs for this.
+      Missed script files:  /Users/mb312/dev_trees/nibabel/bin/nib-dicomfs, /Users/mb312/dev_trees/nibabel/bin/nifti1_diagnose.py
 
-* Check the documentation doctests::
+    Fix ``setup.py`` to carry across any files that should be in the
+    distribution.
 
-    make -C doc doctest
+  * Check the documentation doctests::
 
-  This should also be tested by `nibabel on travis`_.
+      make -C doc doctest
 
-* Check everything compiles without syntax errors::
+    This should also be tested by `nibabel on travis`_.
 
-    python -m compileall .
+  * Check everything compiles without syntax errors::
 
-* Edit ``nibabel/info.py`` to set ``_version_extra`` to ``''``; commit.
-  Then::
+      python -m compileall .
 
-    make source-release
+  * Check that nibabel correctly generates a source distribution::
 
-* Make sure you are set up to use the ``try_branch.py`` - see
-  https://github.com/nipy/nibotmi/blob/master/install.rst#trying-a-set-of-changes-on-the-buildbots
+      make source-release
 
-* Make sure all your changes are committed or removed, because
-  ``try_branch.py`` pushes up the changes in the working tree;
+* Edit ``nibabel/info.py`` to set ``_version_extra`` to ``''``; commit;
+
+* You may have virtualenvs for different Python versions.  Check the tests
+  pass for different configurations. The long-hand way looks like this::
+
+    workon python26
+    make distclean
+    make sdist-tests
+    deactivate
+
+  etc for the different virtualenvs;
+
+* Check on different platforms, particularly windows and PPC. Look at the
+  `nipy buildbot`_ automated test runs for this;
 
 * Force build of your release candidate branch with the slow and big-memory
   tests on the ``zibi`` buildslave::