github-history

Generate an HTML document containing either an issue list or release history of a Github repository.

Assumptions

1. The repository is using Github releases
2. The repository uses issues/pull-requests to track new code that is merged in

Install

1. git clone [email protected]:robstrong/github-history.git
2. composer.phar install - See here to install composer

To compile Release History:

php bin/ghh releases

To compile a List of Issues:

php bin/ghh issues

Some good options to use with either of the above commands:

--repo-user (-u) Github Repository User Name --repository (-r) Github Repository Name --output-path (-o) Output Path

Sample call to compile issues (with options listed above):

php bin/ghh issues -u <Owner/User> -r <Repo-Name> -o output/issues/

If you would like to remove specific labels from your issues list, use parameter l (lower-case L) and provide a quoted comma-separated list:

php bin/ghh issues -u Pica9 -r cd-core -l "Design, enhancement, Backlog" -o output/issues/