Merge branch 'release/1.11.1'

Add rubocop and rspec as runtime dependencies

.rubocop.yml

@@ -14,3 +14,43 @@ Metrics/ClassLength:
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
     Enabled: false
+
+Style/FileName:
+    Exclude:
+      - 'bin/git-generate-changelog'
+
+#TODOS
+# Offense count: 14
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 10
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+    

.rubocop_todo.yml

@@ -1,11 +1,17 @@
-# This configuration was generated by `rubocop --auto-gen-config`
+# This configuration was generated by
-# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
+# `rubocop --auto-gen-config`
+# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 13
+# Offense count: 1
+Lint/ImplicitStringConcatenation:
+  Exclude:
+    - 'lib/github_changelog_generator/parser.rb'
+
+# Offense count: 14
 Metrics/AbcSize:
   Enabled: false
 
@@ -13,11 +19,11 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 8
 
-# Offense count: 2
+# Offense count: 1
 Style/AccessorMethodName:
   Enabled: false
 
@@ -30,13 +36,16 @@ Style/Documentation:
 Style/GuardClause:
   Enabled: false
 
-# Offense count: 1
+# Offense count: 2
+# Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
 Style/Next:
   Enabled: false
 
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Enabled: false

.travis.yml

@@ -6,7 +6,7 @@ before_install:
 rvm:
 - 2.1.0
 script:
-- bundle exec rake
+- bundle exec rake checks
 notifications:
   email:
     recipients:

CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Log
 
+## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
+
+**Fixed bugs:**
+
+- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
+
+## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
+
+## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
+
+**Implemented enhancements:**
+
+- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
+- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
+
+**Fixed bugs:**
+
+- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
+
+**Merged pull requests:**
+
+- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
+
+## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
+
+**Fixed bugs:**
+
+- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
+
 ## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
 

Gemfile

@@ -3,8 +3,6 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem "rspec", "~>3.2"
-  gem "rubocop", "~>0.31"
   gem "coveralls", "~>0.8", require: false
   gem "simplecov", "~>0.10", require: false
   gem "codeclimate-test-reporter", "~>0.4"

Gemfile.lock

@@ -1,23 +1,27 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.10.0)
+    github_changelog_generator (1.11.0)
+      bundler (>= 1.7)
       colorize (~> 0.7)
       github_api (~> 0.12)
+      overcommit (>= 0.31)
+      rake (>= 10.0)
+      rspec (>= 3.2)
+      rubocop (>= 0.31)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
     ast (2.2.0)
-    astrolabe (1.3.1)
+    childprocess (0.5.9)
-      parser (~> 2.2)
+      ffi (~> 1.0, >= 1.0.11)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.7)
-    coveralls (0.8.10)
+    coveralls (0.8.11)
       json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
       simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
@@ -26,10 +30,9 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.25)
-      unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
     github_api (0.13.1)
       addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
@@ -38,53 +41,48 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       oauth2
     hashie (3.4.3)
-    http-cookie (1.0.2)
+    iniparse (1.4.2)
-      domain_name (~> 0.5)
     json (1.8.3)
-    jwt (1.5.2)
+    jwt (1.5.1)
-    mime-types (2.99)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    netrc (0.11.0)
+    oauth2 (1.1.0)
-    oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
+      rack (>= 1.2, < 3)
-    parser (2.2.3.0)
+    overcommit (0.32.0)
-      ast (>= 1.1, < 3.0)
+      childprocess (~> 0.5.8)
+      iniparse (~> 1.4)
+    parser (2.3.0.6)
+      ast (~> 2.2)
     powerpack (0.1.1)
     rack (1.6.4)
-    rainbow (2.0.0)
+    rainbow (2.1.0)
-    rake (10.4.2)
+    rake (10.5.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
+    rspec-core (3.4.3)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.35.1)
+    rubocop (0.37.2)
-      astrolabe (~> 1.3)
+      parser (>= 2.3.0.4, < 3.0)
-      parser (>= 2.2.3.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
-      tins (<= 1.6.0)
+      unicode-display_width (~> 0.3)
     ruby-progressbar (1.7.5)
-    simplecov (0.11.1)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -94,22 +92,16 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.5)
     tins (1.6.0)
-    unf (0.1.4)
+    unicode-display_width (0.3.1)
-      unf_ext
-    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
   codeclimate-test-reporter (~> 0.4)
   coveralls (~> 0.8)
   github_changelog_generator!
