gh-history

generate github history from milestones and issues into markdown file.

Install

npm install gh-history -g

Command Line

common usage

gh-history -u react-component -r calendar -f HISTORY.md

use in basic authentication because of github api rate limit

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

or set process.env.GH_USERNAME and process.env.GH_PASSWORD.

Api

var ghHistory = require('gh-history');
ghHistory.generateHistoryMD({
    user : 'kissyteam',
    repo : 'kissy',
    mdFilePath : './HISTORY.md',
    loginUserName : 'exampleName',  //optional, or process.env.GH_USERNAME unless you get rate limit error
    loginPassword : 'examplePassword'  //optional, or process.env.GH_PASSWORD unless you get rate limit error
});

Example

xtemplate milestones and issues: https://github.com/kissyteam/xtemplate/milestones?state=closed

xtemplate HISTORY.md: https://github.com/kissyteam/xtemplate/blob/master/HISTORY.md

xtemplate history at spm: http://spmjs.io/docs/xtemplate/history.html

Related

npmjs.org/package/gh-changelog

History

generated by https://github.com/yiminghe/gh-history

1.2.4 (2014-08-28)

#4 Node下报错 (@yuanyan)

#2 optimize sub template include logic in compiled code (@yiminghe)

1.3.0 (2014-09-04)

#5 support requirejs (@yiminghe)

1.4.0 (2014-09-05)

#6 support foreach and forin for performance (@yiminghe)

2.0.0 (2014-09-17)

#9 speed boost by optimizing data read (@yiminghe)

2.2.0 (2014-09-18)

#10 catch runtime error (@yiminghe)

2.3.0 (2014-09-19)

#11 remove nested function from generate code (@yiminghe)

3.0.0 (2014-09-22)

#12 optimize include speed (@yiminghe)

3.1.1 (2014-09-23)

#14 support use loader on start (@yiminghe)

3.2.0 (2014-09-25)

#15 support strict (@yiminghe)

3.3.0 (2014-09-30)

#16 support set globalConfig and remove default loader (@yiminghe)

3.4.1 (2014-10-20)

#19 NPM 3.3.1 的发布 直接改动 kissy.add => modulex.add 导致modulex not define (@noyobo)

3.5.0 (2014-11-05)

#20 extended page misbehavior (@yiminghe)

3.6.0 (2014-11-24)

#33 add parentName property in TplWrap (@dead-horse)

#32 add filename into error message in compile (@dead-horse)

#31 ast.js 中 throw Error 没有出错的文件名的信息 (@dead-horse)

#29 support access root in macro (@yiminghe)

#25 avoid visit property of undefined (@dead-horse)

#23 include 空模版会报错？ (@dead-horse)

#22 所有的错误都统一处理 (@dead-horse)

#21 add missing comma (@dead-horse)

3.7.0 (2014-11-26)

#35 修改了render方法，支持接受Scope实例作为参数 (@zincli)

#34 是否考虑让render方法接受Scope实例作为参数，这样可使类似{{#childView}}这种子视图模板命令的实现更加优雅 (@zincli)

3.7.1 (2014-12-02)

improved #39 detect include/extend/parse paramerter error (@dead-horse)

improved #37 extend 的参数不能为变量 (@dead-horse)

4.0.0 (2014-12-10)

#28 支持链式调用数据中的方法 (@dead-horse)

4.0.2 (2014-12-22)

improved #48 Compile error (@dead-horse)