Skip to content

Commit 1df0b78

Browse files
committed
DOC - updating virtualenv release test instructions
1 parent 204f7a4 commit 1df0b78

File tree

1 file changed

+51
-28
lines changed

1 file changed

+51
-28
lines changed

doc/source/devel/make_release.rst

Lines changed: 51 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -68,31 +68,6 @@ Release checklist
6868
nosetests --with-doctest nibabel
6969
cd nibabel # back to the root directory
7070

71-
* You probably have virtualenvs for different python versions. Check the tests
72-
pass for different python versions. Here's what that looks like for my
73-
virtualenv / virtualenvwrapper setup::
74-
75-
cd ..
76-
workon python25
77-
nosetests --with-doctest nibabel
78-
deactivate
79-
workon python27
80-
nosetests --with-doctest nibabel
81-
deactivate
82-
cd nibabel # back to root directory
83-
84-
* Check on different platforms, particularly windows and PPC
85-
86-
* Check the documentation doctests::
87-
88-
cd doc
89-
make doctest
90-
cd ..
91-
92-
At the moment this generates lots of errors from the autodoc documentation
93-
running the doctests in the code, where the doctests pass when run in nose -
94-
we should find out why this is at some point, but leave it for now.
95-
9671
* Make sure all tests pass from sdist::
9772

9873
make sdist-tests
@@ -116,9 +91,57 @@ Release checklist
11691
/Users/mb312/dev_trees/nibabel/nibabel/__init__.pyc
11792
{'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'}
11893

94+
* You probably have virtualenvs for different python versions. Check the tests
95+
pass for different configurations. Here's what that looks like for my
96+
virtualenv / virtualenvwrapper setup::
97+
98+
workon python25
99+
make venv-tests # can't use sdist-tests for python 2.5
100+
deactivate
101+
workon python26
102+
make sdist-tests
103+
deactivate
104+
workon python27
105+
make sdist-tests
106+
deactivate
107+
workon python3.2
108+
make sdist-tests
109+
deactivate
110+
workon np-1.2.1
111+
make venv-tests # python 2.5 again
112+
deactivate
113+
114+
* Check on different platforms, particularly windows and PPC. I have wine
115+
installed on my Mac, and git bash installed under wine. I run these via a
116+
custom script thus::
117+
118+
winebash
119+
# in wine bash
120+
make sdist-tests
121+
122+
For the PPC I have to log into an old Mac G5 in Berkeley. It doesn't have a
123+
fixed IP even, but here's an example::
124+
125+
ssh 128.32.52.219
126+
cd dev_trees/nibabel
127+
git co main-master
128+
git pull
129+
make sdist-tests
130+
131+
* Check the documentation doctests::
132+
133+
cd doc
134+
make doctest
135+
cd ..
136+
137+
At the moment this generates lots of errors from the autodoc documentation
138+
running the doctests in the code, where the doctests pass when run in nose -
139+
we should find out why this is at some point, but leave it for now.
140+
119141
* The release should now be ready.
120142

121-
* Edit :file:`nibabel/info.py` to set ``_version_extra`` to ``''``; commit
143+
* Edit :file:`nibabel/info.py` to set ``_version_extra`` to ``''``; commit.
144+
Then::
122145

123146
make distclean
124147
make source-release
@@ -129,9 +152,9 @@ Release checklist
129152
python setup.py register
130153
python setup.py sdist --formats=gztar,zip upload
131154

132-
* Tag the release with tag of form ``0.5.0``::
155+
* Tag the release with tag of form ``1.1.0``::
133156

134-
git tag -am 'First public release' 0.5.0
157+
git tag -am 'Second main release' 1.1.0
135158

136159
* Now the version number is OK, push the docs to sourceforge with::
137160

0 commit comments

Comments
 (0)