From 839da241aa793dd1e7ac6760cd8be808b03be4dc Mon Sep 17 00:00:00 2001 From: "Ben B." Date: Wed, 30 Oct 2024 12:18:41 +0100 Subject: [PATCH] docs: outline go support policy (#2839) Signed-off-by: Benedikt Bongartz --- README.md | 5 +---- docs/compatibility.md | 13 +++++++++++++ 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0eea97f5da..b18a3745b8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ The operator manages: ## Documentation +- [Compatibility & Support docs](./docs/compatibility.md) - [API docs](./docs/api.md) - [Offical Telemetry Operator page](https://opentelemetry.io/docs/kubernetes/operator/) @@ -790,10 +791,6 @@ The priority for setting resource attributes is as follows (first found wins): This priority is applied for each resource attribute separately, so it is possible to set some attributes via annotations and others via labels. -## Compatibility - -See [here](docs/compatibility.md). - ## Contributing and Developing Please see [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/docs/compatibility.md b/docs/compatibility.md index 64d9d7d211..dd9a41890b 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -2,6 +2,19 @@ This document details compatibility guarantees the OpenTelemetry Operator offers for its dependencies and platforms. +## Go + +When productised as a go libary or custom distribution the OpenTelemetry Operator project attempts to follow the supported go versions as [defined by the Go team](https://go.dev/doc/devel/release#policy). + +Similar to the [opentelemetry collector](https://github.com/open-telemetry/opentelemetry-collector?tab=readme-ov-file#compatibility), removing support for an unsupported Go version is not considered a breaking change. + +Support for Go versions on the OpenTelemetry Operator is updated as follows: + + The first release after the release of a new Go minor version N will add build and tests steps for the new Go minor version. + The first release after the release of a new Go minor version N will remove support for Go version N-2. + +Official OpenTelemetry Operator binaries may be built with any supported Go version. + ## Kubernetes As a rule, the operator tries to be compatible with as wide a range of Kubernetes versions as possible.