Skip to content

Creating a release

Jump to bottom
Jeffrey Gill edited this page Jul 22, 2019 · 44 revisions

  1. Gather closed issues and pull requests related to the release into a GitHub milestone:

    https://github.com/jpgill86/neurotic/milestones

  2. Create a branch called "release-X.X.X" using the real release number.

  3. In the docs, add a change log entry referencing each notable PR and issue (remember to add a link from releasenotes.rst!)

  4. In setup.py, set IS_RELEASED = True and set the new version number.

  5. Commit these changes to the branch with the message "Prepare release X.X.X" and open a pull request.

  6. Wait for all tests to pass:

    https://travis-ci.com/jpgill86/neurotic

  7. If tests are OK, do not merge yet, since you should first verify PyPI is happy with your changes. On your local machine, delete any old build directories:

    cd neurotic
rm -rf build dist neurotic.egg-info

  8. Build for distribution:

    python setup.py sdist bdist_wheel

  9. Upload the build artifacts to PyPI's test server:

    twine upload --repository-url https://test.pypi.org/legacy/ dist/*

  10. Verify the test release looks OK:

    https://test.pypi.org/project/neurotic/

  11. If PyPI is OK, merge the pull request with commit name "Release X.X.X", then verify that the new release notes built correctly:

    https://neurotic.readthedocs.io/en/latest/releasenotes.html

  12. If the docs are OK, tag the PR merge commit with the release number and push the tag to GitHub.

  13. Mark the new release as an active version on Read the Docs so that an archive of the docs for the current version is available in the future even after later releases:

    https://readthedocs.org/projects/neurotic/versions/

  14. If all is well, rebuild the package (to get post-merge git_revision) and upload to the official PyPI server (THIS CANNOT BE UNDONE OR OVERWRITTEN):

    rm -rf build dist neurotic.egg-info
python setup.py sdist bdist_wheel
twine upload dist/*

  15. Verify the official release looks OK:

    https://pypi.org/project/neurotic/

  16. In setup.py, set IS_RELEASED = False and increment the version number to the next minor release.

  17. Commit these changes directly to master with the message "After release" and push to GitHub.

  18. Create a GitHub release from the pushed tag containing the release notes:

    https://github.com/jpgill86/neurotic/tags

  19. Close the milestone and create a new one for the next minor release:

    https://github.com/jpgill86/neurotic/milestones

Clone this wiki locally