npm-check-updates
npm-check-updates copied to clipboard
Please update CHANGELOG or write release notes.
- [x] I have searched for similar issues
- [x] I am using the latest version of
npm-check-updates
- [x] I am using
node >= 14
I am developing a package called npm-update-package that relies heavily on npm-check-updates. It would be helpful if you could describe the changes in each version of the CHANGELOG, including minor updates and patch updates. Alternatively, please write release notes using GitHub's Releases.
Thank you.
Hi, thanks for the suggestion.
I typically write release notes for major and minor updates in GitHub's Releases. For example, I recently describe the new --format group
and --interactive
features in v14.1.0.
For patch releases, to be honest, it is just not worth my time to write release notes. Some patch releases are bug fixes, some are bumping dependency versions, and some are simply refactors that I publish to ensure that any regressions can be identified at a granular level. Most users have no need to know the details of non-breaking patches.
Writing release notes for patches would basically entail copying and pasting commit messages into the CHANGELOG or release notes. If you are monitoring npm-check-updates so closely that you would like to review every patch, I recommend reading the commit messages, which are thoughtfully written.
If you have a specific use case in mind, or would find automated release notes valuable, please let me know. I'm always interested in hearing how developers use ncu programmatically.
Just came across here: I absolutely appreciate changelogs for EVERY version, also patch releases with only fixes. There are several tools that can create change log's automatically by analyzing the commits done (they have to follow semVer of course). Maybe this is an idea? You could also create a github action that creates this changelog and release everyything to npm automatically
Yes, I'd be open to automating patch and minor releases.
I can recommend semantic-release 🤙🏼 Using this myself, easy to setup, easy to modify and works from github actions as well