-
-
Notifications
You must be signed in to change notification settings - Fork 185
Release policy and process
Ankith edited this page May 24, 2025
·
2 revisions
While we don't have a super-formal/fully-codified release policy (yet), there are some things that generally have been followed in most of our releases.
- Version tags are of the form
X.Y.Z
(eg.2.3.0
). Historically, semver wasn't followed exactly, and there are no immediate plans to shift to it either.We just randomly bump either;) We don't know when we will bumpY
orZ
depending on our moodX
next, but it must be for the next big thing. - Developmental versions are prefixed with
.dev{x}
(eg.2.3.1.dev2
).x
is odd during development leading up to a release, and even for pre-releases.
This is to be executed by the steering council, or release manager(s) chosen the steering council.
- Address all "critical" issues that may block a release.
- Ask around for changes any contributors want to see in the release.
- Make a branch called
release/[versionname]
with one version bump commit.- CI runs on this branch. Once it passes, all wheels are uploads onto a release CI drafts automatically.
- Write the release notes in this draft release. During this time, contributors (who are org members) are free to test out the wheels, help with the notes and give feedback. A checklist useful for testing
- Make sure the unit tests pass locally
- Run a couple of examples and games.
- Make a PR of this branch, and merge it.
- Click "publish release", CI automatically makes a PyPI release (after the github actions gets approval from the steering council) from all the wheel artifacts on the draft Github release.
- Delete the
release/[versionname]
branch. - (optional) If the release is the first pre-release for the current version, a new
[versionname]
branch can be made frommain
. If this is done, main can move on to the next release so that it isn't blocked till the final release. Subsequent dev releases (if any) and the final full release for this version should be based of this branch. - Make a new PR for the bump to the next development version.
- Talk about the release!
- Discord
- Any other such platforms