HOWTO Release - poliastro/poliastro GitHub Wiki

Before release

  • Rerun notebooks
  • Complete Changelog
  • Add future branch to AppVeyor CI script
  • New branch
  • Bump version in:
    • README.rst
    • __init__.py
    • Sphinx conf.py
    • AppVeyor CI script
  • Check that the release branch will be tested on CI
  • Check all the badges in README point to the appropriate git branch (replace master by new branch sed -i 's/master/.../g' README.rst)
  • Check that docs badges and URLs point to appropriate tag (replace latest by new tag, without sed!)
  • Commit
  • Generate sdist and bdist_wheel
  • twine upload dist/* --repository-url https://test.pypi.org/legacy/
  • Tag
  • Bump master to next development version
  • Cherry pick the changelog with the release date

Release

  • Push branch to GitHub and tags
  • Upload sdist and bdist_wheel to PyPI - this step cannot be undone if the release is removed! twine upload dist/* --repository-url https://upload.pypi.org/legacy/
  • Rebuild conda-forge feedstock (automatic)
  • Create GitHub release
  • Check Read the Docs (might take a while)
  • Add Zenodo badge to GitHub release
  • Send announcement email
  • Add link to announcement email in GitHub release
  • Close milestone