Document the versioning scheme #19114
Conversation
This documents the versioning scheme proposed with iree-org#18938, refined as part of the discussion iree-org#19003 (first drafted patch) and iree-org#19034 (second drafted patch) and applied with commit 6d55a11.
marbre
force-pushed
the
versioning-scheme-doc
branch
from
583c697
to
c0d10e4
Compare
| * After a release, `Y` MUST be increased to ensure precedence of nightly builds. | ||
| For example: | ||
| * The latest stable release published on November 15th 2024 is versioned as | ||
| version `3.0.0`. | ||
| * The next nightly builds are released as `3.1.0rc20241116`. | ||
| * The next stable release is released as or `3.1.0`. |
There was a problem hiding this comment.
How do patch releases factor in here?
There was a problem hiding this comment.
I think for nightly released we need to branch of at the tag for the stable release and apply whatever patches are needed. This is not addressed here and might be better suited to be placed at https://github.com/iree-org/iree/blob/main/docs/website/docs/developers/general/release-management.md. WDYT? Want me to add a section to release-management.md (in follow up PR)?
There was a problem hiding this comment.
This made it seem like the patch version is never incremented, since
- If the version
XorYare changed,ZMUST be set0. - After a release,
YMUST be increased
Maybe qualify "after a release" to "after a regularly scheduled release" leave room for patch releases
There was a problem hiding this comment.
Ah, I see. I add a sentence here than as well but also send a separate PR that documents on who we could cut a patch release.
This documents the versioning scheme proposed with #18938, refined as part of the discussion #19003 (first drafted patch) and #19034 (second drafted patch) and applied with commit 6d55a11.