From cf583a3caed729b0a9a7cd7512a4ae7b9c4688b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 28 Nov 2024 13:34:49 +0100 Subject: [PATCH] Refactor versioning specs --- README.md | 8 ++++++++ specification/versioning.md | 19 +++++-------------- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c32d05d..6f19350 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,14 @@ document. Lifecycle stages are defined in the - [1]: See [stability guarantees](./specification/versioning.md) for details. +## Experimental + +Everything in the specification starts as `Experimental`. + +`Experimental` sections SHOULD NOT be expected to be feature-complete. +In some cases, the experiment MAY be discarded and removed entirely. +Long-term dependencies SHOULD NOT be taken against experimental sections. + ### Feature freeze In addition to the statuses above, documents may be marked as `Feature-freeze`. diff --git a/specification/versioning.md b/specification/versioning.md index 0d069cd..23a3c84 100644 --- a/specification/versioning.md +++ b/specification/versioning.md @@ -3,26 +3,17 @@ **Status**: [Stable](../README.md#versioning-and-status-of-the-specification) All GDI repositories MUST be versioned according to [Semantic Versioning -2.0](https://semver.org/spec/v2.0.0.html). GDI repositories are versioned -separately from OpenTelemetry repositories as Splunk-specific breaking changes -MAY be introduced. GDI repositories MUST indicate what version of OpenTelemetry +2.0](https://semver.org/spec/v2.0.0.html) and versioning idiomatic to their +language. +GDI repositories are versioned separately from OpenTelemetry repositories as +Splunk-specific breaking changes MAY be introduced. +GDI repositories MUST indicate what version of OpenTelemetry repositories they are based on through release notes and SHOULD indicate through logging. Additional version number constraints can be found in the sections below. ## Experimental -Everything in the specification starts as experimental, which covers alpha, -beta, and release candidate versions. Version numbers for releases MUST be less -than `1.0.0` while experimental. The minor version number SHOULD be increased -when significant or breaking changes are introduced. - -While any section in the specification is experimental, breaking changes and -performance issues MAY occur. Sections SHOULD NOT be expected to be -feature-complete. In some cases, the experiment MAY be discarded and removed -entirely. Long-term dependencies SHOULD NOT be taken against experimental -sections. - GDI repositories MAY consist of one or more components. GDI repositories MUST be designed in a manner that allows experimental components to be created without breaking the stability guarantees of existing components. GDI repositories MUST NOT