[x] Update the version in __about__.py (see the Contribution Guide guide for more information).
[x] Update the relevant section of the Changelog with release notes.
You may need to view the commit history since the last release to identify any changes that were missed.
Merging:
[x] Merge this PR manually with a signed merge commit.
# Using "v0.1a" as an example version
git checkout main
git merge --no-ff --sign --edit ${source branch}
An editor will open to edit the commit message, which should be the content of the changelog with some tweaks (see the Contribution Guide).
Don't forget to git push the merge commit.
After Merging:
[x] Create a signed and annotated tag with the current release's changelog:
git tag --gpg-sign $VERSION # e.g., v0.1a
An editor will open to edit the annotation, which should be the content of the changelog with some tweaks (see the Contribution Guide).
Don't forget to git push origin refs/tags/$VERSION
[x] Create a GitHub Release for the new tag. The title should be the release version (e.g., v0.1a).
The release notes will be the same tweaked changelog contents (see the Contribution Guide).
If the release is a pre-release (a, b, or rc suffixes) make sure to check the "Set as a pre-release" box.
Details from the Contribution Guide.
Before Merging:
__about__.py(see the Contribution Guide guide for more information).Merging:
[x] Merge this PR manually with a signed merge commit.
An editor will open to edit the commit message, which should be the content of the changelog with some tweaks (see the Contribution Guide).
Don't forget to
git pushthe merge commit.After Merging:
[x] Create a signed and annotated tag with the current release's changelog:
An editor will open to edit the annotation, which should be the content of the changelog with some tweaks (see the Contribution Guide).
Don't forget to
git push origin refs/tags/$VERSIONv0.1a). The release notes will be the same tweaked changelog contents (see the Contribution Guide). If the release is a pre-release (a,b, orrcsuffixes) make sure to check the "Set as a pre-release" box.