https://github.com/kaosat-dev/node-github-autochangelog
Automatic generation of changelogs using the github api + nodejs
https://github.com/kaosat-dev/node-github-autochangelog
Last synced: 6 months ago
JSON representation
Automatic generation of changelogs using the github api + nodejs
- Host: GitHub
- URL: https://github.com/kaosat-dev/node-github-autochangelog
- Owner: kaosat-dev
- License: other
- Created: 2013-07-25T22:29:14.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-07-31T22:37:22.000Z (almost 13 years ago)
- Last Synced: 2025-04-07T18:47:42.275Z (about 1 year ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Automatically generate changelogs using the GitHub API, for Node.JS
changelog auto generation based on github issues + git version tag deltas
## Installation
Install with the Node.JS package manager [npm](http://npmjs.org/):
$ npm install -g github-autochangelog
or
Install via git clone:
$ git clone git@github.com:kaosat-dev/node-github-autochangelog.git
$ cd node-github-autochangelog
$ npm install -g
## Example
command line usage :
ghchangelog --repo https://github.com/kaosat-dev/DummyRepo --out mychangeLog.md -v 2
output :
DummyRepo: v0.1.0
=================
- Done: issue 1
DummyRepo: v0.2.0
=================
- Done: issue 1
- Fixed: issue 2
- Done: issue 3
DummyRepo: v0.3.0
=================
- Done: issue 3
- Done: issue 5
## Notes
- favor using commits to close github issues
- tag correctly after closing issues
## Licence
MIT