Skip to content

Conversation

@krajorama
Copy link
Member

@krajorama krajorama commented May 29, 2025

Action item from OpenMetrics 2.0 WG.

Help from the script:

# This script opens a markdown file containing the OpenMetrics specification,
# extracts the ABNF grammar from it, and checks if the grammar is valid.
# ABNF grammer must be enclosed in
#    ```abnf
#    exposition = metricset HASH SP eof [ LF ]
#    ...
#    ```
# code block, and the top node must be `exposition`.
# It also extracts examples from the OpenMetrics spec file and checks if they
# are valid according to the grammar.
# Exampes must be enclosed in
#    ```openmetrics
#    ... example content ...
#    ```
# code blocks.

@krajorama krajorama force-pushed the krajo/ci-abnf-check branch 7 times, most recently from cffbb47 to 1729266 Compare May 29, 2025 13:05
Action item from OpenMetrics 2.0 WG.

Signed-off-by: György Krajcsovits <[email protected]>
@krajorama krajorama force-pushed the krajo/ci-abnf-check branch 3 times, most recently from fa27cb7 to 3f6b993 Compare May 29, 2025 15:03
Signed-off-by: György Krajcsovits <[email protected]>
@krajorama krajorama force-pushed the krajo/ci-abnf-check branch from 3f6b993 to 2ebe360 Compare May 29, 2025 15:16
Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I'd wait for @juliusv opinion about whether it's ok to have something like this here. He is the person working in this repository the most

@ArthurSens ArthurSens requested a review from juliusv May 29, 2025 15:43
Comment on lines +4 to +6
pull_request:
paths:
- 'docs/specs/om/open_metrics_spec_2_0.md'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably a good idea to add the scripts here, too

@juliusv
Copy link
Member

juliusv commented May 29, 2025

Copying my comment from Slack here: I'm fine with it, I'd just want it to live completely in its own world so I don't have to think about it 😊 So maybe sharing the TypeScript-based scripts directory is not ideal. Would you mind putting the OM/Python-related things either in its own top-level directory or even into the .github directory somewhere if that doesn't cause issues?

Signed-off-by: György Krajcsovits <[email protected]>
@krajorama krajorama merged commit 73e11b8 into main May 30, 2025
6 checks passed
@krajorama krajorama deleted the krajo/ci-abnf-check branch May 30, 2025 05:53
@bwplotka bwplotka moved this to Done in Open Metrics 2.0 Sep 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants