PKG: Update release notes.

Note: added extra spacing around sublists because docutils will complain otherwise.
This commit is contained in:
Tony S Yu
2012-09-30 11:52:48 -04:00
committed by Stefan van der Walt
parent 4fb74935ec
commit eadee6ce38
+30 -12
View File
@@ -2,34 +2,52 @@ How to make a new release of ``skimage``
========================================
- Update release notes.
- Update the version number in setup.py and bento.info and commit
- To show a list contributors, run ``doc/release/contributors.sh <commit>``,
where ``<commit>`` is the first commit since the previous release.
- Update the version number in ``setup.py`` and ``bento.info`` and commit
- Update the docs:
- Edit ``doc/source/themes/agogo/static/docversions.js`` and commit
- Build a clean version of the docs. Run "make" in the root dir, then
``rm build -rf; make html`` in the docs. Make sure the random.js
- Build a clean version of the docs. Run ``make`` in the root dir, then
``rm build -rf; make html`` in the docs. Make sure the ``random.js``
- Run ``make html`` again to copy the newly generated ``random.js`` into
place. Double check ``random.js``, otherwise the skimage.org front
page gets broken!
- Push upstream using "make gh-pages"
- Build using ``make gh-pages``.
- Push upstream: ``git push`` in ``doc/gh-pages``.
- Add the version number as a tag in git::
git tag v0.6
git tag v0.X.0
- Push the new meta-data to github::
git push --tags origin master
git push --tags origin master
- Publish on PyPi:
- Publish on PyPi::
python setup.py register
python setup.py sdist upload
python setup.py register
python setup.py sdist upload
- Increase the version number in the setup.py file to ``0.Xdev``.
- Increase the version number
- In ``setup.py``, set to ``0.Xdev``.
- In ``bento.info``, set to ``0.X.dev0``.
- Update the web frontpage:
The webpage is kept in a separate repo: scikits-image-web
- ``_templates/sidebar_versions.html``
- ``index.rst``
- Sync your branch with the remote repo: ``git pull``.
If you try to ``make gh-pages`` when your branch is out of sync, it
creates headaches.
- Update stable and development version numbers in
``_templates/sidebar_versions.html``.
- Add release date to ``index.rst`` under "Announcements".
- Build using ``make gh-pages``.
- Push upstream: ``git push`` in ``gh-pages``.
- Post release notes on mailing lists, blog, G+, etc.