medaprep/RELEASE.md at master · makepath/medaprep

Release process

Create a new branch containing the following changes:
- Update CHANGELOG.md with new version number and list of changes extracted from git log --pretty=oneline --pretty=format:"- %s" <lastest_release_tag>..HEAD.
- Add the new version reference in porcupine/docs/source/releases.json
- Check that the new version number is included in smv_tag_whitelist in docs/source/conf.py so that the docs will be built and uploaded by CI.
Commit changes and submit them as a PR to the master branch.
If the CI passes OK, merge the PR.

To sign the release you need a GPG key registered with your github account. See https://docs.github.com/en/authentication/managing-commit-signature-verification
Create new tag, with the correct version number, using:

git tag -a v0.1.2 -s -m "Version 0.1.2"
git push --tags

These are automatically built and uploaded to PyPI via a github action when a new tag is pushed to the github repo.
Check that both an sdist (.tar.gz file) and wheel (.whl file) are available on PyPI.
Check you can install the new version in a new virtual environment using pip install porcupine.

Convert the tag into a release on github:
- On the right-hand side of the github repo, click on Releases.
- Click on Draft a new release.
- Select the correct tag, and enter the title and description by copying and pasting from the CHANGELOG.md.
- Click Publish release.