1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
|
How to make a new release of ``networkx``
=========================================
- Update the release notes:
1. Review and cleanup ``doc/release/release_dev.rst``,
2. Fix code in documentation by running
``cd doc && make doctest``.
3. Make a list of merges and contributors by running
``doc/release/contribs.py <tag of previous release>``.
4. Paste this list at the end of the ``release_dev.rst``. Scan the PR titles
for highlights, deprecations, and API changes, and mention these in the
relevant sections of the notes.
5. Rename to ``doc/release/release_<major>.<minor>.rst``.
6. Copy ``doc/release/release_template.rst`` to
``doc/release/release_dev.rst`` for the next release.
7. Update ``doc/news.rst``.
- Toggle ``dev = True`` to ``dev = False`` in ``networkx/release.py``.
- Commit changes.
- Add the version number as a tag in git::
git tag -s [-u <key-id>] networkx-<major>.<minor>
(If you do not have a gpg key, use -m instead; it is important for
Debian packaging that the tags are annotated)
- Push the new meta-data to github::
git push --tags upstream master
(where ``upstream`` is the name of the
``github.com:networkx/networkx`` repository.)
- Review the github release page::
https://github.com/networkx/networkx/releases
- Publish on PyPi::
git clean -fxd
python setup.py sdist --formats=zip
twine upload -s dist/networkx*.zip
- Update documentation on the web:
The documentation is kept in a separate repo: networkx/documentation
- Wait for the NetworkX Travis Bot to deploy to GitHub Pages
- Sync your branch with the remote repo: ``git pull``.
- Copy the documentation built by Travis.
Assuming you are at the top-level of the ``documentation`` repo::
cp -a latest networkx-<major>.<minor>
git add networkx-<major>.<minor>
ln -sfn networkx-<major>.<minor> stable
git commit -m "Add <major>.<minor> docs"
# maybe squash all the Deploy GitHub Pages commits
# git rebase -i HEAD~XX where XX is the number of commits back
# check you didn't break anything
# diff -r latest networkx-<major>.<minor>
# you will then need to force the push so be careful!
git push
- Increase the version number
- Toggle ``dev = False`` to ``dev = True`` in ``networkx/release.py``.
- Update ``major`` and ``minor`` in ``networkx/release.py``.
- Update the web frontpage:
The webpage is kept in a separate repo: networkx/website
- Sync your branch with the remote repo: ``git pull``.
If you try to ``make github`` when your branch is out of sync, it
creates headaches.
- Update ``_templates/sidebar_versions.html``.
- Edit ``_static/docversions.js`` and commit
- Push your changes to the repo.
- Deploy using ``make github``.
- Post release notes on mailing list.
- networkx-discuss@googlegroups.com
|