-  rake (~> 10.0)
-  rspec (~> 3.2)
-  rubocop (~> 0.31)
   simplecov (~> 0.10)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

README.md

@@ -21,7 +21,7 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
   - [License](#license)
 
 
-### Changelog generation has never been so easy:
+### Changelog generation has never been so easy
 
 **Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
 
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
 ### *Why should I care?*
 Because software tools are for people. If you don’t 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.
 
-> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com/)*
+> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
 
 ## Installation
 
@@ -45,7 +45,7 @@ Because software tools are for people. If you don’t care, why are you contribu
 
 		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
 
-- In general it looks like this:
+- In general, it looks like this:
 
 > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
 >
@@ -67,25 +67,25 @@ Because software tools are for people. If you don’t care, why are you contribu
 
 
 ## Usage
-**It's really simple**:
+**It's really simple!**
 
-- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
+- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
 
 		github_changelog_generator
 
--  or from anywhere:
+-  Or, run this from anywhere:
     - `github_changelog_generator -u github_username -p github_project`
     - `github_changelog_generator  github_username/github_project`
 
-As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
+This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
 
 ### Params
 Type `github_changelog_generator --help` for details.
 
-More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+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
-You can put Params in a .github_changelog_generator file in Project Root to override default params:
+In your project root, you can put a params file named `.github_changelog_generator` to override default params:
 
 Example:
 ```
@@ -96,36 +96,41 @@ since-tag=1.0.0
 
 ### GitHub token
 
-Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
+GitHub only allows only 50 unauthenticated requests per hour. 
+Therefore, it's recommended to run this script with authentication by using a **token**.
 
-**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
+Here's how:
 
-And:
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
+- Either:
+    - Run the script with `--token <your-40-digit-token>`; **OR**
+    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
 
-- Run with key `-t [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`):
-- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
 
-	i.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»"
 
-        export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
+So, if you got an error like this:
-
-So, if you got error like this:
 >! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
 
-It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
+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,
+Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
-but you most likely wouldn't like to have to open issues and PRs for all past features listed in your historic 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` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
+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? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
+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.
+
+Just put something like this in your `Rakefile`:
 
 ```ruby
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
@@ -134,94 +139,94 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
 end
 ```
 
-All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
+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.
 
 ## Features and advantages of this project
-- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
-- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
 - **GitHub Enterprise support** via command line options! :factory:
-- Flexible format **customisation**:
+- Flexible format **customization**:
-    - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
+    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
-    - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
+    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
-    - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of  required version :pushpin:
+    - 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**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
+    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
-- **Distinguish** issues **according labels**. :mag_right:
+- **Distinguish** issues **by labels**. :mag_right:
-    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
+    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
-    - Bug fixes (by label `bug` in issue) :beetle:
+    - Bug fixes (issues labeled `bug`) :beetle:
-    - Enhancements (by label `enhancement` in issue) :star2:
+    - Enhancements (issues labeled `enhancement`) :star2:
-    - 	Issues (closed issues `w/o any labels`) :non-potable_water:
+    - Issues (closed issues with no labels) :non-potable_water:
 
-- You can manually set which labels should be included/excluded. :wrench:
+- Manually include or exclude issues by labels :wrench:
-- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
+- Customize lots more! Tweak the changelog to fit your preferences :tophat:
-(*look `github_changelog_generator --help`  for details)*
+(*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.
+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!*
+*If you know other projects, feel free to edit this Wiki page!*
 
 
 ### Projects using this library
-[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
+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` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
+*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 generator better together!
+- 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, well-wishes are always welcome* :heavy_exclamation_mark:
+- *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 so much people using it yet)! :congratulations:
+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:
 
-*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
 
-I'm not try to compare quality of auto-generated and manually generated logs.. but:
+I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
 
-The auto generated Changelog really helps even if you manually fill Releases notes!
+An auto-generated changelog really helps, even if you manually fill in the release notes!
 
 For example:
 
-When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
+When I found a closed bug, it's very useful know which release fixed it. 
+In this case, you can easily find the issue by \# in `CHANGELOG.md`.
 
-- it's not so quite easy to find it in manually filled Releases notes.
+- it's not quite as easy to find this in handwritten releases notes
-- this file can also help you to build your Release note and not miss features in manually-filled list.
+- a generated file saves you the trouble of remembering everything;
+  sometimes people forget to add things to a handwritten file
 
-In the end:
+Ultimately, I think GitHub Releases is 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 think, that GitHub Releases is more for end-users.
+- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
-But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
-And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
 
-- ***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).
 
-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 allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
+If you're seeing this warning, please do the following:
 
-If you're seeing this warning:
+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`
-1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
-2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
 ## Contributing
 
-1. Create an issue to discuss about your idea
+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. Push to the branch (`git push origin my-new-feature`)
+5. Publish the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 7. Profit! :white_check_mark:
 
-*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
+*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
 
 ## License
 

Rakefile

@@ -1,7 +1,23 @@
+require "bundler"
+require "bundler/gem_tasks"
 require "rubocop/rake_task"
 require "rspec/core/rake_task"
+require "pathname"
+require "fileutils"
+require "overcommit"
 
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:rspec)
 
-task default: [:rubocop, :rspec]
+task :create_man do |_t|
+  os_prefix = "/usr/local"
+  man_prefix = Pathname("#{os_prefix}/share/man/man1")
+  man_pages = "man/git-*"
+
+  Pathname.glob(man_pages) do |path|
+    FileUtils.cp(path, man_prefix + path.basename)
+  end
+end
+
+task checks: [:rubocop, :rspec]
+task default: [:checks, :create_man]

bin/git-generate-changelog

@@ -0,0 +1,4 @@
+#! /usr/bin/env ruby
+
+require_relative "../lib/github_changelog_generator"
+GitHubChangelogGenerator::ChangelogGenerator.new.run

github_changelog_generator.gemspec

@@ -17,16 +17,18 @@ Gem::Specification.new do |spec|
   spec.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."
   spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
   spec.license = "MIT"
+  spec.extensions = ["Rakefile"]
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rake", ">= 10.0"
+  spec.add_runtime_dependency "bundler", ">= 1.7"
   spec.add_runtime_dependency("github_api", ["~> 0.12"])
   spec.add_runtime_dependency("colorize", ["~> 0.7"])
-
+  spec.add_runtime_dependency("overcommit", ">= 0.31")
-  # Development only
+  spec.add_runtime_dependency("rubocop", ">= 0.31")
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_runtime_dependency("rspec", ">= 3.2")
-  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/github_changelog_generator.rb

@@ -28,7 +28,7 @@ module GitHubChangelogGenerator
     def run
       log = @generator.compound_changelog
 
-      output_filename = "#{@options[:output]}"
+      output_filename = (@options[:output]).to_s
       File.open(output_filename, "w") { |file| file.write(log) }
       puts "Done!"
       puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/fetcher.rb

@@ -123,12 +123,12 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
     def fetch_closed_pull_requests
       pull_requests = []
       begin
-        if @options[:release_branch].nil?
+        response = if @options[:release_branch].nil?
-          response = @github.pull_requests.list @options[:user],
+                     @github.pull_requests.list @options[:user],
                                                 @options[:project],
                                                 state: "closed"
                    else
-          response = @github.pull_requests.list @options[:user],
+                     @github.pull_requests.list @options[:user],
                                                 @options[:project],
                                                 state: "closed",
                                                 base: @options[:release_branch]

lib/github_changelog_generator/generator/generator_generation.rb

@@ -8,12 +8,14 @@ module GitHubChangelogGenerator
       sort_tags_by_date(@filtered_tags)
       fetch_issues_and_pr
 
-      log = "#{@options[:header]}\n\n"
+      log = ""
+      log += @options[:frontmatter] if @options[:frontmatter]
+      log += "#{@options[:header]}\n\n"
 
-      if @options[:unreleased_only]
+      log += if @options[:unreleased_only]
-        log += generate_log_between_tags(filtered_tags[0], nil)
+               generate_log_between_tags(filtered_tags[0], nil)
              else
-        log += generate_log_for_all_tags
+               generate_log_for_all_tags
              end
 
       log += File.read(@options[:base]) if File.file?(@options[:base])
@@ -37,10 +39,10 @@ module GitHubChangelogGenerator
           index2 = hash[tag2]
           log += generate_log_between_tags(all_tags[index1], all_tags[index2])
         else
-          fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
+          raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
         end
       else
-        fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
+        raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
       end
       log
     end
@@ -77,15 +79,15 @@ module GitHubChangelogGenerator
       time_string = newer_tag_time.strftime @options[:date_format]
 
       # Generate tag name and link
-      if @options[:release_url]
+      release_url = if @options[:release_url]
-        release_url = format(@options[:release_url], newer_tag_link)
+                      format(@options[:release_url], newer_tag_link)
                     else
-        release_url = "#{project_url}/tree/#{newer_tag_link}"
+                      "#{project_url}/tree/#{newer_tag_link}"
                     end
-      if newer_tag_name.equal? @options[:unreleased_label]
+      log += if newer_tag_name.equal? @options[:unreleased_label]
-        log += "## [#{newer_tag_name}](#{release_url})\n\n"
+               "## [#{newer_tag_name}](#{release_url})\n\n"
              else
-        log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
              end
 
       if @options[:compare_link] && older_tag_link
@@ -169,10 +171,10 @@ module GitHubChangelogGenerator
 
       unless issue.pull_request.nil?
         if @options[:author]
-          if issue.user.nil?
+          title_with_number += if issue.user.nil?
-            title_with_number += " ({Null user})"
+                                 " ({Null user})"
                                else
-            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
+                                 " ([#{issue.user.login}](#{issue.user.html_url}))"
                                end
         end
       end

lib/github_changelog_generator/generator/generator_processor.rb

@@ -4,14 +4,13 @@ module GitHubChangelogGenerator
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
-      unless @options[:exclude_labels].nil?
+      return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
-        issues = issues.select do |issue|
+
-          var = issue.labels.map(&:name) & @options[:exclude_labels]
+      issues.reject do |issue|
-          !(var).any?
+        labels = issue.labels.map(&:name)
+        (labels & @options[:exclude_labels]).any?
       end
     end
-      issues
-    end
 
     # @return [Array] filtered issues accourding milestone
     def filter_by_milestone(filtered_issues, tag_name, all_issues)
@@ -83,7 +82,7 @@ module GitHubChangelogGenerator
 
           tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
 
-          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
+          tag_in_range = tag_in_range_old && tag_in_range_new
 
           tag_in_range
         else
@@ -93,19 +92,19 @@ module GitHubChangelogGenerator
     end
 
     def tag_older_new_tag?(newer_tag_time, time)
-      if newer_tag_time.nil?
+      tag_in_range_new = if newer_tag_time.nil?
-        tag_in_range_new = true
+                           true
                          else
-        tag_in_range_new = time <= newer_tag_time
+                           time <= newer_tag_time
                          end
       tag_in_range_new
     end
 
     def tag_newer_old_tag?(older_tag_time, t)
-      if older_tag_time.nil?
+      tag_in_range_old = if older_tag_time.nil?
-        tag_in_range_old = true
+                           true
                          else
-        tag_in_range_old = t > older_tag_time
+                           t > older_tag_time
                          end
       tag_in_range_old
     end
@@ -133,7 +132,7 @@ module GitHubChangelogGenerator
     def filter_by_include_labels(issues)
       filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
         labels = issue.labels.map(&:name) & @options[:include_labels]
-        (labels).any?
+        labels.any?
       end
       filtered_issues
     end

lib/github_changelog_generator/generator/generator_tags.rb

@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
     # @param [Hash] tag_name name of the tag
     # @return [Time] time of specified tag
     def get_time_of_tag(tag_name)
-      fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
+      raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
 
       name_of_tag = tag_name["name"]
       time_for_name = @tag_times_hash[name_of_tag]
@@ -58,7 +58,7 @@ module GitHubChangelogGenerator
       if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
         reader = GitHubChangelogGenerator::Reader.new
         content = reader.read(@options[:base])
-        @since_tag = content[0]["version"] if content
+        @since_tag = content[0]["version"] if content.count && content
       end
       @since_tag
     end
@@ -80,10 +80,10 @@ module GitHubChangelogGenerator
       if tag
         if all_tags.map(&:name).include? tag
           idx = all_tags.index { |t| t.name == tag }
-          if idx > 0
+          filtered_tags = if idx > 0
-            filtered_tags = all_tags[0..idx - 1]
+                            all_tags[0..idx - 1]
                           else
-            filtered_tags = []
+                            []
                           end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
@@ -101,10 +101,10 @@ module GitHubChangelogGenerator
         if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
           idx = all_tags.index { |t| t.name == tag }
           last_index = all_tags.count - 1
-          if idx > 0 && idx < last_index
+          filtered_tags = if idx > 0 && idx < last_index
-            filtered_tags = all_tags[idx + 1..last_index]
+                            all_tags[idx + 1..last_index]
                           else
-            filtered_tags = []
+                            []
                           end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."

lib/github_changelog_generator/helper.rb

@@ -6,10 +6,10 @@ module GitHubChangelogGenerator
       defined? SpecHelper
     end
 
-    if test?
+    @log ||= if test?
-      @log ||= Logger.new(nil) # don't show any logs when running tests
+               Logger.new(nil) # don't show any logs when running tests
              else
-      @log ||= Logger.new(STDOUT)
+               Logger.new(STDOUT)
              end
     @log.formatter = proc do |severity, _datetime, _progname, msg|
       string = "#{msg}\n"

lib/github_changelog_generator/parser.rb

@@ -68,6 +68,9 @@ module GitHubChangelogGenerator
         opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
           options[:header] = v
         end
+        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
+          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
+        end
         opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
           options[:merge_prefix] = v
         end

lib/github_changelog_generator/parser_file.rb

@@ -1,27 +1,30 @@
+require "pathname"
+
 module GitHubChangelogGenerator
   ParserError = Class.new(StandardError)
 
   class ParserFile
+    FILENAME = ".github_changelog_generator"
+
     def initialize(options)
       @options = options
     end
 
+    # Destructively change @options using data in configured options file.
     def parse!
-      return unless File.exist?(file)
+      file.each_line { |line| parse_line!(line) } if file.exist?
-
-      File.readlines(file).each { |line| parse_line!(line) }
     end
 
     private
 
     def file
-      @file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
+      @file ||= Pathname(File.expand_path(@options[:params_file] || FILENAME))
     end
 
     def parse_line!(line)
       key_sym, value = extract_pair(line)
-      value = true if value =~ (/^(true|t|yes|y|1)$/i)
+      value = true if value =~ /^(true|t|yes|y|1)$/i
-      value = false if value =~ (/^(false|f|no|n|0)$/i)
+      value = false if value =~ /^(false|f|no|n|0)$/i
       @options[key_sym] = value
     rescue
       raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""

lib/github_changelog_generator/task.rb

@@ -37,7 +37,7 @@ module GitHubChangelogGenerator
     def define(args, &task_block)
       desc "Generate a Change log from GitHub"
 
-      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+      yield(*[self, args].slice(0, task_block.arity)) if task_block
 
       # clear any (auto-)pre-existing task
       Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
@@ -57,7 +57,7 @@ module GitHubChangelogGenerator
 
         log = generator.compound_changelog
 
-        output_filename = "#{options[:output]}"
+        output_filename = (options[:output]).to_s
         File.open(output_filename, "w") { |file| file.write(log) }
         puts "Done!"
         puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.10.1"
+  VERSION = "1.11.1"
 end

man/git-generate-changelog.1

@@ -0,0 +1,252 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
+.
+.SH "NAME"
+\fBgit\-generate\-changelog\fR \- Generate changelog from github
+.
+.SH "SYNOPSIS"
+\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
+.
+.SH "DESCRIPTION"
+Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
+.
+.SH "OPTIONS"
+\-u, \-\-user [USER]
+.
+.P
+Username of the owner of target GitHub repo
+.
+.P
+\-p, \-\-project [PROJECT]
+.
+.P
+Name of project on GitHub
+.
+.P
+\-t, \-\-token [TOKEN]
+.
+.P
+To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
+.
+.P
+\-f, \-\-date\-format [FORMAT]
+.
+.P
+Date format\. Default is %Y\-%m\-%d
+.
+.P
+\-o, \-\-output [NAME]
+.
+.P
+Output file\. Default is CHANGELOG\.md
+.
+.P
+\-b, \-\-base [NAME]
+.
+.P
+Optional base file to append generated changes to\.
+.
+.P
+\-\-bugs\-label [LABEL]
+.
+.P
+Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
+.
+.P
+\-\-enhancement\-label [LABEL]
+.
+.P
+Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
+.
+.P
+\-\-issues\-label [LABEL]
+.
+.P
+Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
+.
+.P
+\-\-header\-label [LABEL]
+.
+.P
+Setup custom header label\. Default is "# Change Log"
+.
+.P
+\-\-pr\-label [LABEL]
+.
+.P
+Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
+.
+.P
+\-\-[no\-]issues
+.
+.P
+Include closed issues in changelog\. Default is true
+.
+.P
+\-\-[no\-]issues\-wo\-labels
+.
+.P
+Include closed issues without labels in changelog\. Default is true
+.
+.P
+\-\-[no\-]pr\-wo\-labels
+.
+.P
+Include pull requests without labels in changelog\. Default is true
+.
+.P
+\-\-[no\-]pull\-requests
+.
+.P
+Include pull\-requests in changelog\. Default is true
+.
+.P
+\-\-[no\-]filter\-by\-milestone
+.
+.P
+Use milestone to detect when issue was resolved\. Default is true
+.
+.P
+\-\-[no\-]author
+.
+.P
+Add author of pull\-request in the end\. Default is true
+.
+.P
+\-\-unreleased\-only
+.
+.P
+Generate log from unreleased closed issues only\.
+.
+.P
+\-\-[no\-]unreleased
+.
+.P
+Add to log unreleased closed issues\. Default is true
+.
+.P
+\-\-unreleased\-label [label]
+.
+.P
+Add to log unreleased closed issues\. Default is true
+.
+.P
+\-\-[no\-]compare\-link
+.
+.P
+Include compare link (Full Changelog) between older version and newer version\. Default is true
+.
+.P
+\-\-include\-labels x,y,z
+.
+.P
+Only issues with the specified labels will be included in the changelog\.
+.
+.P
+\-\-exclude\-labels x,y,z
+.
+.P
+Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
+.
+.P
+\-\-bug\-labels x,y,z
+.
+.P
+Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
+.
+.P
+\-\-enhancement\-labels x,y,z
+.
+.P
+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
+Change log will exclude specified tags
+.
+.P
+\-\-since\-tag x
+.
+.P
+Change log will start after specified tag
+.
+.P
+\-\-due\-tag x
+.
+.P
+Change log will end before specified tag
+.
+.P
+\-\-max\-issues [NUMBER]
+.
+.P
+Max number of issues to fetch from GitHub\. Default is unlimited
+.
+.P
+\-\-release\-url [URL]
+.
+.P
+The URL to point to for release links, in printf format (with the tag as variable)\.
+.
+.P
+\-\-github\-site [URL]
+.
+.P
+The Enterprise Github site on which your project is hosted\.
+.
+.P
+\-\-github\-api [URL]
+.
+.P
+The enterprise endpoint to use for your Github API\.
+.
+.P
+\-\-simple\-list
+.
+.P
+Create simple list from issues and pull requests\. Default is false\.
+.
+.P
+\-\-future\-release [RELEASE\-VERSION]
+.
+.P
+Put the unreleased changes in the specified release number\.
+.
+.P
+\-\-[no\-]verbose
+.
+.P
+Run verbosely\. Default is true
+.
+.P
+\-v, \-\-version
+.
+.P
+Print version number
+.
+.P
+\-h, \-\-help
+.
+.P
+Displays Help
+.
+.SH "EXAMPLES"
+.
+.SH "AUTHOR"
+Written by Petr Korolev sky4winder@gmail\.com
+.
+.SH "REPORTING BUGS"
+<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
+.
+.SH "SEE ALSO"
+<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>

man/git-generate-changelog.html

@@ -0,0 +1,262 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>git-generate-changelog(1) - Generate changelog from github</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>git-generate-changelog(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>  -u, --user [USER]</p>
+
+<p>  Username of the owner of target GitHub repo</p>
+
+<p>  -p, --project [PROJECT]</p>
+
+<p>  Name of project on GitHub</p>
+
+<p>  -t, --token [TOKEN]</p>
+
+<p>  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
+
+<p>  -f, --date-format [FORMAT]</p>
+
+<p>  Date format. Default is %Y-%m-%d</p>
+
+<p>  -o, --output [NAME]</p>
+
+<p>  Output file. Default is CHANGELOG.md</p>
+
+<p>  -b, --base [NAME]</p>
+
+<p>  Optional base file to append generated changes to.</p>
+
+<p>   --bugs-label [LABEL]</p>
+
+<p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
+
+<p>   --enhancement-label [LABEL]</p>
+
+<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
+
+<p>   --issues-label [LABEL]</p>
+
+<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
+
+<p>   --header-label [LABEL]</p>
+
+<p>   Setup custom header label. Default is "# Change Log"</p>
+
+<p>   --pr-label [LABEL]</p>
+
+<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
+
+<p>   --[no-]issues</p>
+
+<p>   Include closed issues in changelog. Default is true</p>
+
+<p>   --[no-]issues-wo-labels</p>
+
+<p>   Include closed issues without labels in changelog. Default is true</p>
+
+<p>   --[no-]pr-wo-labels</p>
+
+<p>   Include pull requests without labels in changelog. Default is true</p>
+
+<p>   --[no-]pull-requests</p>
+
+<p>   Include pull-requests in changelog. Default is true</p>
+
+<p>   --[no-]filter-by-milestone</p>
+
+<p>   Use milestone to detect when issue was resolved. Default is true</p>
+
+<p>   --[no-]author</p>
+
+<p>   Add author of pull-request in the end. Default is true</p>
+
+<p>   --unreleased-only</p>
+
+<p>   Generate log from unreleased closed issues only.</p>
+
+<p>   --[no-]unreleased</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --unreleased-label [label]</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --[no-]compare-link</p>
+
+<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
+
+<p>   --include-labels x,y,z</p>
+
+<p>   Only issues with the specified labels will be included in the changelog.</p>
+
+<p>   --exclude-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
+
+<p>   --bug-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
+
+<p>   --enhancement-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
+
+<p>   --between-tags x,y,z</p>
+
+<p>   Change log will be filled only between specified tags</p>
+
+<p>   --exclude-tags x,y,z</p>
+
+<p>   Change log will exclude specified tags</p>
+
+<p>   --since-tag x</p>
+
+<p>   Change log will start after specified tag</p>
+
+<p>   --due-tag x</p>
+
+<p>   Change log will end before specified tag</p>
+
+<p>   --max-issues [NUMBER]</p>
+
+<p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
+
+<p>   --release-url [URL]</p>
+
+<p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
+
+<p>   --github-site [URL]</p>
+
+<p>   The Enterprise Github site on which your project is hosted.</p>
+
+<p>   --github-api [URL]</p>
+
+<p>   The enterprise endpoint to use for your Github API.</p>
+
+<p>   --simple-list</p>
+
+<p>   Create simple list from issues and pull requests. Default is false.</p>
+
+<p>   --future-release [RELEASE-VERSION]</p>
+
+<p>   Put the unreleased changes in the specified release number.</p>
+
+<p>   --[no-]verbose</p>
+
+<p>   Run verbosely. Default is true</p>
+
+<p>  -v, --version</p>
+
+<p>  Print version number</p>
+
+<p>  -h, --help</p>
+
+<p>  Displays Help</p>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Written by Petr Korolev sky4winder@gmail.com</p>
+
+<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2015</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

man/git-generate-changelog.md

@@ -0,0 +1,179 @@
+git-generate-changelog(1) - Generate changelog from github
+================================
+
+## SYNOPSIS
+
+`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
+
+## DESCRIPTION
+
+Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
+
+## OPTIONS
+
+  -u, --user [USER]
+
+  Username of the owner of target GitHub repo
+
+  -p, --project [PROJECT]
+
+  Name of project on GitHub
+
+  -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
+
+  -f, --date-format [FORMAT]
+
+  Date format. Default is %Y-%m-%d
+
+  -o, --output [NAME]
+
+  Output file. Default is CHANGELOG.md
+
+  -b, --base [NAME]
+
+  Optional base file to append generated changes to.
+
+   --bugs-label [LABEL]
+
+   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
+
+   --enhancement-label [LABEL]
+
+   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
+
+   --issues-label [LABEL]
+
+   Setup custom label for closed-issues section. Default is "**Closed issues:**"
+
+   --header-label [LABEL]
+
+   Setup custom header label. Default is "# Change Log"
+
+   --pr-label [LABEL]
+
+   Setup custom label for pull requests section. Default is "**Merged pull requests:**"
+
+   --[no-]issues
+
+   Include closed issues in changelog. Default is true
+
+   --[no-]issues-wo-labels
+
+   Include closed issues without labels in changelog. Default is true
+
+   --[no-]pr-wo-labels
+
+   Include pull requests without labels in changelog. Default is true
+
+   --[no-]pull-requests
+
+   Include pull-requests in changelog. Default is true
+
+   --[no-]filter-by-milestone
+
+   Use milestone to detect when issue was resolved. Default is true
+
+   --[no-]author
+
+   Add author of pull-request in the end. Default is true
+
+   --unreleased-only
+
+   Generate log from unreleased closed issues only.
+
+   --[no-]unreleased
+
+   Add to log unreleased closed issues. Default is true
+
+   --unreleased-label [label]
+
+   Add to log unreleased closed issues. Default is true
+
+   --[no-]compare-link
+
+   Include compare link (Full Changelog) between older version and newer version. Default is true
+
+   --include-labels x,y,z
+
+   Only issues with the specified labels will be included in the changelog.
+
+   --exclude-labels x,y,z
+
+   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
+
+   --bug-labels x,y,z
+
+   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
+
+   --enhancement-labels x,y,z
+
+   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
+
+   --between-tags x,y,z
+
+   Change log will be filled only between specified tags
+
+   --exclude-tags x,y,z
+
+   Change log will exclude specified tags
+
+   --since-tag x
+
+   Change log will start after specified tag
+
+   --due-tag x
+
+   Change log will end before specified tag
+
+   --max-issues [NUMBER]
+
+   Max number of issues to fetch from GitHub. Default is unlimited
+
+   --release-url [URL]
+
+   The URL to point to for release links, in printf format (with the tag as variable).
+
+   --github-site [URL]
+
+   The Enterprise Github site on which your project is hosted.
+
+   --github-api [URL]
+
+   The enterprise endpoint to use for your Github API.
+
+   --simple-list
+
+   Create simple list from issues and pull requests. Default is false.
+
+   --future-release [RELEASE-VERSION]
+
+   Put the unreleased changes in the specified release number.
+
+   --[no-]verbose
+
+   Run verbosely. Default is true
+
+  -v, --version
+
+  Print version number
+
+  -h, --help
+
+  Displays Help
+
+
+## EXAMPLES
+
+## AUTHOR
+
+Written by Petr Korolev sky4winder@gmail.com
+
+## REPORTING BUGS
+
+&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
+
+## SEE ALSO
+
+&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;

spec/files/github_changelog_params_327

@@ -0,0 +1 @@
+exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90

spec/spec_helper.rb

@@ -23,11 +23,11 @@ require "coveralls"
 module SpecHelper
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
                                                                  Coveralls::SimpleCov::Formatter,
                                                                  SimpleCov::Formatter::HTMLFormatter,
                                                                  CodeClimate::TestReporter::Formatter
-]
+                                                               ])
 SimpleCov.start
 
 require "github_changelog_generator"

spec/unit/generator/generator_processor_spec.rb

@@ -0,0 +1,28 @@
+module GitHubChangelogGenerator
+  describe Generator do
+    context "#exclude_issues_by_labels" do
+      let(:label) { double("the-bad-label", name: "BAD") }
+      let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
+      let(:good_label) { double("a-good-label", name: "GOOD") }
+      let(:good_issue) { double("an-issue-to-be-kept", labels: [good_label]) }
+      let(:issues) { [issue, good_issue] }
+      subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
+
+      it "removes issues with labels in the exclude_label list" do
+        result = generator.exclude_issues_by_labels(issues)
+
+        expect(result).to include(good_issue)
+        expect(result).not_to include(issue)
+      end
+
+      context "with no option given" do
+        subject(:generator) { described_class.new }
+        it "passes everything through when no option given" do
+          result = generator.exclude_issues_by_labels(issues)
+
+          expect(result).to eq(issues)
+        end
+      end
+    end
+  end
+end

spec/unit/parse_file_spec.rb

@@ -36,6 +36,20 @@ describe GitHubChangelogGenerator::ParserFile do
                                           unreleased: false,
                                           header: "=== Changelog ==="))
       end
+
+      context "turns exclude-labels into an Array", bug: '#327' do
+        let(:options) do
+          {
+            params_file: "spec/files/github_changelog_params_327"
+          }
+        end
+        it "reads exclude_labels into an Array" do
+          pending("Related with Bug #327.")
+          expect { parse.parse! }.to change { options[:exclude_labels] }
+            .from(nil)
+            .to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
+        end
+      end
     end
   end
 end