# gh-changelog

> generate github changelog into md file

Latest version **1.0.6** (published 2015-04-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install gh-changelog
pnpm add gh-changelog
yarn add gh-changelog
bun add gh-changelog
```

Provides the command `changelog-md`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2015-04-30 |
| First published | 2014-10-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | weekeight |
| Maintainers | weekeight |
| Keywords | github, changelog |

## Links

- npm: https://www.npmjs.com/package/gh-changelog
- Repository: git@github.com:weekeight/gh-changelog
- Homepage: https://github.com/weekeight/gh-changelog
- Issues: https://github.com/weekeight/gh-changelog/issues
- npm.io page: https://npm.io/package/gh-changelog

## Dependencies (6)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [request](https://npm.io/package/request.md) ^2.45.0
- [commander](https://npm.io/package/commander.md) ^2.4.0
- [escape-html](https://npm.io/package/escape-html.md) ^1.0.1
- [modulex-promise](https://npm.io/package/modulex-promise.md) ^1.1.2
- [modulex-html-parser](https://npm.io/package/modulex-html-parser.md) ^1.0.2

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2015-04-30
- 1.0.5 — 2014-10-27
- 1.0.4 — 2014-10-24
- 1.0.3 — 2014-10-23
- 1.0.2 — 2014-10-23
- 1.0.1 — 2014-10-23

## README

gh-changelog
=============

generate github changelog into markdown file

##Install

	npm install gh-changelog -g

##Command Line

common usage

	changelog-md -u kissyteam -r kissy -f changelog.md

use in basic authentication because of github api [rate limit](https://developer.github.com/v3/#rate-limiting)

	changelog-md -u kissyteam -r kissy -f changelog.md -n yourGithubUserName -p yourGithubPassword

##Use Api

	var ghChangeLog = require('gh-changelog');
	ghChangeLog.getChangeLog({
		user : 'kissyteam',
		repo : 'kissy',
		mdFilePath : './changelog.md',
		loginUserName : 'exampleName',  //optional,unless you get rate limit error
		loginPassword : 'examplePassword'  //optional,unless you get rate limit error
	});
	
	//or you can get the changelog data and output changelog whatever format you prefer
	ghChangeLog.getChangeLogData({
		user : 'kissyteam',
		repo : 'kissy',
		loginUserName : 'exampleName',  //optional,unless you get rate limit error
		loginPassword : 'examplePassword'  //optional,unless you get rate limit error
	},function(changeLogData){
		//do something with changeLogData...
	})

---
_Source: https://npm.io/package/gh-changelog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._