Merge branch 'release/1.8.2'

Honor labels for Pull Requests

CHANGELOG.md

@@ -1,14 +1,32 @@
 # Change Log
 
-## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
+## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
 
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...HEAD)
+**Implemented enhancements:**
+
+- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
 
 **Merged pull requests:**
 
+- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
+- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
+
+## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
+
+**Implemented enhancements:**
+
+- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
+- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
+
+**Merged pull requests:**
+
+- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
+- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
 - Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
 - Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
-- Add --since-tag, close  [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
+- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
 
 ## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
@@ -89,6 +107,7 @@
 
 - Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
 - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
+- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
 
 **Closed issues:**
 
@@ -98,7 +117,6 @@
 
 - Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
 - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
-- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
 - Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
 - Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
 - Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
@@ -114,7 +132,7 @@
 ## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
 
@@ -125,7 +143,7 @@
 
 - Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
 
@@ -199,7 +217,7 @@
 ## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
 
-**Merged pull requests:**
+**Implemented enhancements:**
 
 - Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
 
@@ -220,10 +238,10 @@
 **Fixed bugs:**
 
 - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
+- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
 
 **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))
 
 ## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
@@ -333,6 +351,7 @@
 
 - Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
 - Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
+- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
 
 **Fixed bugs:**
 
@@ -340,7 +359,6 @@
 
 **Merged pull requests:**
 
-- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
 - Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
 
 ## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.7.0)
+    github_changelog_generator (1.8.1)
       colorize (~> 0.7)
       github_api (~> 0.12)
 
@@ -29,13 +29,13 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.3)
+    github_api (0.12.4)
       addressable (~> 2.3)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
+      hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
+      nokogiri (~> 1.6.6)
       oauth2
     hashie (3.4.2)
     http-cookie (1.0.2)
@@ -112,3 +112,6 @@ DEPENDENCIES
   rspec (~> 3.2)
   rubocop (~> 0.31)
   simplecov (~> 0.10)
+
+BUNDLED WITH
+   1.10.6

README.md

