Release checklist

For Every Release

1. Merge your changes from features/release branch to master/main.

2. Update HISTORY.md

   Be noticed that github workflow will generate a changelog for you automatically, but you'll have to make your own history.md.

3. Commit the changes:

   git add HISTORY.md
   git commit -m "Changelog for upcoming release 0.1.1."
   

4. Update version number (can also be patch or major)

   poetry patch
   

5. Run the tests:

   tox
   

6. Push the commit to main branch:

   git push
   

7. Push the tags, creating the new release on both GitHub and PyPI:

   git tag -a v`poetry version --short` -m "my great release"
   git push --tags
   

   tag_name has to be started with 'v'(lower case), to leverage github release workflow.

8. Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If tox test passed, this should be ok, since we have already run twine check during tox test.

Info

About This Checklist

This checklist is adapted from:

• https://gist.github.com/audreyr/5990987
• https://gist.github.com/audreyr/9f1564ea049c14f682f4

It's assumed that you are using all features of Python Project Wizard.