Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.15 KB

RELEASING.md

File metadata and controls

39 lines (27 loc) · 1.15 KB
Raw

Release Checklist

  • Get main to the appropriate code release state. GitHub Actions must be passing: Build Status

  • Ensure that the CHANGELOG.md includes the changes made since last release. Please follow the style outlined in https://keepachangelog.com/. All new entries should be added into the "Unreleased" section.

  • Bump the version number. Specify either "major", "minor", or "patch":

    tox -e bump patch

    This will take care of updating the CHANGELOG.md with the correct release information.

  • Push the bumped commit:

    git push

  • Push the tag:

    git push --tags

  • Check that the tagged GitHub Actions build has deployed correctly to PyPI.

  • Check installation:

    python -m pip uninstall -y natsort && python -m pip install -U natsort