conventional-changelog
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

conventional-changelog

Generate a changelog from git metadata

3.1.10  •  Updated 8 months ago  •  by conventional-changelog  •  MIT License

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

Popularity

Weekly Downloads
239.6K
Stars
3.9K

Maintenance

Development

Last ver 8 months ago
Created 6 years ago
Last commit 3 months ago
3 days between commits

Technology

Node version: 12.4.0
36.1K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

77 contributors
Steve Mao
Maintainer, 656 commits, 34 merges, 9 PRs
Works at Cthroo & fp-works
Hutson Betts
Maintainer, 77 commits, 28 merges, 10 PRs
Works at FactSet Research Systems
Benjamin E. Coe
Maintainer, 51 commits, 51 merges, 27 PRs
Works at Google
tommywo
Maintainer, 40 commits, 32 merges, 21 PRs
Works at StepStone
Raido Kuli
49 commits
Renovate Bot
34 commits
Works at renovatebot

Tags

conventional-changelog
conventional
changelog
log
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.