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.

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

Clarify enum attribute value stability guarantees #3879

Merged
merged 9 commits into from
Feb 27, 2024

Conversation

pyohannes
Copy link
Contributor

@pyohannes pyohannes commented Feb 15, 2024

Fixes #3847

Changes

As discussed in the semantic conventions SIG, this PR aims to clarify stability guarantees provided around well[-known attribute values (aka enums) defined by semantic conventions:

  • Changing an existing enum value is a breaking change.
  • Adding a new value to an enum is not a breaking change.

@pyohannes pyohannes requested review from a team February 15, 2024 10:42
@pyohannes
Copy link
Contributor Author

cc @open-telemetry/specs-semconv-approvers

@arminru arminru requested a review from a team February 15, 2024 18:26
specification/versioning-and-stability.md Outdated Show resolved Hide resolved
specification/versioning-and-stability.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@arminru arminru requested review from a team February 15, 2024 18:33
pyohannes and others added 3 commits February 16, 2024 09:18
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
@lmolkova
Copy link
Contributor

lmolkova commented Feb 21, 2024

FYI: I have PR to the build-tools to add per-member stability property
open-telemetry/build-tools#267

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Robert Pająk <pellared@hotmail.com>
@jsuereth jsuereth merged commit ff66b24 into open-telemetry:main Feb 27, 2024
7 checks passed
jaydeluca pushed a commit to jaydeluca/opentelemetry-specification that referenced this pull request Feb 29, 2024
Fixes open-telemetry#3847 

## Changes

As discussed in the semantic conventions SIG, this PR aims to clarify
stability guarantees provided around well[-known attribute values (aka
`enums`) defined by semantic conventions:

* Changing an existing `enum` value is a breaking change.
* Adding a new value to an `enum` is not a breaking change.


##
* [x] Related issues open-telemetry#3847
* [ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) 
* [ ] Links to the prototypes (when adding or changing features)
* [x]
[`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md)
file updated for non-trivial changes
* [ ]
[`spec-compliance-matrix.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md)
updated if necessary

---------

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Robert Pająk <pellared@hotmail.com>
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Fixes open-telemetry#3847 

## Changes

As discussed in the semantic conventions SIG, this PR aims to clarify
stability guarantees provided around well[-known attribute values (aka
`enums`) defined by semantic conventions:

* Changing an existing `enum` value is a breaking change.
* Adding a new value to an `enum` is not a breaking change.


##
* [x] Related issues open-telemetry#3847
* [ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) 
* [ ] Links to the prototypes (when adding or changing features)
* [x]
[`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md)
file updated for non-trivial changes
* [ ]
[`spec-compliance-matrix.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md)
updated if necessary

---------

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Robert Pająk <pellared@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revisit enum attribute value stability
9 participants