| 1 | github-changes [](http://badge.fury.io/js/github-changes)
|
| 2 | ==============
|
| 3 |
|
| 4 | Generate a changelog based on merged pull requests or commit messages
|
| 5 |
|
| 6 | [](https://nodei.co/npm/github-changes/)
|
| 7 |
|
| 8 | This is under heavy development. Things may break between releases till I get to 0.1.0.
|
| 9 |
|
| 10 | ### Installation
|
| 11 |
|
| 12 | ```
|
| 13 | npm install -g github-changes
|
| 14 | ```
|
| 15 |
|
| 16 | ```
|
| 17 | Usage: github-changes [options]
|
| 18 |
|
| 19 | Options:
|
| 20 | -o, --owner (required) owner of the Github repository
|
| 21 | -r, --repository (required) name of the Github repository
|
| 22 | -d, --data (DEPRECATED) use pull requests or commits (choices: pulls, commits) [commits]
|
| 23 | -b, --branch name of the default branch [master]
|
| 24 | -n, --tag-name tag name for upcoming release [upcoming]
|
| 25 | -a, --auth prompt to auth with Github - use this for private repos and higher rate limits
|
| 26 | -k, --token need to use this or --auth for private repos and higher rate limits
|
| 27 | -f, --file name of the file to output the changelog to [CHANGELOG.md]
|
| 28 | -v, --verbose output details
|
| 29 | --host alternate host name to use with github enterprise
|
| 30 | --path-prefix path-prefix for use with github enterprise
|
| 31 | --issue-body (DEPRECATED) include the body of the issue (--data MUST equal 'pulls')
|
| 32 | --no-merges do not include merges
|
| 33 | --only-merges only include merges
|
| 34 | --only-pulls only include pull requests
|
| 35 | --use-commit-body use the commit body of a merge instead of the message - "Merge branch..."
|
| 36 | --order-semver use semantic versioning for the ordering instead of the tag date
|
| 37 | ```
|
| 38 |
|
| 39 | ###Example usage
|
| 40 |
|
| 41 | #### Generate changelog via pull requests
|
| 42 | ```bash
|
| 43 | github-changes -o goodybag -r mongo-sql -a --only-pulls --use-commit-body
|
| 44 | ```
|
| 45 |
|
| 46 | #### Output
|
| 47 | ## Change Log
|
| 48 |
|
| 49 | ### v2.3.3 (2014/02/20 00:22 +00:00)
|
| 50 | - [#83](https://github.com/goodybag/mongo-sql/pull/83) Buffer not defined in browser (@jrf0110)
|
| 51 |
|
| 52 | ### v2.3.2 (2014/02/19 23:54 +00:00)
|
| 53 | - [#82](https://github.com/goodybag/mongo-sql/pull/82) Preserve Buffer query values. (@alexmingoia)
|
| 54 |
|
| 55 | ### v2.3.1 (2014/02/08 23:01 +00:00)
|
| 56 | - [#81](https://github.com/goodybag/mongo-sql/pull/81) Casts + JSON derefs are malformed during the automated quoting (@jrf0110)
|
| 57 |
|
| 58 | ### v2.3.0 (2014/01/29 22:16 +00:00)
|
| 59 | - [#25](https://github.com/goodybag/mongo-sql/pull/25) Querying on JSON (@jrf0110)
|
| 60 |
|
| 61 | ### v2.2.14 (2014/01/27 22:35 +00:00)
|
| 62 | - [#78](https://github.com/goodybag/mongo-sql/pull/78) adding npm info (@lalitkapoor)
|
| 63 | - [#80](https://github.com/goodybag/mongo-sql/pull/80) $nin does not support Array (@jrf0110)
|
| 64 |
|
| 65 | ### v2.2.13 (2014/01/13 17:40 +00:00)
|
| 66 | - [#77](https://github.com/goodybag/mongo-sql/pull/77) Expose `quoteColumn` on root namespace (@prestonp)
|
| 67 |
|
| 68 | ### v2.2.12 (2013/11/26 20:57 +00:00)
|
| 69 | - [#76](https://github.com/goodybag/mongo-sql/pull/76) Dates not handled correctly in update where clause (@jrf0110)
|
| 70 |
|
| 71 | ### v2.2.11 (2013/11/15 15:46 +00:00)
|
| 72 | - [#74](https://github.com/goodybag/mongo-sql/pull/74) Drop constraint action needs options (@jrf0110)
|
| 73 |
|
| 74 | ### v2.2.10 (2013/11/15 06:03 +00:00)
|
| 75 | - [#73](https://github.com/goodybag/mongo-sql/pull/73) Action helper should accept an array of actions (@jrf0110)
|
| 76 |
|
| 77 | ### v2.2.9 (2013/11/12 05:05 +00:00)
|
| 78 | - [#70](https://github.com/goodybag/mongo-sql/pull/70) Window functions (@ProCynic)
|
| 79 |
|
| 80 | ...
|
| 81 |
|
| 82 |
|
| 83 |
|
| 84 | #### Generate changelog via commit messages
|
| 85 | ```bash
|
| 86 | github-changes -o npm -r npm -a
|
| 87 | ```
|
| 88 |
|
| 89 | #### Output
|
| 90 |
|
| 91 | ## Change Log
|
| 92 |
|
| 93 | ### upcoming (2014/02/23 10:02 +00:00)
|
| 94 | - [70fd532](https://github.com/npm/npm/commit/70fd532c91335e76bda9366234b53a0498b9901a) fix prune.js test with empty cache (@robertkowalski)
|
| 95 | - [6fd6ff7](https://github.com/npm/npm/commit/6fd6ff7e536ea6acd33037b1878d4eca1f931985) Sort dependencies when --save'ing. (@domenic)
|
| 96 | - [2ddd060](https://github.com/npm/npm/commit/2ddd06037e9bd58cd95a380a9381ff90bea47f0d) add test, some boyscouting (@robertkowalski)
|
| 97 | - [17f07df](https://github.com/npm/npm/commit/17f07df8ad8e594304c2445bf7489cb53346f2c5) Add --save-exact config for --save[-dev|-optional]. (@timoxley)
|
| 98 | - [4b51920](https://github.com/npm/npm/commit/4b5192071654e2b312a7678b7586e435be62f473) Prevent creation of node_modules/npm-4503-c (@timoxley)
|
| 99 | - [30b6783](https://github.com/npm/npm/commit/30b67836b51b68614c9e87dc476c0961d53ec6d4) doc: update misc/semver.md (@isaacs)
|
| 100 |
|
| 101 | ### v1.4.4 (2014/02/20 16:04 +00:00)
|
| 102 | - [05d2490](https://github.com/npm/npm/commit/05d2490526fa40adc55727e92d4d30bd63aabaad) uid-number@0.0.4 (@isaacs)
|
| 103 | - [3850441](https://github.com/npm/npm/commit/3850441fd8c2fd71ebfd8e9986bc5f2e482ab6db) Document the --tag option of npm-publish (@kriskowal)
|
| 104 | - [14e650b](https://github.com/npm/npm/commit/14e650bce0bfebba10094c961ac104a61417a5de) alias 't' to 'test' (@isaacs)
|
| 105 | - [d50b826](https://github.com/npm/npm/commit/d50b826b9e5884c0f4e1101b90c7206a138a43e7) uid-number@0.0.5 (@isaacs)
|
| 106 | - [cd7e4a2](https://github.com/npm/npm/commit/cd7e4a23037f3ae1928bac02332784ffab557be9) v1.4.4 (@isaacs)
|
| 107 |
|
| 108 | ### v1.4.3 (2014/02/17 04:37 +00:00)
|
| 109 | - [3ce6905](https://github.com/npm/npm/commit/3ce6905bf6b0963956d7dbb8a89fc29d379de91c) view: remove arbitrary cache limit (@isaacs)
|
| 110 | - [bb6fb4d](https://github.com/npm/npm/commit/bb6fb4d158f175ddeb2956b361f854c273b6bed0) read-installed@1.0.0 (@isaacs)
|
| 111 | - [caa7065](https://github.com/npm/npm/commit/caa7065b06ffb55ea3410e5a14ddc80c26844b13) new tests for read-installed (@isaacs)
|
| 112 | - [401a642](https://github.com/npm/npm/commit/401a64286aa6665a94d1d2f13604f7014c5fce87) link: do not allow linking unnamed packages (@isaacs)
|
| 113 | - [09223de](https://github.com/npm/npm/commit/09223de8778b3e8fb0ecfec82cf6058d2c659518) Forbid deleting important npm dirs (@isaacs)
|
| 114 | - [86028e9](https://github.com/npm/npm/commit/86028e9fd8524d5e520ce01ba2ebab5a030103fc) dedupe: respect dependency versions (@rafeca)
|
| 115 | - [02d4322](https://github.com/npm/npm/commit/02d4322cd4f67a078a29019d2c4ef591b281132c) Follow redirects on curl|sh installer script (@isaacs)
|
| 116 | - [8a26f6f](https://github.com/npm/npm/commit/8a26f6ff7e9769985f74b60eed54e488a4d4a804) Test for repo command (@isaacs)
|
| 117 | - [acc4d02](https://github.com/npm/npm/commit/acc4d023c57d07704b20a0955e4bf10ee91bdc83) prune: Added back --production support (@davglass)
|
| 118 | - [0a3151c](https://github.com/npm/npm/commit/0a3151c9cbeb50c1c65895685c2eabdc7e2608dc) default to ^ instead of ~ (@mikolalysenko)
|
| 119 | - [9ae71de](https://github.com/npm/npm/commit/9ae71de7802132c349c60f1b740a734761fec4a1) npm-registry-client@0.4.4 (@isaacs)
|
| 120 | - [46d8768](https://github.com/npm/npm/commit/46d876821d1dd94c050d5ebc86444bed12c56739) "install ./pkg@1.2.3" should install local module (@rlidwka)
|
| 121 | - [f469847](https://github.com/npm/npm/commit/f46984787e8bb219cfd1d8394932dca2ed6b3b2c) test: express is not in mocks, use underscore instead (@isaacs)
|
| 122 |
|
| 123 | ...
|
| 124 |
|
| 125 | ### Using with Grunt
|
| 126 |
|
| 127 | If you want to generate a changelog within a grunt workflow, [a grunt plugin] (https://github.com/streetlight/grunt-github-changes) that can be utilized. To install:
|
| 128 |
|
| 129 | ```
|
| 130 | npm install grunt-github-changes --save-dev
|
| 131 | ```
|
| 132 |
|
| 133 | For further details and specifics on how to use (and to contribute), see [grunt-github-changes](https://github.com/streetlight/grunt-github-changes).
|