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

Add policy to prevent enum member removal #1686

Open
lmolkova opened this issue Dec 15, 2024 · 3 comments
Open

Add policy to prevent enum member removal #1686

lmolkova opened this issue Dec 15, 2024 · 3 comments
Assignees
Labels
bug Something isn't working tooling Regarding build, workflows, build-tools, ...

Comments

@lmolkova
Copy link
Contributor

See

https://github.com/open-telemetry/semantic-conventions/actions/runs/12331081275/job/34417268501?pr=1684

image
@lmolkova lmolkova added the tooling Regarding build, workflows, build-tools, ... label Dec 15, 2024
@lmolkova lmolkova added the bug Something isn't working label Dec 15, 2024
@lmolkova lmolkova moved this to Migrate to weaver in Semantic Conventions Tooling Dec 15, 2024
@jsuereth jsuereth assigned jsuereth and trisch-me and unassigned jsuereth Jan 8, 2025
@jsuereth
Copy link
Contributor

jsuereth commented Jan 8, 2025

The policy exists, but only applies to stable enums:
https://github.com/open-telemetry/semantic-conventions/blob/main/policies/compatibility.rego#L219

Do you want it to apply to unstable enums too?

@lmolkova
Copy link
Contributor Author

lmolkova commented Jan 8, 2025

The practical reason for keeping deprecated experimental attributes is to be able to generate one semconv artifact that can work with N instrumentation libraries potentially following different versions of semconv.

If we drop an attribute and instrumentation gets unexpected version of semconv artifact resolved in runtime there will be a runtime exception.

Enum members would have the same problem, but maybe with a smaller probability.

So I do think we should keep them regardless of stability level.

@jsuereth
Copy link
Contributor

jsuereth commented Jan 8, 2025

Will update with that justification

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working tooling Regarding build, workflows, build-tools, ...
Projects
Status: Migrate to weaver
Development

No branches or pull requests

3 participants