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 a PR check to enforce Schema file presence/content if a semantic convention is changed #31

Open
tigrannajaryan opened this issue Sep 21, 2021 · 4 comments
Assignees
Labels
help wanted Extra attention is needed tooling Regarding build, workflows, build-tools, ...

Comments

@tigrannajaryan
Copy link
Member

To ensure the Schema files correctly capture changes we make to semantic conventions I suggest that we add an automatic check that verifies that any PR that changes a semantic convention in a way that matters from Schema file perspective enforces that the Schema file change is also present (and ideally verifies that the changes match).

The only supported Schema file change is currently the renaming of attributes so the check needs to see any of attribute name is changed semantic convention yaml file and see if there is a corresponding change recorded in the Schema file.

@tigrannajaryan tigrannajaryan added the help wanted Extra attention is needed label Sep 21, 2021
@tigrannajaryan
Copy link
Member Author

Help is needed on this one, especially if you are familiar with build-tools that generate the semantic conventions currently.

@tigrannajaryan tigrannajaryan changed the title Add a PR check to enforce Schema file presence if a semantic convention is changed Add a PR check to enforce Schema file presence/content if a semantic convention is changed Sep 21, 2021
@yurishkuro
Copy link
Member

+1. I thought we already had that, since it was called out in the original schemas OTEP.

@tigrannajaryan
Copy link
Member Author

+1. I thought we already had that, since it was called out in the original schemas OTEP.

No yet. We have a check that verifies that every release has a corresponding Schema file. But we don't yet check individual PRs that modify semantic conventions.

@tigrannajaryan
Copy link
Member Author

We need this and need help to implement it.

@tigrannajaryan tigrannajaryan transferred this issue from open-telemetry/opentelemetry-specification May 16, 2023
@tigrannajaryan tigrannajaryan removed their assignment May 16, 2023
@arminru arminru added the tooling Regarding build, workflows, build-tools, ... label May 17, 2023
@github-actions github-actions bot added the Stale label Feb 20, 2024
@joaopgrassi joaopgrassi removed the Stale label Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed tooling Regarding build, workflows, build-tools, ...
Projects
Development

No branches or pull requests

6 participants