Skip to content

Yamlify the spec compliance matrix#4631

Merged
carlosalberto merged 10 commits intoopen-telemetry:mainfrom
trask:matrix2
Aug 29, 2025
Merged

Yamlify the spec compliance matrix#4631
carlosalberto merged 10 commits intoopen-telemetry:mainfrom
trask:matrix2

Conversation

@trask
Copy link
Member

@trask trask commented Aug 18, 2025

Part of #3976 (comment)

The goal of this PR is to yamlify the spec compliance matrix without affecting the resulting markdown file (other than whitespace differences), so that folks can be sure the yaml files are correct extraction of the current state of the markdown file.

@trask trask marked this pull request as ready for review August 18, 2025 16:50
@trask trask requested review from a team August 18, 2025 16:50
@marcalff
Copy link
Member

Added benefits:

  • git blame will point to the PR changing the cell in yaml, not to the PR changing last the full row in the existing md file
  • no more merge collisions when changing cell contents only.

@reyang
Copy link
Member

reyang commented Aug 18, 2025

Is it an eventual goal to move the language implementation specific yaml file to the implementation repo?

@trask
Copy link
Member Author

trask commented Aug 18, 2025

Is it an eventual goal to move the language implementation specific yaml file to the implementation repo?

yes, I like that idea, this is just a step in the direction

Copy link
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

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

💯

trask added a commit to trask/opentelemetry-specification that referenced this pull request Aug 19, 2025
- Update pull request template to point to spec-compliance-matrix directory
- Add contributing guide section explaining how to update compliance matrix
- Document that YAML files are now the source of truth

Addresses review comment in open-telemetry#4631
Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

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

Is it worth adding instructions to CONTRIBUTING.md about how to update the matrix?

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

This is great, is there a follow up to add a CI check for this?

@trask
Copy link
Member Author

trask commented Aug 19, 2025

This is great, is there a follow up to add a CI check for this?

oops! I had meant to add that, will do that today

@carlosalberto
Copy link
Contributor

Out of curiosity: if thee template gets a new section and the implementation portions (C++, Java, etc) don't have such section yet, does this keep on working?

@trask
Copy link
Member Author

trask commented Aug 20, 2025

Out of curiosity: if thee template gets a new section and the implementation portions (C++, Java, etc) don't have such section yet, does this keep on working?

yes

@carlosalberto
Copy link
Contributor

@trask We are ready to merge. I don't think we should hold this PR anymore but we should remind maintainers at tomorrow's call about this change, etc.

@trask trask requested review from a team as code owners August 25, 2025 16:21
@marcalff
Copy link
Member

Please make sure there are no conflicts with pending PR that also change the spec compliance matrix, such as #4628

Git will not report a merge conflict, but make sure changes are not lost when translated to the new yaml file.

@carlosalberto
Copy link
Contributor

Thanks for the feedback/review @kaylareopelle !

@carlosalberto carlosalberto added this pull request to the merge queue Aug 29, 2025
Merged via the queue into open-telemetry:main with commit 6e57784 Aug 29, 2025
17 of 19 checks passed
github-merge-queue bot pushed a commit that referenced this pull request Sep 8, 2025
## Changes

This PR is a redo of #4628 to account for the changes made in #4631. 

To quote the description of #4628: 
> The Ruby Metrics and Logs implementations added a lot of features
since this matrix was last updated. However, we're still in
"Development" status, so I'm not sure if this is the appropriate time to
update the matrix. Please let me know if we should wait.

This also includes some changes to the traces and environment variables
sections. There are a few small differences between the boxes checked in
#4628 to reflect recent changes.

cc @open-telemetry/ruby-maintainers

---------

Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.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.

10 participants