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

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.

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

Standard CHANGELOG

Quick Start

Programmatic Usage

CLI

API

Related

License

Current Tags

51 Versions