AlbertoFdzM / changelog-verify

Verify a changelog has correct entries

Changelog Verify

Ensure that your CHANGELOG.md contains a list of changes.

Goes great with version-changelog. Add this to your package.json:

{
  "scripts": {
    "version": "version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"
  }
}

Now whenever you execute npm version (or np), your CHANGELOG.md will be given the correct version info, checked for validity (did you forget to add changelog notes?) then added to the release commit.

Usage

Given the following ./CHANGELOG.md

# Changelog

## [2.0.0] - 2016-10-11

- Reticulated the splines

Executing the verficiation script

changelog-verify ./CHANGELOG.md

Will return success (0).

See the tests for more usage examples.

Changelog format

This tool assumes a particular format for your changelog, keeping in style with http://keepachangelog.com:

<some intro text>
## [Unreleased]
<optional unreleased notes>
## [<version number>]
<required release notes>

Where <required release notes> must contain at least one non-empty string which isn't a heading.

Options

The cli takes a single optional parameter: the changelog filename:

changelog-verify [filename]

filename can be a path relative to the current working directory, or an absolute path.