Merge branch 'release/1.6.1'

string

.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-11 16:35:14 +0300 using RuboCop version 0.31.0.
+# on 2015-06-12 11:23:12 +0300 using RuboCop version 0.31.0.
 # 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
@@ -7,7 +7,7 @@
 
 # Offense count: 13
 Metrics/AbcSize:
-  Max: 63
+  Max: 71
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:

CHANGELOG.md

@@ -1,11 +1,19 @@
 # Change Log
 
-## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
+## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
 
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...HEAD)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
+
+**Implemented enhancements:**
+
+- Issues with any label expect "bug", "enhancement" are excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
+
+- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
 
 **Fixed bugs:**
 
+- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
+
 - Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
 
 ## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
@@ -64,12 +72,12 @@
 
 **Merged pull requests:**
 
-- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
-
 - 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))

README.md

@@ -80,38 +80,9 @@ Because software tools are for people. If you don’t care, why are you contribu
 As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
 
 ### Params
-Type `github_changelog_generator --help` for detailed usage.
+Type `github_changelog_generator --help` for details.
-
-     Usage: github_changelog_generator [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
-            --[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. Default is 'bug,enhancement'
-            --exclude-labels  x,y,z      Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
-            --between-tags  x,y,z        Change log will be filled only between specified tags
-            --exclude-tags  x,y,z        Change log will be exclude specified tags
-            --max-issues [NUMBER]        Max number of issues to fetch from GitHub. Default is unlimited
-            --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
 
+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
 

lib/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
+
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
+
+**Implemented enhancements:**
+
+- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
+
+**Fixed bugs:**
+
+- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
+
+**Closed issues:**
+
+- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
+
+- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
+
 ## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
 
 [Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)

lib/github_changelog_generator/fetcher.rb

@@ -166,10 +166,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
               obj = @github.issues.events.list user: @options[:user],
                                                repo: @options[:project],
                                                issue_number: issue["number"]
+              issue[:events] = obj.body
             rescue
               Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
             end
-            issue[:events] = obj.body
             print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
             i += 1
           end

lib/github_changelog_generator/generator/generator.rb

@@ -41,7 +41,7 @@ module GitHubChangelogGenerator
     def encapsulate_string(string)
       string.gsub! '\\', '\\\\'
 
-      encpas_chars = %w(> * _ \( \) [ ] #)
+      encpas_chars = %w(< > * _ \( \) [ ] #)
       encpas_chars.each do |char|
         string.gsub! char, "\\#{char}"
       end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -41,8 +41,8 @@ module GitHubChangelogGenerator
           threads << Thread.new { find_closed_date_by_commit(issue) }
         end
         threads.each(&:join)
-        puts "Fetching closed dates for issues: Done!" if @options[:verbose]
       end
+      puts "Fetching closed dates for issues: Done!" if @options[:verbose]
     end
 
     # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.

lib/github_changelog_generator/parser.rb

@@ -50,6 +50,18 @@ module GitHubChangelogGenerator
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = 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
+        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
+          options[:enhancement_prefix] = v
+        end
+        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
+          options[:issue_prefix] = v
+        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
         opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
           options[:issues] = v
         end

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end