conventional-changelog
Generate a changelog from git metadata
Last updated 5 days ago by tommywo .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install conventional-changelog 
SYNC missed versions from official npm registry.

NPM version Build Status Dependency Status Coverage Status

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
var conventionalChangelog = require('conventional-changelog');

conventionalChangelog({
  preset: 'angular'
})
  .pipe(process.stdout); // or any writable stream

Or if you want to use your own custom preset:

var conventionalChangelog = require('conventional-changelog');

var config = require('@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', '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.

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

Current Tags

  • 3.1.14                                ...           latest (5 days ago)

86 Versions

  • 3.1.14                                ...           5 days ago
  • 3.1.13                                ...           19 days ago
  • 3.1.12                                ...           a month ago
  • 3.1.10                                ...           3 months ago
  • 3.1.9                                ...           6 months ago
  • 3.1.8                                ...           6 months ago
  • 3.1.7                                ...           6 months ago
  • 3.1.6                                ...           6 months ago
  • 3.1.5                                ...           7 months ago
  • 3.1.4                                ...           7 months ago
  • 3.1.3                                ...           7 months ago
  • 3.1.2                                ...           7 months ago
  • 3.1.1                                ...           7 months ago
  • 3.0.6                                ...           9 months ago
  • 3.0.5                                ...           a year ago
  • 3.0.4                                ...           a year ago
  • 3.0.3                                ...           a year ago
  • 3.0.2                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 2.0.3                                ...           a year ago
  • 2.0.2                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 1.1.24                                ...           2 years ago
  • 1.1.23                                ...           2 years ago
  • 1.1.22                                ...           2 years ago
  • 1.1.21                                ...           2 years ago
  • 1.1.20                                ...           2 years ago
  • 1.1.19                                ...           2 years ago
  • 1.1.18                                ...           2 years ago
  • 1.1.17                                ...           2 years ago
  • 1.1.16                                ...           2 years ago
  • 1.1.15                                ...           2 years ago
  • 1.1.14                                ...           2 years ago
  • 1.1.12                                ...           2 years ago
  • 1.1.11                                ...           2 years ago
  • 1.1.10                                ...           2 years ago
  • 1.1.7                                ...           2 years ago
  • 1.1.6                                ...           2 years ago
  • 1.1.5                                ...           2 years ago
  • 1.1.4                                ...           3 years ago
  • 1.1.3                                ...           3 years ago
  • 1.1.2                                ...           3 years ago
  • 1.1.1                                ...           3 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
  • 0.5.3 [deprecated]           ...           4 years ago
  • 0.5.2 [deprecated]           ...           4 years ago
  • 0.5.1 [deprecated]           ...           4 years ago
  • 0.5.0 [deprecated]           ...           4 years ago
  • 0.4.3 [deprecated]           ...           4 years ago
  • 0.4.2 [deprecated]           ...           4 years ago
  • 0.4.1 [deprecated]           ...           4 years ago
  • 0.4.0 [deprecated]           ...           4 years ago
  • 0.3.2 [deprecated]           ...           4 years ago
  • 0.3.0 [deprecated]           ...           4 years ago
  • 0.2.1 [deprecated]           ...           4 years ago
  • 0.2.0 [deprecated]           ...           4 years ago
  • 0.1.3 [deprecated]           ...           4 years ago
  • 0.1.2 [deprecated]           ...           4 years ago
  • 0.1.1 [deprecated]           ...           4 years ago
  • 0.1.0 [deprecated]           ...           4 years ago
  • 0.1.0-beta.3                                ...           4 years ago
  • 0.1.0-beta.2                                ...           4 years ago
  • 0.1.0-beta.1                                ...           4 years ago
  • 0.1.0-alpha.3                                ...           4 years ago
  • 0.1.0-alpha.2                                ...           4 years ago
  • 0.1.0-alpha.1                                ...           4 years ago
  • 0.0.17 [deprecated]           ...           5 years ago
  • 0.0.16 [deprecated]           ...           5 years ago
  • 0.0.15 [deprecated]           ...           5 years ago
  • 0.0.14 [deprecated]           ...           5 years ago
  • 0.0.13 [deprecated]           ...           5 years ago
  • 0.0.12 [deprecated]           ...           5 years ago
  • 0.0.11 [deprecated]           ...           5 years ago
  • 0.0.10 [deprecated]           ...           5 years ago
  • 0.0.9 [deprecated]           ...           6 years ago
  • 0.0.8 [deprecated]           ...           6 years ago
  • 0.0.7 [deprecated]           ...           6 years ago
  • 0.0.6 [deprecated]           ...           6 years ago
  • 0.0.5 [deprecated]           ...           6 years ago
  • 0.0.4 [deprecated]           ...           6 years ago
  • 0.0.3 [deprecated]           ...           6 years ago
  • 0.0.2 [deprecated]           ...           6 years ago
  • 0.0.1 [deprecated]           ...           6 years ago
Downloads
Today 894
This Week 2,189
This Month 10,881
Last Day 1,295
Last Week 7,237
Last Month 30,269
Dev Dependencies (0)
None
Dependents (190)

Copyright 2014 - 2017 © taobao.org |