Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.3 KB

RELEASE.md

File metadata and controls

55 lines (35 loc) · 1.3 KB

Release procedure

Pre-requisites

  • Must have push rights to the GitHub repository
  • Must be a maintainer or owner of the project on PyPI
  • Must have valid PyPI credentials in ~/.pypirc
  • Should be a maintainer of the project on ReadTheDocs

Release

  1. Update version number in mosromgr/__init__.py

  2. Update changelog with summary of changes in docs/changelog.rst

  3. Ensure all code changes are reflected in the documentation and that the documentation builds correctly (make doc)

  4. Commit final changes and tag with the version number:

    git tag -a v0.8.1 -m v0.8.1
  5. Push to GitHub, including tags:

    git push
    git push --tags
  6. Run make build to create source (.tar.gz) and binary (.whl) distributions in dist/

  7. Run make release to release source and binary distribution files to PyPI

  8. ReadTheDocs should build the new version automatically if the connection to GitHub is active. Verify and login to check status if needed. There should be a new version available, and the stable branch of the docs should now reflect the new release.

Bus factor

GitHub owners:

  • BBC / News Labs team

PyPI owners:

  • Ben Nuttall
  • Rich Wareham

ReadTheDocs owners:

  • Ben Nuttall
  • Rich Wareham