standard-changelog

Generate a changelog from git metadata with Angular commit convention

Quick start

$ npm install -g standard-changelog
$ cd my-project
$ standard-changelog CHANGELOG.md -w

This will not overwrite any previous changelog. The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".

If you first time use this tool and want to generate all previous changelog, you could do

$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0

This will overwrite any previous changelog if exist.

All available command line parameters can be listed using CLI : conventional-changelog --help.

Hint: You can alias your command or add it to your package.json. EG: "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0".

Usage

$ npm install --save standard-changelog

var standardChangelog = require('standard-changelog');

standardChangelog()
  .pipe(process.stdout); // or any writable stream

API

standardChangelog([options, [context, [gitRawCommitsOpts, [parserOpts, [writerOpts]]]]])

Returns a readable stream.

options

See the standard-changelog-core docs with the angular preset.

Notes for parent modules

Related

• conventional-changelog - Generate a changelog from git metadata
• conventional-github-releaser - Make a new GitHub release from git metadata
• conventional-recommended-bump - Get a recommended version bump based on conventional commits
• conventional-commits-detector - Detect what commit message convention your repository is using
• commitizen - Simple commit conventions for internet citizens.
• angular-precommit - Pre commit with angular conventions

License

MIT