Release Process

Check list for new release:

Setup

• You'll need to have a local copy of bump2version installed - that's probably best done using pipx

Process

1. Checkout the main branch and ensure it's up to date

   git checkout main
   git pull
   

2. Prep CHANGELOG.md
   • Consider the unreleased entries to determine the 'bump' level of this release ('patch', 'minor' or 'major')
   • Change the 'Unreleased' heading to the new version details and save
3. Commit the change

   git add .
   git commit -m "Prep changelog for new release"
   

4. Bump the version

   bumpversion <patch|minor|major>
   

5. Push to github

    git push github
    git push github --tags
   

6. Announce on Users Forum!