Generate a changelog from git metadata
JavaScript
Latest commit 80f677e Aug 23, 2016 @gitter-badger gitter-badger committed with stevemao docs: add Gitter badge (#154)

README.md

NPM version Build Status Dependency Status Coverage Status

Join the chat at https://gitter.im/conventional-changelog/conventional-changelog

Generate a changelog from git metadata

It's recommended to use high level standard-version. Alternatively, you are probably looking for the cli module. Or use one of the plugins if you are already using the tool: grunt/gulp/atom.

Usage

$ npm install --save conventional-changelog
var conventionalChangelog = require('conventional-changelog');

conventionalChangelog({
  preset: 'angular'
})
  .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', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint'

It's recommended to use a preset so you don't have to define everything yourself. Presets are names of built-in config.

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

Related

License

MIT