github-changelog-generator/params.json

1 line
11 KiB
JSON
Raw Permalink Normal View History

2015-03-20 12:48:20 +00:00
{"name":"Github-changelog-generator","tagline":"Automatically generate changelog from your tags, closed issues and merged pull requests.","body":"\r\n[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)\r\n[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)\r\n\r\nGitHub Changelog Generator\r\n==================\r\n\r\n - [Installation](#installation)\r\n - [Output example](#output-example)\r\n - [Usage](#usage)\r\n - [Params](#params)\r\n - [GitHub token](#github-token)\r\n - [Features and advantages of this project](#features-and-advantages-of-this-project)\r\n - [Alternatives](#alternatives)\r\n - [Projects using this library](#projects-using-this-library)\r\n - [Am I missed some essential feature?](#am-i-missed-some-essential-feature)\r\n - [Contributing](#contributing)\r\n - [License](#license)\r\n\r\n \r\n### Changelog generation has never been so easy:\r\n\r\n**Fully automate changelog generation** - This gem generate change log file based on **tags**, **issues** and merged **pull requests** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker.\r\n\r\nSince now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! :tada:\r\n\r\n>### *Whats the point of a change log?*\r\nTo make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.\r\n### *Why should I care?*\r\nBecause software tools are for people. If you dont care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.\r\n\r\n> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*\r\n\r\n## Installation\r\n\r\n\t[sudo] gem install github_changelog_generator\r\n\r\n## Output example\r\n\r\n- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project\r\n- [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- In general it looks like this:\r\n\r\n> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)\r\n> \r\n> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)\r\n> \r\n> **Implemented enhancements:**\r\n> \r\n> - Use milestone to specify in which version bug was fixed [\\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)\r\n> \r\n> **Fixed bugs:**\r\n> \r\n> - Error when trying to generate log for repo without tags [\\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)\r\n> \r\n> **Merged pull requests:**\r\n> \r\n> - PrettyPrint class is included using lowercase 'pp' [\\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))\r\n> \r\n> - support enterprise github via command line options [\\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))\r\n\r\n\r\n## Usage\r\n**It's really simple**: \r\n\r\n- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:\r\n\r\n\t\tgithub_changelog_generator\r\n\r\n- or from anywhere:\r\n - `github_changelog_generator -u github_username -p github_project`\r\n - `github_changelog_generator github_username/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 GitH