Undocumented Breaking Change in Experimental v0.54.0

[MustafaHaddara]

PR #4971 rewrites exporter config logic and included this change, which changed the type of the headers config:

- headers?: Partial<Record<string, unknown>>;
+ headers?: Record<string, string>;

As a result, header values are now restricted to being string instead of previously being wide open and allowing any type.

What's the appropriate fix here? Just update the 0.54.0 section of the changelog? Ship a new version with no new code change but a new changelog entry?

---

• This only affects the JavaScript OpenTelemetry library
• This may affect other libraries, but I would like to get opinions here first

[pichlermarc]

Hi - thanks for reporting this. 🙂

What's the appropriate fix here? Just update the 0.54.0 section of the changelog? Ship a new version with no new code change but a new changelog entry?

Yep, we'd update the changelog entry for 0.54.0. When we merge the PR a maintainer needs to edit the GitHub release retroactively that it shows up there. We would not release a new version since the changelog is not included in the NPM package we released.