github-changelog-generator/params.json

1 line
4.2 KiB
JSON
Raw Normal View History

2014-11-14 08:47:04 +00:00
{"name":"Github-changelog-generator","tagline":"Automatically generate changelog from your tags, closed issues and merged pull requests.","body":"GitHub Changelog Generator\r\n==================\r\n\r\n[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)\r\n\r\nChangelog generation has never been so easy.\r\n\r\nThis script automatically generate change-log from your tags and merged pull-requests.\r\n\r\n## Installation:\r\n\t[sudo] gem install github_changelog_generator\r\n\r\n## Usage\r\n**It's really simple**: \r\n\r\n- `cd` to your Project folder with configured git and just type:\r\n\r\n\t\tgithub_changelog_generator\r\n\r\n- from anywhere:\r\n\r\n\t\tgithub_changelog_generator -u github-username -p github-project\r\n \r\nAs output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.\r\n\r\n## Params:\r\nType `github_changelog_generator --help` for detailed usage.\r\n\r\n Usage: changelog_generator [options]\r\n -u, --user [USER] Username of the owner of target GitHub repo\r\n -p, --project [PROJECT] Name of project on GitHub\r\n -t, --token [TOKEN] To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications\r\n -h, --help Displays Help\r\n -v, --[no-]verbose Run verbosely. Default is true\r\n --[no-]issues Include closed issues to changelog. Default is true\r\n --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true\r\n --[no-]pull-requests Include pull-requests to changelog. Default is true\r\n -l, --last-changes Generate log between last 2 tags only\r\n -f, --date-format [FORMAT] Date format. Default is %d/%m/%y\r\n -o, --output [NAME] Output file. Default is CHANGELOG.md\r\n --labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'\r\n\r\n## Examples:\r\n\r\n- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project\r\n- This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:\r\n\r\n\t\tgithub_changelog_generator -u skywinder -p ActionSheetPicker-3.0\r\n\r\n\r\n## FAQ:\r\nSince GitHub allow to make only 50 requests without authentication it's recommended to run this script with token\r\n\r\n**You can easily [generate it here](https://github.com/settings/applications)**.\r\n\r\nAnd:\r\n\r\n- Run with key `-t [your-16-digit-token]` that \r\n- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. \r\n \t\t\r\n\ti.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN=\"your-40-digit-github-token\"'`\r\n\r\nSo, if you got error like this:\r\n>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'\r\n\r\nIt's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.\r\n\r\n## Am I missed some essential feature?\r\n\r\n**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!\r\n\r\n*Bug reports, feature requests, patches, well-wishes are always welcome!*\r\n\r\n## Contributing\r\n\r\n1. Create an issue to discuss about your idea\r\n2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)\r\n3. Create your feature branch (`git checkout -b my-new-feature`)\r\n4. Commit your changes (`git commit -am 'Add some feature'`)\r\n5. Push to the branch (`git push origin my-new-feature`)\r\n6. Create a new Pull Request\r\n\r\n## License\r\n\r\nGithub Changelog Generator is relea