diff options
| author | Jarrod Millman <jarrod.millman@gmail.com> | 2017-09-20 11:28:46 -0700 |
|---|---|---|
| committer | Jarrod Millman <jarrod.millman@gmail.com> | 2017-09-20 11:43:17 -0700 |
| commit | e536af4922d1f802f317e325bc6a397173388952 (patch) | |
| tree | fd8fbeb7477f7ad1f65c7ebb6f873f57d9e7d5ac | |
| parent | 4655568c4959121ed75a15c6e1e388ab67111b8c (diff) | |
| download | networkx-e536af4922d1f802f317e325bc6a397173388952.tar.gz | |
Update release procedure doc
| -rw-r--r-- | RELEASE.rst | 44 |
1 files changed, 20 insertions, 24 deletions
diff --git a/RELEASE.rst b/RELEASE.rst index 2d9768fe..edfe9280 100644 --- a/RELEASE.rst +++ b/RELEASE.rst @@ -3,7 +3,7 @@ How to make a new release of ``networkx`` - Update the release notes: - 1. Review and cleanup ``doc/release/release_dev.txt``, + 1. Review and cleanup ``doc/release/release_dev.rst``, 2. Fix code in documentation by running ``cd doc && make doctest``. @@ -11,14 +11,14 @@ How to make a new release of ``networkx`` 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.txt``. Scan the PR titles + 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>.txt``. + 5. Rename to ``doc/release/release_<major>.<minor>.rst``. - 6. Copy ``doc/release/release_template.txt`` to - ``doc/release/release_dev.txt`` for the next release. + 6. Copy ``doc/release/release_template.rst`` to + ``doc/release/release_dev.rst`` for the next release. 7. Update ``doc/news.rst``. @@ -50,33 +50,29 @@ How to make a new release of ``networkx`` python setup.py sdist --formats=zip twine upload -s dist/networkx*.zip -- Increase the version number - - - Toggle ``dev = False`` to ``dev = True`` in ``networkx/release.py``. - - Update ``major`` and ``minor`` in ``networkx/release.py``. - -- Build the documentation:: - - cd doc - make docs - - The built documentation is in ``build/html``. - -- Push documentation to the web: +- 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 that you built in the previous step. - Assuming your ``networkx`` and your ``documentation`` repos are in the - same parent directory:: + - Copy the documentation built by Travis. + Assuming you are at the top-level of the ``documentation`` repo:: - cp -a ../networkx/doc/build/html networkx-<major>.<minor> + 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 - - Update the symlink to ``stable``. - - Push upstream + - 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 |
