github_changelog_generator 1.15.0.pre.beta → 1.15.0.pre.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55def2416dfef54779832b68f186965d4c62bbd0
-  data.tar.gz: c9f978a6b01aab0356b676e7749f1b25d4aacc93
+  metadata.gz: ec76ed478bd8c2cf2500a55c75c1a9f12ffc46d6
+  data.tar.gz: 50192107d5f4ef52815262e08980c01a4c348781
 SHA512:
-  metadata.gz: acdbbbae3679145b85639750184fffd39efe3d94ea2447f3429341655bd9ea94860f1a1eea65f970437ae2894aeffc145685ef34cda687acf90123d45dc7b6b0
-  data.tar.gz: 7cf8cf180df005695f5d3882299ce4ad4ef3b504dd0bfbba9806efe925fc1ebc666224b00eacbeda63add590ccd3b74ad19b40032c4fb70df07778cca444c29a
+  metadata.gz: 2e40ddcaeb4205c6b44aee5ed18728eba7f6b27423055746edd39b180267d41276b86074dfc7d4c612f65f2218553a7d8fe6ccace873fbc7dd2b025f28dddad6
+  data.tar.gz: 79270b1372d108a8645a246933219804595e88c9226202736926ab511cc0cd780e2bff5654fe32d408363a34904bd5d92e24e39aff8eda49aa7225ee961b51ec

data/README.md

