Release Process#

  • Set release variables:

    export VERSION=<version number>
export PREVIOUS=<previous version number>
export ORG="networkx"
export REPO="networkx"

    If this is a prerelease:

    export NOTES="doc/release/release_dev.rst"

    If this is release:

    export NOTES="doc/release/release_${VERSION}.rst"
git rm doc/release/release_dev.rst

  • Autogenerate release notes:

    changelist ${ORG}/${REPO} networkx-${PREVIOUS} main --version ${VERSION} --out ${NOTES} --format rst
changelist ${ORG}/${REPO} networkx-${PREVIOUS} main --version ${VERSION} --out ${VERSION}.md

    Note

    The release notes are generated twice here - the reST version is included in the documentation, while the markdown version is included with releases on GitHub.

  • Edit doc/_static/version_switcher.json in order to add the release, move the key value pair "preferred": true to the most recent stable version, and commit. For an rc, skip this step.

  • Update doc/release/index.rst.

  • Update __version__ in networkx/__init__.py.

  • Commit changes:

    git add networkx/__init__.py ${NOTES} doc/_static/version_switcher.json doc/release/index.rst
git commit -m "Designate ${VERSION} release"

  • Add the version number as a tag in git:

    git tag -s networkx-${VERSION} -m "signed ${VERSION} tag"

  • Push the new meta-data to github:

    git push --tags origin main

    (where origin is the name of the github.com:networkx/networkx repository.)

  • Review the github release page: networkx/networkx

  • Update documentation on the web:

    Note

    This step does not apply to rc releases.

    The documentation is kept in a separate repo: networkx/documentation

    • Wait for the CI service to deploy to GitHub Pages

    • Sync your branch with the remote repo: git pull.

    • Copy the documentation built by the CI service. Assuming you are at the top-level of the documentation repo:

      # FIXME - use eol_banner.html
cp -a latest ../networkx-${VERSION}
git reset --hard <commit from last release>
mv ../networkx-${VERSION} .
rm -rf stable
cp -rf networkx-${VERSION} stable
git add networkx-${VERSION} stable
git commit -m "Add ${VERSION} docs"
git push  # force push---be careful!

  • Update __version__ in networkx/__init__.py. The new version should increment either the patch number or the rc number depending on whether or not the release is an rc. For example, if you are releasing version X.Y, the __version__ should be updated to X.Y.1rc0.dev0. If instead the release is an rc, then increment the rc number — for example, if releasing X.Yrc0, the __version__ should be updated to X.Yrc1.dev0.

    • Commit and push changes:

      git add networkx/__init__.py
git commit -m "Bump release version"
git push origin main

  • Update the web frontpage:

    Note

    This step does not apply to rc releases.

    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 build/index.html.

    • Edit build/_static/docversions.js and commit

    • Push your changes to the repo.

    • Deploy using make github.

  • Post release notes on mailing list.