Changelog Notes.md

Changelog or Release Notes

The CAFapi project uses a release-notes-x.y.z.md convention. Whereas two high profile projects on GitHub use a "changelog" convention.

https://github.com/conventional-changelog/standard-version
https://github.com/olivierlacan/keep-a-changelog

Changelog Client

The conventional-changelog team also has a client: conventional-changelog-cli.

Usage

package.json

{
	"name": "changelog-sample",
	"keywords": [
		"changelog"
	],
	"scripts": {
		"version": "conventional-changelog -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md",
		"lint": "ng lint"
	}
}

Then, invoke

npm run version

References

Keep a Changelog