Wrap paragraphs in release instructions

This commit is contained in:
A. Jesse Jiryu Davis 2013-04-24 20:50:44 -04:00
parent b74a323704
commit 1cbe78e84f

View File

@ -29,19 +29,21 @@ Doing a Release
---------------
1. Test release on Python 2.4-2.7 and 3.1-3.3 on Windows, Linux and OSX,
with and without the C extension. Generally enough to just run the tests on 2
.4, 2.7 and 3.3 with and without the extension on a single platform,
and then just test any version on the other platforms as a sanity check.
`python setup.py test` will build the extension and test.
`python tools/clean.py` will remove the extension, and then `nosetests` will
run the tests without it. Run the replica set and mongos high-availability
tests with `PYTHONPATH=. python test/high_availability/test_ha.py` and the slow
tests with `nosetests -d test/slow`. Can also run the doctests: `python
setup.py doc -t`. For building extensions on Windows check section below.
with and without the C extension. Generally enough to just run the tests on
2.4, 2.7 and 3.3 with and without the extension on a single platform,
and then just test any version on the other platforms as a sanity check.
`python setup.py test` will build the extension and test.
`python tools/clean.py` will remove the extension, and then `nosetests` will
run the tests without it. Run the replica set and mongos high-availability
tests with `PYTHONPATH=. python test/high_availability/test_ha.py` and the slow
tests with `nosetests -d test/slow`. Can also run the doctests: `python
setup.py doc -t`. For building extensions on Windows check section below.
2. Add release notes to doc/changelog.rst. Generally just summarize/clarify the git log, but might add some more long form notes for big changes.
2. Add release notes to doc/changelog.rst. Generally just summarize/clarify
the git log, but might add some more long form notes for big changes.
3. Search and replace the "+" version number w/ the new version number (see note above).
3. Search and replace the "+" version number w/ the new version number (see
note above).
4. Make sure version number is updated in setup.py and pymongo/__init__.py
@ -53,11 +55,16 @@ setup.py doc -t`. For building extensions on Windows check section below.
8. Push source to PyPI: `python setup.py sdist upload`
9. Push binaries to PyPI; for each version of python and platform do: `python setup.py bdist_egg upload`. Probably best to do `python setup.py bdist_egg` first, to make sure the egg builds properly. Notably on the Windows machine, for Python 2.4 and 2.5, you will have to run `python setup.py build -c mingw32 bdist_egg upload` or the C extension build will fail with an error about Visual Studio 2003. On Windows we also push a binary installer. The setup.py target for that is `bdist_wininst`.
9. Push binaries to PyPI; for each version of python and platform do:`python
setup.py bdist_egg upload`. Probably best to do `python setup.py bdist_egg`
first, to make sure the egg builds properly. Notably on the Windows machine,
for Python 2.4 and 2.5, you will have to run `python setup.py build -c mingw32
bdist_egg upload` or the C extension build will fail with an error about Visual
Studio 2003. On Windows we also push a binary installer. The setup.py target
for that is `bdist_wininst`.
10. Make sure the docs have properly updated (driver buildbot does this).
11. Add a "+" to the version number in setup.py/__init__.py, commit, push.
12. Announce!