1 | # chg [![Build Status](https://secure.travis-ci.org/heff/chg.png?branch=master)](http://travis-ci.org/heff/chg)
|
2 |
|
3 | unfancy release history tracking
|
4 |
|
5 | functions:
|
6 |
|
7 | - `init` - create a CHANGELOG.md file
|
8 | - `add` - add new changes to the changelog under a 'HEAD (Unreleased)' heading
|
9 | - `release` - move all unreleased changes under a new release version
|
10 |
|
11 | `chg` can be useful when built into a release/deploy script or paired with a pull request merging script like [pulley](https://github.com/jeresig/pulley).
|
12 |
|
13 | It **does not** try to automatically generate changes from git commits or github pull requests, though you could build that on top of the `chg` functions.
|
14 |
|
15 | ### Example
|
16 |
|
17 | ```markdown
|
18 | CHANGELOG
|
19 | =========
|
20 |
|
21 | ## HEAD (Unreleased)
|
22 | * Removed crusty semantic html, javascript app ftw
|
23 |
|
24 | --------------------
|
25 |
|
26 | ## 2.0.0 (2007-3-13)
|
27 | * Removed horrible tables, semantic html ftw
|
28 | * Switched background to vertical gradient
|
29 | * Added dropshadows to EVERYTHING
|
30 |
|
31 | ## 1.1.1 (2002-08-16)
|
32 | * Added "dot.gifs" to ~300 table cells to fix layout issues
|
33 |
|
34 | ## 1.1.0 (2002-05-17)
|
35 | * Removed horrible Flash, table layout ftw
|
36 | * Switched background to horizontal gray lines
|
37 |
|
38 | ## 1.0.1 (2000-07-01)
|
39 | * Duplicated all Flash content in HTML so Yahoo can see it
|
40 |
|
41 | ## 1.0.0 (2000-04-14)
|
42 | * Removed horrible frames, Flash ftw
|
43 | * Switched background to fast moving clouds like 2advanced V3
|
44 |
|
45 | ## 0.1.0 (1997-01-26)
|
46 | * Added a "GIF" of a construction worker. ha ha ha
|
47 | * Navigation frame ftw
|
48 | * Added repeating tanbark background to look more professional
|
49 |
|
50 | ```
|
51 |
|
52 | ## Using globally
|
53 |
|
54 | ```bash
|
55 | # install
|
56 | [sudo] npm install -g chg
|
57 |
|
58 | # create CHANGELOG.md
|
59 | chg init
|
60 |
|
61 | # add a change
|
62 | chg add 'My first change'
|
63 |
|
64 | # create a release
|
65 | chg release '0.0.1'
|
66 | ```
|
67 |
|
68 | ## Using as a node module
|
69 |
|
70 | shell
|
71 | ```shell
|
72 | # install
|
73 | npm install chg --save
|
74 | ```
|
75 |
|
76 | javascript
|
77 | ```js
|
78 | var chg = require('chg');
|
79 |
|
80 | // create CHANGELOG.md
|
81 | chg.init({}, callback);
|
82 |
|
83 | // add a change
|
84 | chg.add('My first change', {}, callback);
|
85 |
|
86 | // create a release
|
87 | chg.release('0.0.1', {}, callback);
|
88 | ```
|
89 |
|
90 | ## Using as a grunt plugin
|
91 |
|
92 | shell
|
93 | ```shell
|
94 | # install
|
95 | npm install chg --save-dev
|
96 | ```
|
97 |
|
98 | Gruntfile.js
|
99 | ```js
|
100 | grunt.loadNpmTasks('chg');
|
101 | ```
|
102 |
|
103 | shell
|
104 | ```shell
|
105 | # create CHANGELOG.md
|
106 | grunt chg-init
|
107 |
|
108 | # add a change
|
109 | grunt chg-add
|
110 |
|
111 | # create a release
|
112 | grunt chg-release
|
113 | ```
|
114 |
|
115 | ## Release History
|
116 | See [CHANGELOG.md](CHANGELOG.md) :scream-cat:
|
117 |
|
118 | ## License
|
119 | Copyright (c) 2014 heff. Licensed under the Apache license.
|