Verify a changelog has correct entries
npm install changelog-verifyEnsure that your CHANGELOG.md contains a list of changes.
Goes great withversion-changelog.
Add this to your package.json:
``json`
{
"scripts": {
"version": "version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"
}
}
Now whenever you execute npm version
(or ),CHANGELOG.md
your will be given the correct version info,
checked for validity
(did you forget to add changelog notes?)
then added to the release commit.
`
Verify a changelog has correct entries
Usage
$ changelog-verify
Options
--unreleased Verify that the unreleased section has been modified.
(default: false)
`
The --unreleased flag is great for confirming PRs contain a CHANGELOG note.
Given the following ./CHANGELOG.md
`markdownChangelog
- Reticulated the splines
`
Executing the verficiation script
`bash`
changelog-verify ./CHANGELOG.md
Will return success (0).
See the tests for more usage examples.
This tool assumes a particular format for your changelog,
keeping in style with http://keepachangelog.com:
`markdown`[Unreleased]
[
Where
which isn't a heading.