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

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

Open
trentm opened this issue Jun 13, 2024 · 2 comments
Open

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

trentm opened this issue Jun 13, 2024 · 2 comments

Comments

@trentm
Copy link
Contributor

trentm commented Jun 13, 2024

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
Copy link
Member

AbhiPrasad commented Jun 19, 2024

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
Copy link
Member

@blumamir I think there's might be some overlap with open-telemetry/opentelemetry-js#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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants