docs: add VERSIONING.md for release versioning and agent skew#741
Open
Yetkin Timocin (ytimocin) wants to merge 1 commit into
Open
docs: add VERSIONING.md for release versioning and agent skew#741Yetkin Timocin (ytimocin) wants to merge 1 commit into
Yetkin Timocin (ytimocin) wants to merge 1 commit into
Conversation
Yetkin Timocin (ytimocin)
force-pushed
the
docs/versioning-guide
branch
from
June 26, 2026 18:09
921c064 to
be75dc5
Compare
Document the versioning scheme (SemVer with -rc pre-releases and 0.x semantics), release cadence and support window, the 0.x minor-vs-patch bump criteria, the supported hub/member agent version skew (symmetric one-minor, validated by the upgrade compatibility suite), the recommended hub-first upgrade ordering, the Work/AppliedWork and InternalMemberCluster cross-agent contracts, and CRD API versioning. Add a pointer from the README. Refs kubefleet-dev#693 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yetkin Timocin <ytimocin@microsoft.com>
Yetkin Timocin (ytimocin)
force-pushed
the
docs/versioning-guide
branch
from
July 16, 2026 22:03
be75dc5 to
003974b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of your changes
Adds
VERSIONING.md, the versioning and upgrade policy document tracked under the Phase 1 release-process work in #693. It complements the support-window policy inSECURITY.mdand the contribution conventions inCONTRIBUTING.md.The document covers:
vMAJOR.MINOR.PATCHwith-rc.Npre-releases (matching the tag validation insetup-release.yml), and the pre-1.00.y.zsemantics (minors may break; patches are a deliberate backward-compatible commitment stricter than SemVer requires for0.y.z).N/N-1supported, deferring the authoritative statement toSECURITY.md.upgrade.yml(hub-agent-backward-compatibility,member-agent-backward-compatibility,full-backward-compatibility). The doc explicitly notes where this symmetric one-minor guarantee deliberately diverges from the asymmetric Kubernetes kubelet skew policy and why.Work/AppliedWorkandInternalMemberClusterstatus contracts that must stay backward-compatible across a skew window.v1andv1beta1are served for the placement and cluster groups (v1the promoted surface,v1beta1the storage version), deferring per-API lifecycle to the upstream Kubernetes API deprecation policy by convention, plus Helm-vs-raw-YAML CRD upgrade guidance.Also adds a one-line pointer to
VERSIONING.mdfrom the README.Maps to #693 Phase 1.
Refs #693
I have:
make reviewableto ensure this PR is ready for review. (No-op for this PR: no Go sources touched; docs/markdown CI covers the changed files.)How has this code been tested
VERSIONING.mdwere verified to resolve to real paths in the repo (SECURITY.md,CONTRIBUTING.md,.github/workflows/setup-release.yml,.github/workflows/upgrade.yml,test/upgrade/upgrade.sh, both charttemplates/crds/directories).semver.org, the Kubernetes version-skew and API-deprecation policy pages).paths-ignore/detect-noopscoping inupgrade.yml; the member-to-hub heartbeat path (member patchesInternalMemberClusterstatus, hub mirrors toMemberCluster); thev1/v1beta1served-and-storage settings in the CRD manifests; and the Helmtemplates/crds/upgrade behavior.Special notes for your reviewer