Merge branch 'release/1.7.0'

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-07-16 14:46:25 +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
+  Enabled: false
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:

CHANGELOG.md

@@ -1,11 +1,39 @@
 # Change Log
 
-## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
+## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
 
-[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.6.1...1.6.2)
 
 **Fixed bugs:**
 
+- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
+
+## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
+
+**Implemented enhancements:**
+
+- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
+
+**Fixed bugs:**
+
+- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
+
+## [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...1.6.0)
+
+**Implemented enhancements:**
+
+- Issues with any label  except "bug", "enhancement" should not be 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)
@@ -20,6 +48,8 @@
 
 - Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
 
+- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
+
 **Merged pull requests:**
 
 - Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
@@ -64,12 +94,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))

Gemfile

@@ -1,14 +1,11 @@
 source "https://rubygems.org"
 
-gem "rake", ">=10.4.2"
-
-gem "github_api", ">=0.12.3"
-gem "colorize", ">=0.7.7"
+gemspec
 
 group :test do
-  gem "rspec"
-  gem "rubocop"
-  gem "coveralls", require: false
-  gem "simplecov", require: false
-  gem "codeclimate-test-reporter"
+  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"
 end

Gemfile.lock

@@ -1,14 +1,21 @@
+PATH
+  remote: .
+  specs:
+    github_changelog_generator (1.6.2)
+      colorize (~> 0.7)
+      github_api (~> 0.12)
+
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
     ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.7)
-    coveralls (0.8.1)
+    coveralls (0.8.2)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
       simplecov (~> 0.10.0)
@@ -30,14 +37,14 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.4.1)
+    hashie (3.4.2)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
-    json (1.8.2)
-    jwt (1.5.0)
-    mime-types (2.5)
+    json (1.8.3)
+    jwt (1.5.1)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
-    multi_json (1.11.0)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     netrc (0.10.3)
@@ -49,32 +56,32 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    parser (2.2.2.2)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
-    rack (1.6.1)
+    rack (1.6.4)
     rainbow (2.0.0)
     rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.31.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
       astrolabe (~> 1.3)
-      parser (>= 2.2.2.1, < 3.0)
+      parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
@@ -84,11 +91,11 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    term-ansicolor (1.3.0)
+    term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tins (1.5.1)
+    tins (1.5.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
@@ -97,11 +104,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter
-  colorize (>= 0.7.7)
-  coveralls
-  github_api (>= 0.12.3)
-  rake (>= 10.4.2)
-  rspec
-  rubocop
-  simplecov
+  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)

README.md

@@ -80,44 +80,15 @@ 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.
-
-     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
+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)
 
 ### 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)
 
-**You can easily [generate it here](https://github.com/settings/tokens)**.
+**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
 
 And:
 

lib/CHANGELOG.md

@@ -1,7 +1,30 @@
 # Change Log
 
-## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
+## [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 closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
+- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
+- 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)
+
+**Merged pull requests:**
+
+- 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))
+
+## [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)
 
 **Closed issues:**
@@ -13,7 +36,6 @@
 - Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
 
 ## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
-
 [Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
 
 **Merged pull requests:**
@@ -21,7 +43,6 @@
 - fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
 
 ## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
-
 [Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
 
 **Merged pull requests:**
@@ -31,5 +52,4 @@
 ## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
 
 
-
 \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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
@@ -56,7 +56,7 @@ module GitHubChangelogGenerator
     # @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
     # @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
     # @return [String] Ready and parsed section
-    def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
+    def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
       newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
 
       github_site = options[:github_site] || "https://github.com"

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/generator/generator_generation.rb

@@ -8,10 +8,10 @@ module GitHubChangelogGenerator
       sort_tags_by_date(@filtered_tags)
       fetch_issues_and_pr
 
-      log = "# Change Log\n\n"
+      log = "#{@options[:header]}\n\n"
 
       if @options[:unreleased_only]
-        log += generate_log_between_tags(all_tags[0], nil)
+        log += generate_log_between_tags(filtered_tags[0], nil)
       else
         log += generate_log_for_all_tags
       end
@@ -54,8 +54,9 @@ module GitHubChangelogGenerator
       if issues.any?
         issues.each do |issue|
           merge_string = get_string_for_issue(issue)
-          log += "- #{merge_string}\n\n"
+          log += "- #{merge_string}\n"
         end
+        log += "\n"
       end
       log
     end
@@ -78,7 +79,7 @@ module GitHubChangelogGenerator
       if newer_tag_name.equal? @options[:unreleased_label]
         log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
       else
-        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
+        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n"
       end
 
       if @options[:compare_link] && older_tag_link
@@ -102,7 +103,7 @@ module GitHubChangelogGenerator
         return ""
       end
 
-      create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
+      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
     end
 
     # Apply all filters to issues and pull requests

lib/github_changelog_generator/parser.rb

@@ -50,6 +50,21 @@ 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("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+          options[:header] = 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
@@ -80,7 +95,7 @@ module GitHubChangelogGenerator
         opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
           options[:compare_link] = v
         end
-        opts.on("--include-labels  x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
+        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
           options[:include_labels] = list
         end
         opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
@@ -150,6 +165,7 @@ module GitHubChangelogGenerator
         max_issues: nil,
         simple_list: false,
         verbose: true,
+        header: "# Change Log",
         merge_prefix: "**Merged pull requests:**",
         issue_prefix: "**Closed issues:**",
         bug_prefix: "**Fixed bugs:**",

lib/github_changelog_generator/version.rb

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