github-changelog-generator/README.md

19 lines
1005 B
Markdown
Raw Normal View History

2014-11-06 13:39:10 +00:00
ChangelogGenerator
==================
2014-11-06 13:47:56 +00:00
This script automatically generate change-log from your tags and merged pull-requests.
2014-11-06 13:39:10 +00:00
2014-11-06 13:47:56 +00:00
Usage: changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
-u, --user [USER] your username on GitHub
-p, --project [PROJECT] name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-l, --last-changes generate log between last 2 tags
-f, --date-format [FORMAT] date format. default is %d/%m/%y
### Example:
2014-11-06 13:39:10 +00:00
`./changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]`
2014-11-06 13:47:56 +00:00
2014-11-06 13:39:10 +00:00
In output you get `[your_project]_changelog.md` file with automatically generated changelogs.