kubernetes-sigs / kubernetes-sigs/node-readiness-controller

[TRACKING] Define Project Versioning, Compatibility, and Release Playbook

Open
#225 8 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
163
Forks
74
Avg merge
2d 18h
Merged PRs (30d)
9

Description

As node-readiness-controller matures (currently v0.3.0), we need a formalised structure for versioning and support to provide stability for our users and a clear roadmap for contributors. This issue tracks the creation and documentation of our versioning strategy.

We need to do things like:

- [ ] Draft Versioning Policy: Define Semantic Versioning (SemVer) usage.
- [ ] Establish Support Lifecycle: Define how many minor versions we support (e.g., N-2).
- [ ] Create Compatibility Matrix: Document the mapping between Controller versions and Kubernetes versions.
- [ ] Write Versioning Playbook: Standardise the release process (tagging, CI, changelogs).
- [ ] Publish Documentation: Add /docs/VERSIONING.md and update README.md.

Relates to #151

[TBD - this must be discussed with maintainers first]

Contributor guide

Open the contributing guide

Research direction

Start by discussing the proposed versioning and support structure with maintainers, including SemVer, the support lifecycle, and the Kubernetes compatibility matrix. Then define the release steps for tagging, CI, and changelogs, add docs/VERSIONING.md, and update README.md; completion means all listed policy and documentation areas are agreed and published.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.