github_changelog_generator 1.10.1 → 1.10.4

data/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]

data/bin/git-generate-changelog

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

data/github_changelog_generator.gemspec

@@ -17,16 +17,16 @@ 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"])
-
-  # Development only
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency("overcommit", "~>0.31")
 end

data/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}"

data/lib/github_changelog_generator/fetcher.rb

@@ -123,16 +123,16 @@ 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 = @github.pull_requests.list @options[:user],
+        response = if @options[:release_branch].nil?
+                     @github.pull_requests.list @options[:user],
                                                 @options[:project],
                                                 state: "closed"
-        else
-          response = @github.pull_requests.list @options[:user],
+                   else
+                     @github.pull_requests.list @options[:user],
                                                 @options[:project],
                                                 state: "closed",
                                                 base: @options[:release_branch]
-        end
+                   end
         page_i = 0
         count_pages = response.count_pages
         response.each_page do |page|

data/lib/github_changelog_generator/generator/generator_generation.rb

@@ -8,13 +8,15 @@ 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 += generate_log_between_tags(filtered_tags[0], nil)
-      else
-        log += generate_log_for_all_tags
-      end
+      log += if @options[:unreleased_only]
+               generate_log_between_tags(filtered_tags[0], nil)
+             else
+               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,16 +79,16 @@ module GitHubChangelogGenerator
       time_string = newer_tag_time.strftime @options[:date_format]
 
       # Generate tag name and link
-      if @options[:release_url]
-        release_url = format(@options[:release_url], newer_tag_link)
-      else
-        release_url = "#{project_url}/tree/#{newer_tag_link}"
-      end
-      if newer_tag_name.equal? @options[:unreleased_label]
-        log += "## [#{newer_tag_name}](#{release_url})\n\n"
-      else
-        log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
-      end
+      release_url = if @options[:release_url]
+                      format(@options[:release_url], newer_tag_link)
+                    else
+                      "#{project_url}/tree/#{newer_tag_link}"
+                    end
+      log += if newer_tag_name.equal? @options[:unreleased_label]
+               "## [#{newer_tag_name}](#{release_url})\n\n"
+             else
+               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+             end
 
       if @options[:compare_link] && older_tag_link
         # Generate compare link
@@ -169,11 +171,11 @@ module GitHubChangelogGenerator
 
       unless issue.pull_request.nil?
         if @options[:author]
-          if issue.user.nil?
-            title_with_number += " ({Null user})"
-          else
-            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
-          end
+          title_with_number += if issue.user.nil?
+                                 " ({Null user})"
+                               else
+                                 " ([#{issue.user.login}](#{issue.user.html_url}))"
+                               end
         end
       end
       title_with_number

data/lib/github_changelog_generator/generator/generator_processor.rb

@@ -7,7 +7,7 @@ module GitHubChangelogGenerator
       unless @options[:exclude_labels].nil?
         issues = issues.select do |issue|
           var = issue.labels.map(&:name) & @options[:exclude_labels]
-          !(var).any?
+          !var.any?
         end
       end
       issues
@@ -83,7 +83,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,20 +93,20 @@ module GitHubChangelogGenerator
     end
 
     def tag_older_new_tag?(newer_tag_time, time)
-      if newer_tag_time.nil?
-        tag_in_range_new = true
-      else
-        tag_in_range_new = time <= newer_tag_time
-      end
+      tag_in_range_new = if newer_tag_time.nil?
+                           true
+                         else
+                           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 = true
-      else
-        tag_in_range_old = t > older_tag_time
-      end
+      tag_in_range_old = if older_tag_time.nil?
+                           true
+                         else
+                           t > older_tag_time
+                         end
       tag_in_range_old
     end
 
@@ -133,7 +133,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

data/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,11 +80,11 @@ module GitHubChangelogGenerator
       if tag
         if all_tags.map(&:name).include? tag
           idx = all_tags.index { |t| t.name == tag }
-          if idx > 0
-            filtered_tags = all_tags[0..idx - 1]
-          else
-            filtered_tags = []
-          end
+          filtered_tags = if idx > 0
+                            all_tags[0..idx - 1]
+                          else
+                            []
+                          end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
         end
@@ -101,11 +101,11 @@ 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 = all_tags[idx + 1..last_index]
-          else
-            filtered_tags = []
-          end
+          filtered_tags = if idx > 0 && idx < last_index
+                            all_tags[idx + 1..last_index]
+                          else
+                            []
+                          end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
         end

data/lib/github_changelog_generator/helper.rb

@@ -3,14 +3,14 @@ module GitHubChangelogGenerator
   module Helper
     # @return true if the currently running program is a unit test
     def self.test?
-      defined?SpecHelper
+      defined? SpecHelper
     end
 
-    if test?
-      @log ||= Logger.new(nil) # don't show any logs when running tests
-    else
-      @log ||= Logger.new(STDOUT)
-    end
+    @log ||= if test?
+               Logger.new(nil) # don't show any logs when running tests
+             else
+               Logger.new(STDOUT)
+             end
     @log.formatter = proc do |severity, _datetime, _progname, msg|
       string = "#{msg}\n"
 

data/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

data/lib/github_changelog_generator/parser_file.rb

@@ -20,8 +20,8 @@ module GitHubChangelogGenerator
 
     def parse_line!(line)
       key_sym, value = extract_pair(line)
-      value = true if value =~ (/^(true|t|yes|y|1)$/i)
-      value = false if value =~ (/^(false|f|no|n|0)$/i)
+      value = true if value =~ /^(true|t|yes|y|1)$/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]+/, '')}\""

data/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}"

data/lib/github_changelog_generator/version.rb

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

data/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>