Skip to content

Release checklist

PyPI Release Checklist

Before Your First Release

You better visit PyPI to make sure your package name is unused.

For Every Release

  1. Make some pull requests, merge all changes from feature branch to master/main.

  2. Update CHANGELOG.md manually. Make sure it follows the Keep a Changelog standard. Be noticed that GitHub workflow will read changelog and extract release notes automatically.

  3. Commit the changelog changes:

    1
2
    git add CHANGELOG.md
git commit -m "Changelog for upcoming release 0.1.1."

  4. Update version number.

  5. Push these commits to master/main:

    1
    git push

    Before proceeding to the next step, please check workflows triggered by this push have passed.

  6. Create and push the tag to master/main, creating the new release on both GitHub and PyPI:

    Only tag name started with 'v'(lower case) will leverage GitHub release workflow.

  7. Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly.