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

feat(semantic-conventions): update semantic conventions to v1.29.0 #5356

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

trentm
Copy link
Contributor

@trentm trentm commented Jan 21, 2025

This also adds a changelog-gen.js script to help generate meaningful summary of changes in the semconv JS package.

Note: This change excludes the new 'network.interface.name' attribute because of open-telemetry/semantic-conventions#1777


Note: I did not update the weaver version to the latest. Doing so includes some whitespace fixes in the generated output that I wanted to do in a separate PR after this one.

This also adds a changelog-gen.js script to help generate meaningful
summary of changes in the semconv JS package.

Note: This change *excludes* the new 'network.interface.name' attribute
because of open-telemetry/semantic-conventions#1777
@trentm trentm self-assigned this Jan 21, 2025
@trentm trentm requested a review from a team as a code owner January 21, 2025 20:32
@trentm
Copy link
Contributor Author

trentm commented Jan 21, 2025

In the last semconv update PR we discussed some generation of better changelogs for semconv updates. This PR adds a script to help with that. The result is in the diff of semantic-conventions/CHANGELOG.md
Here is a link to the rendered version of that:

https://github.com/trentm/opentelemetry-js/blob/tm-semconv-1.29.0/semantic-conventions/CHANGELOG.md#rocket-enhancement

  • Be sure to open the "Full unstable changes" disclosure to see the detailed summary.
  • Currently I setup the generated changelog to put unstable changes behind the disclosure, but stable changes, if any, would not be hidden behind a disclosure. It just so happens that v1.29.0 didn't include any stable changes.

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (c00f36e) to head (f438ae3).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5356   +/-   ##
=======================================
  Coverage   94.54%   94.54%           
=======================================
  Files         318      318           
  Lines        8051     8052    +1     
  Branches     1694     1694           
=======================================
+ Hits         7612     7613    +1     
  Misses        439      439           

see 3 files with indirect coverage changes

@trentm
Copy link
Contributor Author

trentm commented Jan 22, 2025

A comment/suggestion on the changelog entry formatting from an OTel JS maintainers call earlier today: Separate disclosures for each change type. "Added" change type at the bottom.

…have an explicit stability; this is a more general fix to skip the current case (network.interface.name), per suggestion from Liudmila
@trentm
Copy link
Contributor Author

trentm commented Jan 22, 2025

Comment on changelog: separate disclosures for each category. "Added" at the bottom.

Here is a gist showing an example rendering. Note that I've manually faked some of the unstable changes as "stable" changes, so we can see some data in that section. (The actual 1.29.0 change did not include any changes to stable exports.)

https://gist.github.com/trentm/0decada22acd953813efb698a1985f29

In this rendering, both the stable and unstable sections are using the same <details> ... markup -- but the stable section defaults those disclosures being open (<details open> ...).

… to help with grepping); update the changelog-gen script to support comparing older versions (e.g. changelog-gen.js 1.27.0 1.28.0)
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.

2 participants