From 87e8e9c7f60b0a03aefdde427ffb4346bb86bf35 Mon Sep 17 00:00:00 2001 From: Derek McGowan Date: Tue, 27 Feb 2024 23:27:07 -0800 Subject: [PATCH] Add Go client stability in releases for 2.0. Signed-off-by: Derek McGowan --- RELEASES.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/RELEASES.md b/RELEASES.md index 69d8f27b316f..9b8c02ec94b5 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -245,7 +245,7 @@ containerd versions: | Runtime Shim API | Stable | 1.2 | - | | Daemon Config | Stable | 1.0 | - | | CRI GRPC API | Stable | 1.6 (_CRI v1_) | [cri-api](https://github.com/kubernetes/cri-api/tree/master/pkg/apis/runtime/v1) | -| Go client API | Unstable | _future_ | [godoc](https://godoc.org/github.com/containerd/containerd/v2/client) | +| Go client API | Stable | 2.0 | [godoc](https://pkg.go.dev/github.com/containerd/containerd/v2/client) | | `ctr` tool | Unstable | Out of scope | - | From the version stated in the above table, that component must adhere to the @@ -255,6 +255,11 @@ Unless explicitly stated here, components that are called out as unstable or not covered may change in a future minor version. Breaking changes to "unstable" components will be avoided in patch versions. +Go client API stability includes the `client`, `defaults` and `version` package +as well as all packages under `pkg`, `core`, `api` and `protobuf`. +All packages under `cmd`, `contrib`, `integration`, and `internal` are not +considered part of the stable client API. + ### GRPC API The primary product of containerd is the GRPC API. As of the 1.0.0 release, the