bumped-changelog

Auto generate a changelog file in each bump.


Keywords
bumped, changelog, conventional, generate, plugin
License
MIT
Install
npm install bumped-changelog@0.3.1

Documentation

bumped-changelog


bumped

Last version Build Status Dependency status Dev Dependencies Status NPM Status Donate

Auto generates a changelog file in each bump.

Install

You don't need to install it! Bumped automatically resolve the plugins dependencies. However if you still want to do so must be globally accessible:

npm install bumped-changelog -g

Usage

The plugin is based in the conventional-changelog library.

At the first time, if changelog file is not detected, then we create a changelog file with all the tag detected.

Under incremental tags, we append the last tag into the file.

Notes that at this points changelog looks like an auto generate commit historial: Write a good changelog consist in put human effor in describe what happens in each release!

Configuration

Declare a plugin step in your .bumpedrc like:

plugins:
  postrelease:
    'Generating CHANGELOG file':
      plugin: 'bumped-changelog'
      options:
        preset: 'angular'
        filename: 'CHANGELOG.md'

Options

filename

Type: String Default: CHANGELOG.md

License

MIT © Bumped