Making a New Release

1. Navigate to the latest version of main on your fork of the repo.
2. Create a new branch eg release-vxxx.
3. Run python -m superduperdb release [RELEASE] from the command line. RELEASE can be one of major, minor or patch, depending on what type of release is to be made. This command updates the version number in __init__.py, and creates a new Git commit with the title 'Update to version vX.X.X'.
4. Open a Pull Request.
5. After approval and merge to main, this will automatically trigger the release action. (Information: The trigger for the action is actually the name of the commit. The action will be run when any commit that begins 'Update to version ...' is merged to main.)
6. Please monitor the release action until the upload to PyPI is complete. This is the responsibility of the author of the PR and is very important. While everything is automated, it is still important to make sure that the machines have not done anything strange. 🙃