Skip to content

A go application to export Github issues with comments to html files

License

Notifications You must be signed in to change notification settings

johnsonz/export-github-issues

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Export github issues

Build Status GPLv3 License

说明

用于导出github特定仓库的所有issues,导出格式为date_title_state_issue number.html。最后会生成一个index.html文件用于索引。

这里使用了github的REST API v3,是有次数限制的,可自行申请client_id和client_secret以增大API调用次数。

高级用法

Usage: export-github-issues [COMMANDS] [VARS]

SUPPORT COMMANDS:
    -h, --help               help messages

SUPPORT VARS:
    -o, --owner              github owner of repesitory
    -r, --repo               github repesitory
    -p, --per_page           pagination, page size up to 100
    -s, --state              issues state (open, closed or all)
    -ci, --client_id         github OAuth application's client ID
    -cs, --client_secret     github OAuth application's client Secret
    -a, --archive_images     save images to local disk

配置说明

"owner":"" github owner,如johnsonz

"repo":"" github 仓库名称,如export-github-issues

"per_page":80 最大不能超过100

"state":"all" issues的状态,只允许是"all", "open"或"closed"

"client_id":"" 不填有API次数限制,"Settings"->"OAuth applications"中生成的Client ID

"client_secret":"" 不填有API次数限制,"Settings"->"OAuth applications"中生成的Client Secret

"archive_images":true 是否将issue中的图片保存到本地,默认为true

Usage

A simple application to export all issues for specified repository. The exported file format looks like this: date_title_state_issue number.html. An index.html file which includes all issues will be generated after the application finishes its run.

Advanced usage

For example:

export-github-issues -o johnsonz -r export-github-issues -p 80 -s open

Usage: export-github-issues [COMMANDS] [VARS]

SUPPORT COMMANDS:
    -h, --help               help messages

SUPPORT VARS:
    -o, --owner              github owner of repesitory
    -r, --repo               github repesitory
    -p, --per_page           pagination, page size up to 100
    -s, --state              issues state (open, closed or all)
    -ci, --client_id         github OAuth application's client ID
    -cs, --client_secret     github OAuth application's client Secret
    -a, --archive_images     save images to local disk

Configuration

"owner":"" github owner of repesitory, such as "johnsonz"

"repo":"" github repesitory, such as "export-github-issues"

"per_page":80 the maximum number is 100

"state":"all" issues state("all", "open" or "closed)

"client_id":"" there is API rate limit if empty. If you need a higher rate limit, please put in your OAuth application's client ID and secret.

"client_secret":"" there is API rate limit if empty. If you need a higher rate limit, please put in your OAuth application's client ID and secret.

"archive_images":true save images to local disk.