🌜
🌞
conventional-changelog

conventional-changelog

v3.1.25

Generate a changelog from git metadata

npm install conventional-changelog

README

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', '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

General

License
MIT
Typescript Types
Tree-shakeable
No

Popularity

GitHub Stargazers
6,597
Community Interest
6,315
Number of Forks
663

Maintenance

Commits
10/219/22025
Last Commit
Open Issues
185
Closed Issues
234
Open Pull Requests
57
Closed Pull Requests
214

Versions

Versions Released
10/219/2201
Latest Version Released
Dec 24, 2021
Current Tags
latest3.1.25
next3.1.24

Contributors

stevemao
stevemao
Commits: 893
bcoe
bcoe
Commits: 80
hutson
hutson
Commits: 72
ajoslin
ajoslin
Commits: 53
tommywo
tommywo
Commits: 42
renovate-bot
renovate-bot
Commits: 34
marionebl
marionebl
Commits: 13
renovate[bot]
renovate[bot]
Commits: 12
Tapppi
Tapppi
Commits: 6
nlunets
nlunets
Commits: 4
TheDancingCode
TheDancingCode
Commits: 4
dlmr
dlmr
Commits: 3
pvdlg
pvdlg
Commits: 3
armano2
armano2
Commits: 3
yoannmoinet
yoannmoinet
Commits: 3