Skip to content

Commit

Permalink
README.md: clarify API stability
Browse files Browse the repository at this point in the history
We need the ability to make experimental changes without new definitions
immediately becoming part of the stable v2 API.
  • Loading branch information
pohly committed Feb 14, 2022
1 parent 8d77629 commit 4b2ca31
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -23,6 +23,18 @@ Historical context is available here:
* https://groups.google.com/forum/#!msg/kubernetes-sig-architecture/wCWiWf3Juzs/hXRVBH90CgAJ
* https://groups.google.com/forum/#!msg/kubernetes-dev/7vnijOMhLS0/1oRiNtigBgAJ

## Release versioning

Semantic versioning is used in this repository. It contains several Go modules
with different levels of stability:
- `k8s.io/klog/v2` - stable API, `vX.Y.Z` tags
- `k8s.io/tools` - no stable API yet (may change eventually), `tools/v0.Y.Z` tags
- `examples` - no stable API, no tags, no intention to ever stabilize

Exempt from the API stability guarantee are items (packages, functions, etc.)
which are marked explicitly as `EXPERIMENTAL` in their document comment. Those
may still change in incompatible ways or get removed entirely.

----

How to use klog
Expand Down

0 comments on commit 4b2ca31

Please sign in to comment.