Skip to content

Commit

Permalink
Refactor versioning specs
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared committed Nov 28, 2024
1 parent 26087ae commit cf583a3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
19 changes: 5 additions & 14 deletions specification/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cf583a3

Please sign in to comment.