-
Bump the version numbers in the
develop
branch, in BOTH thepyproject.toml
file and the__init__
. -
Update RELEASE.md.
- Make sure it contains up-to-date release notes for the next release.
- They should cover all changes that are visible to library users on the
develop
branch since the most recent release. - They should make clear to users whether they might benefit from this release and what backwards incompatibilities they might face.
- They should cover all changes that are visible to library users on the
- Make sure the release version matches what you were setting elsewhere.
- Make a new copy of the template, to prepare for the next release.
- Make sure it contains up-to-date release notes for the next release.
-
Create a release PR from
develop
tomain
.- Make a merge commit. DO NOT SQUASH-MERGE.
- If you squash-merge,
main
will be ahead of develop (by the squash-merge commit). This means we’ll end up with merge conflicts at the following release!
-
Go to the release page on GitHub and create a release for a tag “v{VERSION}” (e.g., for version 2.1.3 the tag needs to be
v2.1.3
) tomain
branch. Copy the release notes into the description field! -
You are almost done now! Go to https://github.com/GPflow/check_shapes/actions and monitor the tests for your newly-created release passed and the job for pushing the pip package succeeded. GitHub Actions are triggered by the publication of the release above.
-
Take a break; wait until the new release shows up on PyPi.
Done done! Go and celebrate our hard work :)