1 | # bumped-changelog
|
2 |
|
3 |
|
4 | ![Last version](https://img.shields.io/github/tag/Bumped/bumped-changelog.svg?style=flat-square)
|
5 | [![Build Status](http://img.shields.io/travis/Bumped/bumped-changelog/master.svg?style=flat-square)](https://travis-ci.org/Bumped/bumped-changelog)
|
6 | [![Dependency status](http://img.shields.io/david/Bumped/bumped-changelog.svg?style=flat-square)](https://david-dm.org/Bumped/bumped-changelog)
|
7 | [![Dev Dependencies Status](http://img.shields.io/david/dev/Bumped/bumped-changelog.svg?style=flat-square)](https://david-dm.org/Bumped/bumped-changelog#info=devDependencies)
|
8 | [![NPM Status](http://img.shields.io/npm/dm/bumped-changelog.svg?style=flat-square)](https://www.npmjs.org/package/bumped-changelog)
|
9 | [![Gratipay](https://img.shields.io/gratipay/Kikobeats.svg?style=flat-square)](https://gratipay.com/~Kikobeats/)
|
10 |
|
11 | > Auto generates a changelog file in each bump.
|
12 |
|
13 | ## Install
|
14 |
|
15 | 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:
|
16 |
|
17 | ```bash
|
18 | npm install bumped-changelog -g
|
19 | ```
|
20 |
|
21 | ## Configuration
|
22 |
|
23 | The plugin is based in the [conventional-changelog](https://github.com/ajoslin/conventional-changelog) library. Basically the plugin expose a interface for setup the library in the `.bumpedrc`:
|
24 |
|
25 | Just define the a minimal scaffold as the next piece of code:
|
26 |
|
27 | ```CSON
|
28 | files: [
|
29 | "package.json"
|
30 | "bower.json"
|
31 | ]
|
32 |
|
33 | plugins:
|
34 | postrelease:
|
35 | 'Generating CHANGELOG file':
|
36 | plugin: 'bumped-changelog'
|
37 | options:
|
38 | filename: 'CHANGELOG.md' # Optionally
|
39 | ```
|
40 |
|
41 | ## License
|
42 |
|
43 | MIT © [Bumped]()
|