standard-changelog

An opinionated approach to CHANGELOG generation using angular commit conventions.

<hr /> <a href="#install">Install</a> <span>  •  </span> <a href="#usage">Usage</a> <span>  •  </span> <a href="#js-api">JS API</a> <hr />

Install

bash

# pnpm
pnpm add standard-changelog
# yarn
yarn add standard-changelog
# npm
npm i standard-changelog

Usage

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.

JS API

import { StandardChangelog } from 'standard-changelog'

const generator = new StandardChangelog()
  .readPackage()

generator
  .writeStream()
  .pipe(process.stdout)

// or

for await (const chunk of generator.write()) {
  console.log(chunk)
}

StandardChangelog is a class based on ConventionalChangelog and with preloaded angular preset.

See the conventional-changelog JS API docs.

License

MIT