UNPKG

bumped-changelog

Version:

Auto generate a changelog file in each bump.

github.com/Bumped/bumped-changelog

bumped/bumped-changelog

62 lines (41 loc) • 2.01 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# bumped-changelog <h1 align="center"> <br> <img src="http://i.imgur.com/DmMbFwL.png" alt="bumped"> <br> <br> </h1> ![Last version](https://img.shields.io/github/tag/Bumped/bumped-changelog.svg?style=flat-square) [![Build Status](http://img.shields.io/travis/Bumped/bumped-changelog/master.svg?style=flat-square)](https://travis-ci.org/Bumped/bumped-changelog) [![Dependency status](http://img.shields.io/david/Bumped/bumped-changelog.svg?style=flat-square)](https://david-dm.org/Bumped/bumped-changelog) [![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) [![NPM Status](http://img.shields.io/npm/dm/bumped-changelog.svg?style=flat-square)](https://www.npmjs.org/package/bumped-changelog) [![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/kikobeats) > 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: ```bash npm install bumped-changelog -g ``` ## Usage The plugin is based in the [conventional-changelog](https://github.com/ajoslin/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: ```CSON plugins: postrelease: 'Generating CHANGELOG file': plugin: 'bumped-changelog' options: preset: 'angular' filename: 'CHANGELOG.md' ``` ## Options ### filename Type: `String` Default: `CHANGELOG.md` ## License MIT © [Bumped]()