Skip to content

Commit dd71add

Browse files
authored
Refactor versioning docs (#328)
1 parent 26087ae commit dd71add

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,14 @@ document. Lifecycle stages are defined in the
8585

8686
- [1]: See [stability guarantees](./specification/versioning.md) for details.
8787

88+
## Experimental
89+
90+
Everything in the specification starts as `Experimental`.
91+
92+
`Experimental` sections SHOULD NOT be expected to be feature-complete.
93+
In some cases, the experiment MAY be discarded and removed entirely.
94+
Long-term dependencies SHOULD NOT be taken against experimental sections.
95+
8896
### Feature freeze
8997

9098
In addition to the statuses above, documents may be marked as `Feature-freeze`.

specification/versioning.md

+8-17
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,18 @@
33
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
44

55
All GDI repositories MUST be versioned according to [Semantic Versioning
6-
2.0](https://semver.org/spec/v2.0.0.html). GDI repositories are versioned
7-
separately from OpenTelemetry repositories as Splunk-specific breaking changes
8-
MAY be introduced. GDI repositories MUST indicate what version of OpenTelemetry
6+
2.0](https://semver.org/spec/v2.0.0.html) using the syntax idiomatic to their
7+
language.
8+
9+
GDI repositories are versioned separately from OpenTelemetry repositories as
10+
Splunk-specific breaking changes MAY be introduced.
11+
GDI repositories MUST indicate what version of OpenTelemetry
912
repositories they are based on through release notes and SHOULD indicate through
1013
logging. Additional version number constraints can be found in the sections
1114
below.
1215

1316
## Experimental
1417

15-
Everything in the specification starts as experimental, which covers alpha,
16-
beta, and release candidate versions. Version numbers for releases MUST be less
17-
than `1.0.0` while experimental. The minor version number SHOULD be increased
18-
when significant or breaking changes are introduced.
19-
20-
While any section in the specification is experimental, breaking changes and
21-
performance issues MAY occur. Sections SHOULD NOT be expected to be
22-
feature-complete. In some cases, the experiment MAY be discarded and removed
23-
entirely. Long-term dependencies SHOULD NOT be taken against experimental
24-
sections.
25-
2618
GDI repositories MAY consist of one or more components. GDI repositories MUST be
2719
designed in a manner that allows experimental components to be created without
2820
breaking the stability guarantees of existing components. GDI repositories MUST NOT
@@ -41,9 +33,8 @@ configuration variable to enable, and MUST clearly be marked as experimental.
4133

4234
## Stable
4335

44-
The initial stable release version number for GDI repositories MUST be `1.0.0` and
45-
follow Semantic Versioning 2.0 for all subsequent releases. Once an
46-
experimental component has gone through rigorous beta testing, it MAY
36+
The initial stable release version number for GDI repositories MUST be `1.0.0`.
37+
Once an experimental component has gone through rigorous beta testing, it MAY
4738
transition to stable. Long-term dependencies MAY now be taken against this
4839
component. When a new stable component is introduced to a GDI repository with an
4940
existing stable release, the `MINOR` version number MUST be incremented and the

0 commit comments

Comments
 (0)