search

open-telemetry / opentelemetry-js-contrib

OpenTelemetry instrumentation for JavaScript modules
https://opentelemetry.io
Apache License 2.0
638 stars 475 forks source link

thoughts on publishing CHANGELOG.md files in npm published packages? #2277

Open trentm opened 3 weeks ago

trentm commented 3 weeks ago

I was poking around in a repo of mine that uses various @opentelemetry/* deps. I wanted to see if I had a version of @opentelemetry/instrumentation-tedious that supported tedious@17. However the node_modules/@opentelemetry/instrumentation-tedious install does not include the "CHANGELOG.md" file:

% ls node_modules/@opentelemetry/instrumentation-tedious
LICENSE      README.md    build        package.json

What would others thing about adding these? It would require adding "CHANGELOG.md" to the "files" entry in package.json for each published package.

AbhiPrasad commented 2 weeks ago

Could we link to the CHANGELOG in the package README? Users would have to navigate to GitHub, but this might be a better flow to encourage because they can also easily see new versions that have come out since then.

Another direction we can take this is that we can publish the individual changelogs to a separate site and link to that so that they are more easily accessible.

pichlermarc commented 2 weeks ago

@blumamir I think there's might be some overlap with https://github.com/open-telemetry/opentelemetry-js/issues/4725 on trying to figure out which versions are supported.

@AbhiPrasad I think having the link there could be very helpful (and also not increase the size of the tarball too much)