Skip to content

Commit 41074af

Browse files
committed
Merge remote branch 'origin/release-notes'
* origin/release-notes: DOC - filling in release proecdures and improving `.gitignores` DOC - moved old files out of the way DOC - place to put old files until it is clear where they belong
2 parents 174a6ea + a9710e3 commit 41074af

19 files changed

+85
-22
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,4 @@ Thumbs.db
7272
# Things specific to this project #
7373
###################################
7474
nibabel.egg-info/
75+
doc/source/generated
File renamed without changes.

doc/source/devguide.rst renamed to doc/source/devel/devguide.rst

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
.. -*- mode: rst; fill-column: 79 -*-
2-
.. ex: set sts=4 ts=4 sw=4 et tw=79:
1+
.. -*- mode: rst; fill-column: 79 -*- .. ex: set sts=4 ts=4 sw=4 et tw=79:
32
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
43
#
54
# See COPYING file distributed along with the NiBabel package for the
@@ -19,7 +18,7 @@ NiBabel source code
1918
.. toctree::
2019
:maxdepth: 2
2120

22-
gitwash/index
21+
../gitwash/index
2322

2423
Documentation
2524
=============
@@ -109,20 +108,3 @@ the algorithms with implications to the performance or validity of results.
109108

110109
It may list references to 3rd party bugtrackers, in case the reported bugs
111110
match the criteria listed above.
112-
113-
114-
Releases
115-
========
116-
117-
Right after each release the master branch should be tagged with an annotated
118-
(or/and signed) tag, naming the intended next version, plus an 'upstream/'
119-
prefix and 'dev' suffix. For example 'upstream/1.0.0.dev' means "development
120-
start for upcoming version 1.0.0.
121-
122-
This tag is used in the Makefile rules to create development snapshot releases
123-
to create proper versions for those. The will name the last available annotated
124-
tag, the number of commits since that, and an abbrevated SHA1. See the docs of
125-
``git describe`` for more info.
126-
127-
Please take a look at the Makefile rules ``devel-src``, ``devel-dsc`` and
128-
``orig-src``.

doc/source/devel/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. -*- mode: rst -*-
2+
.. ex: set sts=4 ts=4 sw=4 et tw=79:
3+
4+
.. toctree::
5+
:hidden:
6+
7+
devguide
8+
devdiscuss
9+
make-release

doc/source/devel/make-release.rst

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.. _release-guide:
2+
3+
***********************************
4+
A guide to making a nibabel release
5+
***********************************
6+
7+
A guide for developers who are doing a nibabel release
8+
9+
* Edit :file:`info.py` and bump the version number
10+
11+
.. _release-tools::
12+
13+
Release tools
14+
=============
15+
16+
In :file:`nibabel/tools`, among other files, you will find
17+
the following utilities::
18+
19+
nibabel/tools/
20+
|- build_release
21+
|- release
22+
|- compile.py
23+
|- make_tarball.py
24+
|- toollib.py
25+
26+
.. _release-checklist:
27+
28+
Release checklist
29+
=================
30+
31+
* Make sure all tests pass.
32+
33+
* Review the open list of `issues <http://github.com/nipy/nibabel/issues>`_
34+
35+
* Run :file:`build_release` from the :file:`tools` directory::
36+
37+
cd tools
38+
./build_release
39+
40+
* Review and update the release notes. Review and update the :file:`Changelog`
41+
file. Get a partial list of contributors::
42+
43+
git log "$@" | grep '^Author' | cut -d' ' -f 2- | sort | uniq
44+
45+
Then manually go over the *git log* to make sure the release notes are
46+
as complete as possible and that every contributor was recognized.
47+
48+
* Tag the release.
49+
50+
* Once everything looks good, run :file:`release` from the
51+
:file:`tools` directory.
52+
53+
* Announce to the mailing lists.
54+
55+
Releases
56+
========
57+
58+
After each release the master branch should be tagged
59+
with an annotated (or/and signed) tag, naming the intended
60+
next version, plus an 'upstream/' prefix and 'dev' suffix.
61+
For example 'upstream/1.0.0.dev' means "development start
62+
for upcoming version 1.0.0.
63+
64+
This tag is used in the Makefile rules to create development
65+
snapshot releases to create proper versions for those. The
66+
will name the last available annotated tag, the number of
67+
commits since that, and an abbrevated SHA1. See the docs of
68+
``git describe`` for more info.
69+
70+
Please take a look at the Makefile rules ``devel-src``,
71+
``devel-dsc`` and ``orig-src``.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)