Skip to content
This repository has been archived by the owner on Feb 5, 2018. It is now read-only.

conventional-changelog-archived-repos/standard-changelog

Repository files navigation

Standard CHANGELOG

NPM version Build Status Dependency Status Coverage Status

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
var standardChangelog = require('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.

Related

License

MIT