Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioning and stability: Require SemVer #4039

Merged
merged 7 commits into from
May 21, 2024
Merged

Versioning and stability: Require SemVer #4039

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
210ea33
Versioning and stability: Remove confusion around backwards compatiblity
pellared May 8, 2024
da65308
Merge branch 'main' into fix-semver
pellared May 10, 2024
6cafb10
Update CHANGELOG.md
pellared May 10, 2024
e5c6dfc
Update versioning-and-stability.md
pellared May 17, 2024
dd3d11f
Update CHANGELOG.md
pellared May 17, 2024
511af75
Merge branch 'main' into fix-semver
pellared May 17, 2024
341782c
Update versioning-and-stability.md
pellared May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ release.

### Common

- Versioning and stability: Clarify backwards compatibility and SemVer.
([#4039](https://github.com/open-telemetry/opentelemetry-specification/pull/4039))

### Supplementary Guidelines

## v1.33.0 (2024-05-09)
Expand Down
5 changes: 1 addition & 4 deletions specification/versioning-and-stability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ maintainers SHOULD choose the idiomatic way for their language.

#### SDK Stability

Public portions of SDK packages MUST remain backwards compatible.
There are two categories of public features: **plugin interfaces** and **constructors**.
Examples of plugins include the SpanProcessor, Exporter, and Sampler interfaces.
Examples of constructors include configuration objects, environment variables, and SDK builders.
Expand All @@ -144,8 +143,6 @@ in [Telemetry Stability](telemetry-stability.md).) The goal is to ensure users c
update to the latest version of OpenTelemetry, and not be held back by the
plugins that they depend on.

Public portions of contrib packages (constructors, configuration, interfaces) SHOULD remain backwards compatible.
pellared marked this conversation as resolved.
Show resolved Hide resolved

pellared marked this conversation as resolved.
Show resolved Hide resolved
Languages which ship binary artifacts SHOULD offer [ABI compatibility](glossary.md#abi-compatibility) for contrib packages.

**Exception:** Contrib packages MAY break stability when a required downstream dependency breaks stability.
Expand Down Expand Up @@ -310,7 +307,7 @@ We invented a new tracing API, but continue to support the old one.

## Version numbers

OpenTelemetry clients follow [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html), with the following clarifications.
OpenTelemetry clients MUST follow [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html), with the following clarifications.
cijothomas marked this conversation as resolved.
Show resolved Hide resolved
reyang marked this conversation as resolved.
Show resolved Hide resolved

OpenTelemetry clients have four components: API, SDK, Semantic Conventions, and Contrib.

Expand Down
Loading