nock changelog

Hello, thank you for awesome tool.

https://github.com/nock/nock/blob/master/CHANGELOG.md

Nock’s changelog can be found directly in the GitHub release notes.

Problem

Decided to bump node and deps in legacy app, and npm outdated suggests me bumping nock from 9.6.1 to 12.0.3. As I have to read changelog first to easily avoid breaking changes, I googled nock changelog and got the link above. I went to ‘releases’ page, but it is full of beta versions and very unproductive to read. First thing I see now is huge “breaking change” note, but it is in beta, and sometimes beta code does not get into production, and anyway it is still beta, while I use production versions, so I spend time to analyze this row.

Proposed solution

Production-ready releases should have separate changelog file/whatever which is easily readable on single page. Meaning important things are pointed out.

I.e. examples of readable meaningful changelog: https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md https://github.com/sinonjs/sinon/blob/master/docs/changelog.md Example of non-meaningful but still readble (single page) changelog: https://github.com/eslint/eslint/blob/master/CHANGELOG.md

Sadly github releases page doesn’t work this way :\

[github-actions[bot]]

🎉 This issue has been resolved in version 13.0.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[gr2m]

I like committing upgrade guides to the source code, too. It would allow people to contribute to it using pull requests. We could add short “breaking changes” summeries in the release notes, then link to the guides for more information, to avoid too much duplication