conventional-changelog
v6.0.0
Published
Generate a changelog from git metadata.
Downloads
5,970,553
Readme
Generate a changelog from git metadata
Usage
You most likely only need to use this module if you're building a library that provides an abstraction on top of conventional commits, See Getting started if you're an end-user.
$ npm install --save conventional-changelog
import conventionalChangelog from 'conventional-changelog';
conventionalChangelog({
preset: 'angular'
})
.pipe(process.stdout); // or any writable stream
Or if you want to use your own custom preset:
import conventionalChangelog from 'conventional-changelog';
import config from '@org/conventional-changelog-custom-preset';
conventionalChangelog({config})
.pipe(process.stdout); // or any writable stream
API
conventionalChangelog([options, [context, [gitRawCommitsOpts, [parserOpts, [writerOpts]]]]])
Returns a readable stream.
options
See the conventional-changelog-core docs. The API is the same with the following changes or additions:
preset
Type: string
Possible values: 'angular', 'atom', 'codemirror', 'conventionalcommits', 'ember', 'eslint', 'express', 'jquery', 'jshint'
It's recommended to use a preset so you don't have to define everything yourself. Presets are names of built-in config
.
A scoped preset package such as @scope/conventional-changelog-custom-preset
can be used by passing @scope/custom-preset
to this option.
NOTE: options.config
will be overwritten by the values of preset. You should use either preset
or config
, but not both.
Notes for parent modules
License
MIT