standard-changelog
v6.0.0
Published
Generate a changelog from git metadata with Angular commit convention.
Downloads
47,268
Readme
Standard CHANGELOG
An opinionated approach to CHANGELOG generation using angular commit conventions.
Quick Start
$ npm install -g standard-changelog
$ cd my-project
$ standard-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".
your first release:
If you're using this tool for the first time and want to generate new content in CHANGELOG.md, you can run:
$ standard-changelog --first-release
advanced topics:
All available command line parameters can be listed using CLI : standard-changelog --help
.
Programmatic Usage
$ npm install --save standard-changelog
import standardChangelog from 'standard-changelog';
standardChangelog()
.pipe(process.stdout); // or any writable stream
CLI
$ npm install -g standard-changelog
$ standard-changelog --help
API
See the conventional-changelog docs with the angular preset.
License
MIT