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

Semantic convention tool should lint the enum values #40

Open
rakyll opened this issue Apr 6, 2021 · 2 comments
Open

Semantic convention tool should lint the enum values #40

rakyll opened this issue Apr 6, 2021 · 2 comments
Labels
semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.

Comments

@rakyll
Copy link

rakyll commented Apr 6, 2021

We would like to enforce formatting for enum values in semantic conventions. (See open-telemetry/opentelemetry-specification#1519 for more details.)

In order to enforce the requirements of only allowing lower case characters and underscores (_), we need linting rules in the markdown generator. The generator should error if there are enum values that doesn't meet this criteria.

@Oberon00 Oberon00 transferred this issue from open-telemetry/opentelemetry-specification Apr 7, 2021
@Oberon00 Oberon00 changed the title Semantic convention markdown table generator should lint the enum values Semantic convention tool should lint the enum values Apr 7, 2021
@Oberon00 Oberon00 added the semconv Related to the semantic convention generator. label Apr 7, 2021
@Oberon00
Copy link
Member

The tool should also lint enum ids (and actually all ids), see #59

@Oberon00 Oberon00 self-assigned this Sep 8, 2021
@Oberon00
Copy link
Member

Oberon00 commented Sep 8, 2021

I'm working on this

Actually I'll only validate IDs for now (i.e. #59). We already have enums that do not conform to the current rule (namely http.flavor=1.0 or 2.0). So we'd need to discuss that first or provide an opt-out for the check.

@Oberon00 Oberon00 removed their assignment Sep 8, 2021
@Oberon00 Oberon00 added the semconv/model Related to the data model or YAML format of the semantic convention generator label Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.
Projects
Development

No branches or pull requests

2 participants