@@ -1,208 +1,218 @@
-[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![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)
+[![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://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
-[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/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)
+[![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)
+[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
-
+
-GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
+GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
-==================
+==================
-
+
-  - [Installation](#installation)
+  - [Installation](#installation)
-  - [Output example](#output-example)
+  - [Output example](#output-example)
-  - [Usage](#usage)
+  - [Usage](#usage)
-    - [Params](#params)
+    - [Params](#params)
-    - [GitHub token](#github-token)
+    - [GitHub token](#github-token)
-  - [Features and advantages of this project](#features-and-advantages-of-this-project)
+  - [Features and advantages of this project](#features-and-advantages-of-this-project)
-    - [Alternatives](#alternatives)
+    - [Alternatives](#alternatives)
-    - [Projects using this library](#projects-using-this-library)
+    - [Projects using this library](#projects-using-this-library)
-  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
-  - [Contributing](#contributing)
+  - [Contributing](#contributing)
-  - [License](#license)
+  - [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.
+**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.
-
+
-Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
+Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
-
+
->### *What’s the point of a change log?*
+>### *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.
+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?*
+### *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.
+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.
-
+
-> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
+> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
-
+
-## Installation
+## Installation
-
+
-	[sudo] gem install github_changelog_generator
+	[sudo] gem install github_changelog_generator
-
+
-## Output example
+## Output example
-
+
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- 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:
+- [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
+		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)
+> ## [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)
+> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
-> 
+> 
-> **Implemented enhancements:**
+> **Implemented enhancements:**
-> 
+> 
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
-> 
+> 
-> **Fixed bugs:**
+> **Fixed bugs:**
-> 
+> 
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
-> 
+> 
-> **Merged pull requests:**
+> **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))
+> - 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))
+> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-
+
-
+
-## Usage
+## 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, then just go to your project folder and run:
-
+
-		github_changelog_generator
+		github_changelog_generator
-
+
--  or from anywhere:
+-  or from anywhere:
-    - `github_changelog_generator -u github_username -p github_project`
+    - `github_changelog_generator -u github_username -p github_project`
-    - `github_changelog_generator  github_username/github_project`
+    - `github_changelog_generator  github_username/github_project`
-     
+     
-As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
+As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
-
+
-### Params
+### Params
-Type `github_changelog_generator --help` for details.
+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)
+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)
-
+
-### GitHub token
+### 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)
+Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
-
+
-**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
+**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
-
+
-And:
+And:
-
+
-- Run with key `-t [your-16-digit-token]` 
+- Run with key `-t [your-40-digit-token]` 
-- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
+- 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 :
+	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 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'
+>! /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 for 1 hour before GitHub reset the counter for your IP.
-
+
-
+## Migrating from a manual changelog
-### Rake task
+
-
+Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
-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:
+but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
-
+
-```ruby
+That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+
-  config.since_tag = '0.1.14'
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
-  config.future_release = '0.2.0'
+
-end
+### 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:
-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.
+
-
+```ruby
-##Features and advantages of this project
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
+  config.since_tag = '0.1.14'
-- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+  config.future_release = '0.2.0'
-- **GitHub Enterprise support** via command line options! :factory:
+end
-- Flexible format **customisation**:
+```
-    - **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:
+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.
-    - 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:
+
-    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
+##Features and advantages of this project
-- **Distinguish** issues **according labels**. :mag_right:
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
-    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
+- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-    - Bug fixes (by label `bug` in issue) :beetle:
+- **GitHub Enterprise support** via command line options! :factory:
-    - Enhancements (by label `enhancement` in issue) :star2:
+- Flexible format **customisation**:
-    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
+    - **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:
-- You can manually set which labels should be included/excluded. :wrench:
+    - 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:
-- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
+    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
-(*look `github_changelog_generator --help`  for details)*
+- **Distinguish** issues **according labels**. :mag_right:
-
+    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
-
+    - Bug fixes (by label `bug` in issue) :beetle:
-###Alternatives
+    - Enhancements (by label `enhancement` in issue) :star2:
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
+    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
-
+
-*If you know other projects - feel free to edit this Wiki page!*
+- You can manually set which labels should be included/excluded. :wrench:
-
+- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
-
+(*look `github_changelog_generator --help`  for details)*
-### Projects using this library
+
-[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
+
-
+###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
+[Wikipage with 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` 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.*
-
+
-## Am I missing some essential feature?
+## Am I missing some essential feature?
-
+
-- **Nothing is impossible!** 
+- **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 generator better together! 
-
+
-- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
+- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
-
+
-## FAQ
+## FAQ
-
+
-- ***I already use GitHub Releases. Why do I need this?***
+- ***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 so much people using it yet)! :congratulations:
-
+
-*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+*BDW: 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 try to compare quality of auto-generated and manually generated logs.. but:
-
+
-The auto generated Changelog really helps even if you manually fill Releases notes!
+The auto generated Changelog really helps even if you manually fill Releases notes!
-
+
-For example:
+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 to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
-
+
-- it's not so quite easy to find it in manually filled Releases notes.
+- it's not so quite easy to find it in manually filled Releases notes.
-- this file can also help you to build your Release note and not miss features in manually-filled list.
+- this file can also help you to build your Release note and not miss features in manually-filled list.
-
+
-In the end:
+In the end:
-
+
-I think, that GitHub Releases is more for end-users.
+I think, that GitHub Releases is more for end-users.
-But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
+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.
+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?***
+- ***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 allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and 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:
+If you're seeing this warning:
-
+
-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.
+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`
+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
+## Contributing
-
+
-1. Create an issue to discuss about your idea
+1. Create an issue to discuss about your idea
-2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
+2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
-3. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
+5. Push to the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
+6. Create a new Pull Request
-7. Profit! :white_check_mark:
+7. Profit! :white_check_mark:
-
+
-## License
+*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
-
+
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

lib/CHANGELOG.md

@@ -7,6 +7,7 @@
 **Implemented enhancements:**
 
 - Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
+- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
 
 **Fixed bugs:**
 
@@ -21,6 +22,7 @@
 
 **Merged pull requests:**
 
+- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
 - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
 - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
 

lib/github_changelog_generator/fetcher.rb

@@ -163,10 +163,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
         issues_slice.each do |issue|
           threads << Thread.new do
             begin
-              obj = @github.issues.events.list user: @options[:user],
+              response = @github.issues.events.list user: @options[:user],
-                                               repo: @options[:project],
+                                                    repo: @options[:project],
-                                               issue_number: issue["number"]
+                                                    issue_number: issue["number"]
-              issue[:events] = obj.body
+              issue[:events] = []
+              response.each_page do |page|
+                issue[:events].concat(page)
+              end
             rescue
               Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
             end

lib/github_changelog_generator/generator/generator.rb

@@ -66,7 +66,7 @@ module GitHubChangelogGenerator
 
       if @options[:issues]
         # Generate issues:
-        log += issues_to_log(issues)
+        log += issues_to_log(issues, pull_requests)
       end
 
       if @options[:pulls]
@@ -77,13 +77,14 @@ module GitHubChangelogGenerator
       log
     end
 
-    # Generate ready-to-paste log from list of issues.
+    # Generate ready-to-paste log from list of issues and pull requests.
     #
     # @param [Array] issues
+    # @param [Array] pull_requests
     # @return [String] generated log for issues
-    def issues_to_log(issues)
+    def issues_to_log(issues, pull_requests)
       log = ""
-      bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
+      bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
 
       log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
       log += generate_sub_section(bugs_a, @options[:bug_prefix])
@@ -95,8 +96,9 @@ module GitHubChangelogGenerator
     # (bugs, features, or just closed issues) by labels
     #
     # @param [Array] issues
+    # @param [Array] pull_requests
     # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
-    def parse_by_sections(issues)
+    def parse_by_sections(issues, pull_requests)
       issues_a = []
       enhancement_a = []
       bugs_a = []
@@ -117,6 +119,24 @@ module GitHubChangelogGenerator
         end
         issues_a.push dict unless added
       end
+
+      pull_requests.each do |dict|
+        added = false
+        dict.labels.each do |label|
+          if @options[:bug_labels].include? label.name
+            bugs_a.push dict
+            added = true
+            next
+          end
+          if @options[:enhancement_labels].include? label.name
+            enhancement_a.push dict
+            added = true
+            next
+          end
+        end
+        pull_requests.delete(dict) if added
+      end
+
       [bugs_a, enhancement_a, issues_a]
     end
   end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -48,11 +48,11 @@ module GitHubChangelogGenerator
     # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
     # @param [Hash] issue
     def find_closed_date_by_commit(issue)
-      unless issue["events"].nil?
+      unless issue[:events].nil?
         # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
         compare_string = issue[:merged_at].nil? ? "closed" : "merged"
         # reverse! - to find latest closed event. (event goes in date order)
-        issue["events"].reverse!.each do |event|
+        issue[:events].reverse!.each do |event|
           if event[:event].eql? compare_string
             set_date_from_event(event, issue)
             break

lib/github_changelog_generator/generator/generator_generation.rb

@@ -16,6 +16,8 @@ module GitHubChangelogGenerator
         log += generate_log_for_all_tags
       end
 
+      log += File.read(@options[:base]) if File.file?(@options[:base])
+
       log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
       @log = log
     end
@@ -49,9 +51,8 @@ module GitHubChangelogGenerator
     def generate_sub_section(issues, prefix)
       log = ""
 
-      log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
-
       if issues.any?
+        log += "#{prefix}\n\n" unless options[:simple_list]
         issues.each do |issue|
           merge_string = get_string_for_issue(issue)
           log += "- #{merge_string}\n"
@@ -101,7 +102,7 @@ module GitHubChangelogGenerator
     def generate_log_between_tags(older_tag, newer_tag)
       filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
 
-      older_tag_name = older_tag.nil? ? nil : older_tag["name"]
+      older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
 
       if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
         # do not generate empty unreleased section
@@ -115,7 +116,7 @@ module GitHubChangelogGenerator
     #
     # @return [Array] filtered issues and pull requests
     def filter_issues_for_tags(newer_tag, older_tag)
-      filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, older_tag, newer_tag)
+      filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
       filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
 
       newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]

lib/github_changelog_generator/generator/generator_processor.rb

@@ -63,21 +63,21 @@ module GitHubChangelogGenerator
     end
 
     # Method filter issues, that belong only specified tag range
-    # @param [Array] array of issues to filter
+    # @param [Array] issues issues to filter
     # @param [Symbol] hash_key key of date value default is :actual_date
     # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
     # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
     # @return [Array] filtered issues
-    def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
+    def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
       # in case if not tags specified - return unchanged array
-      return array if older_tag.nil? && newer_tag.nil?
+      return issues if older_tag.nil? && newer_tag.nil?
 
       newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
       older_tag_time = older_tag && get_time_of_tag(older_tag)
 
-      array.select do |req|
+      issues.select do |issue|
-        if req[hash_key]
+        if issue[hash_key]
-          time = Time.parse(req[hash_key]).utc
+          time = Time.parse(issue[hash_key]).utc
 
           tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
 

lib/github_changelog_generator/generator/generator_tags.rb

@@ -52,6 +52,17 @@ module GitHubChangelogGenerator
       [newer_tag_link, newer_tag_name, newer_tag_time]
     end
 
+    # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
+    def detect_since_tag
+      @since_tag ||= @options[:since_tag]
+      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
+      end
+      @since_tag
+    end
+
     # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
     #
     # @return [Array]
@@ -61,9 +72,11 @@ module GitHubChangelogGenerator
       filter_excluded_tags(filtered_tags)
     end
 
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :since_tag option
     def filter_since_tag(all_tags)
       filtered_tags = all_tags
-      tag = @options[:since_tag]
+      tag = detect_since_tag
       if tag
         if all_tags.map(&:name).include? tag
           idx = all_tags.index { |t| t.name == tag }
@@ -79,6 +92,29 @@ module GitHubChangelogGenerator
       filtered_tags
     end
 
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :due_tag option
+    def filter_due_tag(all_tags)
+      filtered_tags = all_tags
+      tag = @options[:due_tag]
+      if tag
+        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 = 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."
+        end
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :between_tags option
     def filter_between_tags(all_tags)
       filtered_tags = all_tags
       if @options[:between_tags]
@@ -92,6 +128,8 @@ module GitHubChangelogGenerator
       filtered_tags
     end
 
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :exclude_tags option
     def filter_excluded_tags(all_tags)
       filtered_tags = all_tags
       if @options[:exclude_tags]

lib/github_changelog_generator/parser.rb

@@ -24,7 +24,9 @@ module GitHubChangelogGenerator
 
       if options[:verbose]
         Helper.log.info "Performing task with options:"
-        pp options
+        options_to_display = options
+        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
+        pp options_to_display
         puts ""
       end
 
@@ -50,6 +52,9 @@ module GitHubChangelogGenerator
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = last
         end
+        opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
+          options[:base] = last
+        end
         opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
           options[:bug_prefix] = v
         end
@@ -116,6 +121,9 @@ module GitHubChangelogGenerator
         opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
           options[:since_tag] = v
         end
+        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+          options[:due_tag] = v
+        end
         opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
           options[:max_issues] = max
         end
@@ -156,6 +164,7 @@ module GitHubChangelogGenerator
         tag2: nil,
         date_format: "%Y-%m-%d",
         output: "CHANGELOG.md",
+        base: "HISTORY.md",
         issues: true,
         add_issues_wo_labels: true,
         add_pr_wo_labels: true,

lib/github_changelog_generator/task.rb

@@ -16,7 +16,7 @@ module GitHubChangelogGenerator
                   bug_labels enhancement_labels
                   between_tags exclude_tags since_tag max_issues
                   github_site github_endpoint simple_list
-                  future_release verbose )
+                  future_release verbose release_url )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.7.0"
+  VERSION = "1.8.2"
 end

spec/unit/generator/generator_tags_spec.rb

@@ -90,18 +90,70 @@ describe GitHubChangelogGenerator::Generator do
   end
 
   describe "#filter_since_tag" do
-    subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
+    context "with filled array" do
+      subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
 
-    context "with valid since tag" do
+      context "with valid since tag" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
-      it { is_expected.to be_a Array }
+        it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+      end
+
+      context "with invalid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      end
     end
 
-    context "with invalid since tag" do
+    context "with empty array" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: %w(invalid tags)) }
+      subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
-      it { is_expected.to be_a Array }
+
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      context "with valid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+
+      context "with invalid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+    end
+  end
+
+  describe "#filter_due_tag" do
+    context "with filled array" do
+      subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
+
+      context "with valid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
+      end
+
+      context "with invalid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      end
+    end
+
+    context "with empty array" do
+      subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
+
+      context "with valid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+
+      context "with invalid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
     end
   end