@@ -1,285 +1,279 @@
-[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
-[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
-[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
-[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
-[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
-[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
-[![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
-==================
-
-  - [Installation](#installation)
-  - [Output example](#output-example)
-  - [Usage](#usage)
-    - [Params](#params)
-    - [GitHub token](#github-token)
-  - [Features and advantages of this project](#features-and-advantages-of-this-project)
-    - [Alternatives](#alternatives)
-    - [Projects using this library](#projects-using-this-library)
-  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
-  - [Contributing](#contributing)
-  - [License](#license)
-
-
-### Changelog generation has never been so easy
-
-**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
-
-Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
-
-### *What’s the point of a change log?*
-
-To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
-
-### *Why should I care?*
-
-Because software tools are for _people_. "Changelogs make it easier for users and
-contributors to see precisely what notable changes have been made between each
-release (or version) of the project."
-
-:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
-
-## Installation
-
-    gem install github_changelog_generator
-
-See also Troubleshooting.
-
-## Output example
-
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
-- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
-
-      github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
-
-- In general, it looks like this:
-
-> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
->
-> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
->
-> **Implemented enhancements:**
->
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
->
-> **Fixed bugs:**
->
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
->
-> **Merged pull requests:**
->
-> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
->
-> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-
-
-## Usage
-
--  Run this:
-
-      `github_changelog_generator -u github_username -p github_project`
-      `github_changelog_generator  github_username/github_project`
-
-- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-
-      github_changelog_generator --github-site="https://github.yoursite.com" \
-                                 --github-api="https://github.yoursite.com/api/v3/"
-
-This generates a `CHANGELOG.md`, with pretty Markdown formatting.
-
-### Params
-
-Type `github_changelog_generator --help` for details.
-
-For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
-
-### Params File
-
-In your project root, you can put a params file named `.github_changelog_generator` to override default params:
-
-Example:
-
-```
-unreleased=false
-future-release=5.0.0
-since-tag=1.0.0
-```
-
-### GitHub token
-
-GitHub only allows 50 unauthenticated requests per hour.
-
-Therefore, it's recommended to run this script with authentication by using a **token**.
-
-Here's how:
-
-- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
-- Either:
-    - Run the script with `--token <your-40-digit-token>`; **OR**
-    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
-
-You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
-
-    export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
-
-So, if you get a message like this:
-
-``` markdown
-API rate limit exceeded for github_username.
-See: https://developer.github.com/v3/#rate-limiting
-```
-
-It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
-
-## Migrating from a manual changelog
-
-Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
-But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
-
-That's where `--base <your-manual-changelog.md>` comes in handy!
-This option lets append your old manual changelog to the end of the generated entries.
-
-If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
-
-### Rake task
-
-You love `rake`? We do, too! So, we've made it even easier for you:
-we've provided a `rake` task library for your changelog generation.
-
-Configure the task in your `Rakefile`:
-
-```ruby
-require 'github_changelog_generator/task'
-
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.since_tag = '0.1.14'
-  config.future_release = '0.2.0'
-end
-```
-
-All command-line options can be passed to the `rake` task as `config`
-parameters. And since you're naming the `rake` task yourself, you can create
-as many as you want.
-
-You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
-
-## Features and advantages of this project
-
-- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
-- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-- **GitHub Enterprise support** via command line options! :factory:
-- Flexible format **customization**:
-    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
-    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
-    - Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
-    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
-- **Distinguish** issues **by labels**. :mag_right:
-    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
-    - Bug fixes (issues labeled `bug`) :beetle:
-    - Enhancements (issues labeled `enhancement`) :star2:
-    - Issues (closed issues with no labels) :non-potable_water:
-
-- Manually include or exclude issues by labels :wrench:
-- Customize lots more! Tweak the changelog to fit your preferences :tophat:
-(*See `github_changelog_generator --help`  for details)*
-
-
-### Alternatives
-
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
-
-*If you know other projects, feel free to edit this Wiki page!*
-
-
-### Projects using this library
-
-Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
-
-If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
-
-*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
-
-## Am I missing some essential feature?
-
-- **Nothing is impossible!**
-
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
-
-- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
-
-## FAQ
-
-- ***I already use GitHub Releases. Why do I need this?***
-
-GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
-
-*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
-
-I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
-
-An auto-generated changelog really helps, even if you manually fill in the release notes!
-
-For example:
-
-When you find a closed bug, it is very useful to know which release fixed it.
-So that you can easily find the issue by \# in `CHANGELOG.md`.
-
-- it's not quite as easy to find this in handwritten releases notes
-- a generated file saves you the trouble of remembering everything;
-  sometimes people forget to add things to a handwritten file
-
-Ultimately, I think GitHub Releases are ideal for end-users.
-Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-
-- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
-
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
-
-If you're seeing this warning, please do the following:
-
-1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
-2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
-
-- ***My Ruby version is very old, can I use this?***
-
-When your Ruby is old, and you don't want to upgrade, and you want to
-control which libraries you use, you can use Bundler.
-
-In a Gemfile, perhaps in a non-deployed `:development` group, add this
-gem:
-
-```ruby
-group :development do
-  gem 'github_changelog_generator', require: false
-end
-```
-
-Then you can keep back dependencies like rack, which currently is only
-compatible with Ruby >= 2.2.2. So, use an older version for your app by
-adding a line like this to the Gemfile:
-
-```
-gem 'rack', '~> 1.6'
-```
-
-This way, you can keep on using github_changelog_generator, even if you
-can't get the latest version of Ruby installed.
-
-## Contributing
-
-1. Create an issue and describe your idea
-2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Publish the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
-7. Profit! :white_check_mark:
-
-You can test your workflow with changelog generator with [the skywinder/changelog_test repo](https://github.com/skywinder/changelog_test/).
-
-## License
-
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
+[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
+[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
+[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
+[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
+[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
+[![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
+==================
+
+  - [Installation](#installation)
+  - [Output example](#output-example)
+  - [Usage](#usage)
+    - [Params](#params)
+    - [GitHub token](#github-token)
+  - [Features and advantages of this project](#features-and-advantages-of-this-project)
+    - [Alternatives](#alternatives)
+    - [Projects using this library](#projects-using-this-library)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+
+### Changelog generation has never been so easy
+
+**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+
+Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
+
+### *What’s the point of a change log?*
+
+To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
+
+### *Why should I care?*
+
+Because software tools are for _people_. "Changelogs make it easier for users and
+contributors to see precisely what notable changes have been made between each
+release (or version) of the project."
+
+:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+
+## Installation
+
+    gem install github_changelog_generator
+
+See also Troubleshooting.
+
+## Output example
+
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
+      github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+- In general, it looks like this:
+
+> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+>
+> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+>
+> **Implemented enhancements:**
+>
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+>
+> **Fixed bugs:**
+>
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+>
+> **Merged pull requests:**
+>
+> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+>
+> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+
+
+## Usage
+
+-  Run this:
+
+      `github_changelog_generator -u github_username -p github_project`
+      `github_changelog_generator  github_username/github_project`
+
+- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
+
+      github_changelog_generator --github-site="https://github.yoursite.com" \
+                                 --github-api="https://github.yoursite.com/api/v3/"
+
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
+
+### Params
+
+Type `github_changelog_generator --help` for details.
+
+For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+
+### Params File
+
+In your project root, you can put a params file named `.github_changelog_generator` to override default params:
+
+Example:
+
+```
+unreleased=false
+future-release=5.0.0
+since-tag=1.0.0
+```
+
+### GitHub token
+
+GitHub only allows 50 unauthenticated requests per hour.
+
+Therefore, it's recommended to run this script with authentication by using a **token**.
+
+Here's how:
+
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
+- Either:
+    - Run the script with `--token <your-40-digit-token>`; **OR**
+    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
+
+You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+
+    export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+
+So, if you get a message like this:
+
+``` markdown
+API rate limit exceeded for github_username.
+See: https://developer.github.com/v3/#rate-limiting
+```
+
+It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
+
+## Migrating from a manual changelog
+
+Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
+But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
+
+That's where `--base <your-manual-changelog.md>` comes in handy!
+This option lets append your old manual changelog to the end of the generated entries.
+
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
+
+### Rake task
+
+You love `rake`? We do, too! So, we've made it even easier for you:
+we've provided a `rake` task library for your changelog generation.
+
+Configure the task in your `Rakefile`:
+
+```ruby
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.since_tag = '0.1.14'
+  config.future_release = '0.2.0'
+end
+```
+
+All command-line options can be passed to the `rake` task as `config`
+parameters. And since you're naming the `rake` task yourself, you can create
+as many as you want.
+
+You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
+
+## Features and advantages of this project
+
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+- **GitHub Enterprise support** via command line options! :factory:
+- Flexible format **customization**:
+    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
+    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
+    - Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
+    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
+- **Distinguish** issues **by labels**. :mag_right:
+    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
+    - Bug fixes (issues labeled `bug`) :beetle:
+    - Enhancements (issues labeled `enhancement`) :star2:
+    - Issues (closed issues with no labels) :non-potable_water:
+
+- Manually include or exclude issues by labels :wrench:
+- Customize lots more! Tweak the changelog to fit your preferences :tophat:
+(*See `github_changelog_generator --help`  for details)*
+
+
+### Alternatives
+
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+
+*If you know other projects, feel free to edit this Wiki page!*
+
+
+### Projects using this library
+
+Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+
+If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
+
+*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list](https://github.com/skywinder/github-changelog-generator/wiki/Projects-using-Github-Changelog-Generator).*
+
+## Am I missing some essential feature?
+
+- **Nothing is impossible!**
+
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+
+- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
+
+## FAQ
+
+- ***I already use GitHub Releases. Why do I need this?***
+
+GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
+
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+
+I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
+
+An auto-generated changelog really helps, even if you manually fill in the release notes!
+
+For example:
+
+When you find a closed bug, it is very useful to know which release fixed it.
+So that you can easily find the issue by \# in `CHANGELOG.md`.
+
+- it's not quite as easy to find this in handwritten releases notes
+- a generated file saves you the trouble of remembering everything;
+  sometimes people forget to add things to a handwritten file
+
+Ultimately, I think GitHub Releases are ideal for end-users.
+Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
+Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
+
+- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+
+GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
+
+If you're seeing this warning, please do the following:
+
+1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
+2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
+
+- ***My Ruby version is very old, can I use this?***
+
+When your Ruby is old, and you don't want to upgrade, and you want to
+control which libraries you use, you can use Bundler.
+
+In a Gemfile, perhaps in a non-deployed `:development` group, add this
+gem:
+
+```ruby
+group :development do
+  gem 'github_changelog_generator', require: false
+end
+```
+
+Then you can keep back dependencies like rack, which currently is only
+compatible with Ruby >= 2.2.2. So, use an older version for your app by
+adding a line like this to the Gemfile:
+
+```
+gem 'rack', '~> 1.6'
+```
+
+This way, you can keep on using github_changelog_generator, even if you
+can't get the latest version of Ruby installed.
+
+## Contributing
+
+We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
+
+[CONTRIBUTING.md]: CONTRIBUTING.md
+
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/github_changelog_generator/generator/generator.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "../octo_fetcher"
-require_relative "generator_generation"
-require_relative "generator_fetcher"
-require_relative "generator_processor"
-require_relative "generator_tags"
+require "github_changelog_generator/octo_fetcher"
+require "github_changelog_generator/generator/generator_generation"
+require "github_changelog_generator/generator/generator_fetcher"
+require "github_changelog_generator/generator/generator_processor"
+require "github_changelog_generator/generator/generator_tags"
 
 module GitHubChangelogGenerator
   # Default error for ChangelogGenerator

data/lib/github_changelog_generator/generator/generator_generation.rb

@@ -6,6 +6,7 @@ module GitHubChangelogGenerator
     #
     # @return [String] Generated change log file
     def compound_changelog
+      options.load_custom_ruby_files
       fetch_and_filter_tags
       fetch_issues_and_pr
 

data/lib/github_changelog_generator/options.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require "delegate"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
+  # This class wraps Options, and knows a list of known options. Others options
+  # will raise exceptions.
   class Options < SimpleDelegator
+    # Raised on intializing with unknown keys in the values hash,
+    # and when trying to store a value on an unknown key.
     UnsupportedOptionError = Class.new(ArgumentError)
 
+    # List of valid option names
     KNOWN_OPTIONS = %i[
       add_issues_wo_labels
       add_pr_wo_labels
@@ -43,6 +50,7 @@ module GitHubChangelogGenerator
       pulls
       release_branch
       release_url
+      require
       simple_list
       since_tag
       ssl_ca_file
@@ -55,26 +63,56 @@ module GitHubChangelogGenerator
       verbose
     ]
 
+    # @param values [Hash]
+    #
+    # @raise [UnsupportedOptionError] if given values contain unknown options
     def initialize(values)
       super(values)
       unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
     end
 
+    # Set option key to val.
+    #
+    # @param key [Symbol]
+    # @param val [Object]
+    #
+    # @raise [UnsupportedOptionError] when trying to set an unknown option
     def []=(key, val)
       supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
       values[key] = val
     end
 
+    # @return [Hash]
     def to_hash
       values
     end
 
+    # Loads the configured Ruby files from the --require option.
+    def load_custom_ruby_files
+      self[:require].each { |f| require f }
+    end
+
+    # Pretty-prints a censored options hash, if :verbose.
+    def print_options
+      return unless self[:verbose]
+      Helper.log.info "Using these options:"
+      pp(censored_values)
+      puts ""
+    end
+
     private
 
     def values
       __getobj__
     end
 
+    # Returns a censored options hash.
+    #
+    # @return [Hash] The GitHub `:token` key is censored in the output.
+    def censored_values
+      values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
+    end
+
     def unsupported_options
       values.keys - KNOWN_OPTIONS
     end

data/lib/github_changelog_generator/parser.rb

@@ -3,8 +3,9 @@
 
 require "optparse"
 require "pp"
-require_relative "version"
-require_relative "helper"
+require "github_changelog_generator/version"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
@@ -19,43 +20,34 @@ module GitHubChangelogGenerator
         abort [e, parser].join("\n")
       end
 
-      abort(parser.banner) unless options[:user] && options[:project]
+      unless options[:user] && options[:project]
+        warn "Configure which user and project to work on."
+        warn "Options --user and --project, or settings to that effect. See --help for more."
+        abort(parser.banner)
+      end
 
-      print_options(options)
+      options.print_options
 
       options
     end
 
-    # If options set to verbose, print the parsed options.
+    # Setup parsing options
     #
-    # The GitHub `:token` key is censored in the output.
-    #
-    # @param options [Hash] The options to display
-    # @option options [Boolean] :verbose If false this method does nothing
-    def self.print_options(options)
-      if options[:verbose]
-        Helper.log.info "Performing task with options:"
-        options_to_display = options.clone
-        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
-        pp options_to_display
-        puts ""
-      end
-    end
-
-    # setup parsing options
+    # @param options [Options]
+    # @return [OptionParser]
     def self.setup_parser(options)
-      parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator [options]"
-        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
+        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last|
           options[:user] = last
         end
-        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub") do |last|
           options[:project] = last
         end
         opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
           options[:token] = last
         end
-        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last|
           options[:date_format] = last
         end
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
@@ -121,7 +113,7 @@ module GitHubChangelogGenerator
         opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
           options[:include_labels] = list
         end
-        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
           options[:exclude_labels] = list
         end
         opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
@@ -181,6 +173,9 @@ module GitHubChangelogGenerator
         opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
           options[:ssl_ca_file] = ssl_ca_file
         end
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
+          options[:require] = paths
+        end
         opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -193,10 +188,9 @@ module GitHubChangelogGenerator
           exit
         end
       end
-      parser
     end
 
-    # @return [Hash] Default options
+    # @return [Options] Default options
     def self.default_options
       Options.new(
         date_format: "%Y-%m-%d",
@@ -226,7 +220,8 @@ module GitHubChangelogGenerator
         bug_prefix: "**Fixed bugs:**",
         enhancement_prefix: "**Implemented enhancements:**",
         breaking_prefix: "**Breaking changes:**",
-        http_cache: true
+        http_cache: true,
+        require: []
       )
     end
   end

data/lib/github_changelog_generator/task.rb

@@ -10,6 +10,7 @@ module GitHubChangelogGenerator
 
     OPTIONS = %w[ user project token date_format output
                   bug_prefix enhancement_prefix issue_prefix
+                  breaking_labels issue_line_labels
                   header merge_prefix issues
                   add_issues_wo_labels add_pr_wo_labels
                   pulls filter_issues_by_milestone author

data/lib/github_changelog_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHubChangelogGenerator
-  VERSION = "1.15.0-beta"
+  VERSION = "1.15.0-rc"
 end

data/man/git-generate-changelog.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2017" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@@ -175,12 +175,6 @@ Issues with the specified labels will be always added to "Fixed bugs" section\.
 Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
 .
 .P
-\-\-between\-tags x,y,z
-.
-.P
-Change log will be filled only between specified tags
-.
-.P
 \-\-exclude\-tags x,y,z
 .
 .P
@@ -264,6 +258,25 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
 .P
 Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
+.IP "" 4
+.
+.nf
+
+\-\-ssl\-ca\-file [PATH]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
+.
+.P
+\-\-require file1\.rb,file2\.rb
+.
+.P
+Paths to Ruby file(s) to require before generating changelog\.
+.
 .P
 \-\-[no\-]verbose
 .

data/man/git-generate-changelog.1.html

@@ -248,6 +248,15 @@
 
 <p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
 
+<pre><code>--ssl-ca-file [PATH]
+</code></pre>
+
+<p>   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
+
+<p>   --require file1.rb,file2.rb</p>
+
+<p>   Paths to Ruby file(s) to require before generating changelog.</p>
+
 <p>   --[no-]verbose</p>
 
 <p>   Run verbosely. Default is true</p>
@@ -277,7 +286,7 @@
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>December 2016</li>
+    <li class='tc'>October 2017</li>
     <li class='tr'>git-generate-changelog(1)</li>
   </ol>
 

data/man/git-generate-changelog.md

@@ -177,7 +177,11 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
     --ssl-ca-file [PATH]
 
-   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem.  Respects SSL_CA_PATH.
+   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
+
+   --require file1.rb,file2.rb
+
+   Paths to Ruby file(s) to require before generating changelog.
 
    --[no-]verbose
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.15.0.pre.beta
+  version: 1.15.0.pre.rc
 platform: ruby
 authors:
 - Petr Korolev
@@ -9,36 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -54,33 +68,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.6'
 - !ruby/object:Gem::Dependency
-  name: faraday-http-cache
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: retriable
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +109,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Changelog generation has never been so easy. Fully automate changelog
   generation - this gem generate change log file based on tags, issues and merged
   pull requests from Github issue tracker.