github_changelog_generator 1.16.3 → 1.17.0

data/lib/github_changelog_generator/octo_fetcher.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require "tmpdir"
-require "retriable"
-require "set"
 require "async"
 require "async/barrier"
 require "async/semaphore"
@@ -60,7 +58,7 @@ module GitHubChangelogGenerator
         end
 
         builder.use Octokit::Response::RaiseError
-        builder.adapter :async_http
+        builder.adapter Faraday.default_adapter
       end
     end
 
@@ -96,12 +94,17 @@ module GitHubChangelogGenerator
     # Fetch all tags from repo
     #
     # @return [Array <Hash>] array of tags
-    def get_all_tags
+    def fetch_all_tags
       print "Fetching tags...\r" if @options[:verbose]
 
       check_github_response { github_fetch_tags }
     end
 
+    def get_all_tags # rubocop:disable Naming/AccessorMethodName
+      warn("[DEPRECATED] GitHubChangelogGenerator::OctoFetcher#get_all_tags is deprecated; use fetch_all_tags instead.")
+      fetch_all_tags
+    end
+
     # Returns the number of pages for a API call
     #
     # @return [Integer] number of pages for this API call in total
@@ -306,12 +309,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
           barrier = Async::Barrier.new
           semaphore = Async::Semaphore.new(MAXIMUM_CONNECTIONS, parent: barrier)
 
+          branch = @options[:release_branch] || default_branch
           if (since_commit = @options[:since_commit])
-            iterate_pages(client, "commits_since", since_commit, parent: semaphore) do |new_commits|
+            iterate_pages(client, "commits_since", since_commit, branch, parent: semaphore) do |new_commits|
               @commits.concat(new_commits)
             end
           else
-            iterate_pages(client, "commits", parent: semaphore) do |new_commits|
+            iterate_pages(client, "commits", branch, parent: semaphore) do |new_commits|
               @commits.concat(new_commits)
             end
           end
@@ -341,7 +345,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     # @param [String] name
     # @return [Array<String>]
     def commits_in_branch(name)
-      @branches ||= client.branches(user_project).map { |branch| [branch[:name], branch] }.to_h
+      @branches ||= lambda do
+        iterate_pages(client, "branches") do |branches|
+          branches_map = branches.to_h { |branch| [branch[:name], branch] }
+          return branches_map if branches_map[name]
+        end
+        {}
+      end.call
 
       if (branch = @branches[name])
         commits_in_tag(branch[:commit][:sha])
@@ -376,9 +386,15 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       queue = [current]
       while queue.any?
         commit = queue.shift
-        # If we've already processed this sha, just grab it's parents from the cache
         if @commits_in_tag_cache.key?(commit[:sha])
+          # If we've already processed this sha in a previous run, just grab
+          # its parents from the cache
           shas.merge(@commits_in_tag_cache[commit[:sha]])
+        elsif shas.include?(commit[:sha])
+          # If we've already processed this sha in the current run, stop there
+          # for the current commit because its parents have already been
+          # queued/processed. Jump to the next queued commit.
+          next
         else
           shas.add(commit[:sha])
           commit[:parents].each do |p|
@@ -456,10 +472,21 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     #
     # @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
     # @param [Proc] block
-    def check_github_response(&block)
-      Retriable.retriable(retry_options, &block)
+    def check_github_response
+      yield
     rescue MovedPermanentlyError => e
       fail_with_message(e, "The repository has moved, update your configuration")
+    rescue Octokit::TooManyRequests => e
+      resets_in = client.rate_limit.resets_in
+      Helper.log.error("#{e.class} #{e.message}; sleeping for #{resets_in}s...")
+
+      if (task = Async::Task.current?)
+        task.sleep(resets_in)
+      else
+        sleep(resets_in)
+      end
+
+      retry
     rescue Octokit::Forbidden => e
       fail_with_message(e, "Exceeded retry limit")
     rescue Octokit::Unauthorized => e
@@ -474,31 +501,6 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       sys_abort(message)
     end
 
-    # Exponential backoff
-    def retry_options
-      {
-        on: [Octokit::Forbidden],
-        tries: MAX_FORBIDDEN_RETRIES,
-        base_interval: sleep_base_interval,
-        multiplier: 1.0,
-        rand_factor: 0.0,
-        on_retry: retry_callback
-      }
-    end
-
-    def sleep_base_interval
-      1.0
-    end
-
-    def retry_callback
-      proc do |exception, try, elapsed_time, next_interval|
-        Helper.log.warn("RETRY - #{exception.class}: '#{exception.message}'")
-        Helper.log.warn("#{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try")
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-        Helper.log.warn(client.rate_limit)
-      end
-    end
-
     # @param [Object] msg
     def sys_abort(msg)
       abort(msg)
@@ -528,7 +530,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       env_var
     end
 
-    # @return [String] helper to return Github "user/project"
+    # @return [String] helper to return GitHub "user/project"
     def user_project
       "#{@options[:user]}/#{@options[:project]}"
     end

data/lib/github_changelog_generator/options.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "delegate"
-require "github_changelog_generator/helper"
+require_relative "helper"
 
 module GitHubChangelogGenerator
   # This class wraps Options, and knows a list of known options. Others options
@@ -145,7 +145,17 @@ module GitHubChangelogGenerator
     #
     # @return [Hash] The GitHub `:token` key is censored in the output.
     def censored_values
-      values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
+      values.clone.tap { |opts| opts[:token] = censored_token(opts[:token]) }
+    end
+
+    def censored_token(opts_token)
+      if !opts_token.nil?
+        "Used token from options"
+      elsif ENV["CHANGELOG_GITHUB_TOKEN"]
+        "Used token from environment variable"
+      else
+        "No token used"
+      end
     end
 
     def unsupported_options

data/lib/github_changelog_generator/parser.rb

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "github_changelog_generator/helper"
-require "github_changelog_generator/argv_parser"
-require "github_changelog_generator/parser_file"
+require_relative "helper"
+require_relative "argv_parser"
+require_relative "parser_file"
+require_relative "file_parser_chooser"
 
 module GitHubChangelogGenerator
   class Parser

data/lib/github_changelog_generator/parser_file.rb

@@ -1,32 +1,8 @@
 # frozen_string_literal: true
 
-require "pathname"
-
 module GitHubChangelogGenerator
   ParserError = Class.new(StandardError)
 
-  class FileParserChooser
-    def initialize(options)
-      @options     = options
-      @config_file = Pathname.new(options[:config_file])
-    end
-
-    def parse!(_argv)
-      return nil unless (path = resolve_path)
-
-      ParserFile.new(@options, File.open(path)).parse!
-    end
-
-    def resolve_path
-      return @config_file if @config_file.exist?
-
-      path = @config_file.expand_path
-      return path if File.exist?(path)
-
-      nil
-    end
-  end
-
   # ParserFile is a configuration file reader which sets options in the
   # given Hash.
   #

data/lib/github_changelog_generator/reader.rb

@@ -29,7 +29,7 @@ module GitHubChangelogGenerator
       defaults = {
         heading_level: "##",
         heading_structures: [
-          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
+          /^## \[(?<version>.+?)\](\((?<url>.+?)\))?( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
           /^## (?<version>.+?)( \((?<date>.+?)\))?$/ # rubocop:disable Lint/MixedRegexpCaptureTypes
         ]
       }
@@ -45,6 +45,8 @@ module GitHubChangelogGenerator
     # The following heading structures are currently valid:
     # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
     # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
+    # - ## [v1.0.2] (2015-03-24)
+    # - ## [v1.0.2]
     # - ## v1.0.2 (2015-03-24)
     # - ## v1.0.2
     #

data/lib/github_changelog_generator/ssl_certs/cacert.pem

@@ -1,7 +1,7 @@
 ##
 ## Bundle of CA Root Certificates
 ##
-## Certificate data from Mozilla as of: Tue Apr 13 03:12:04 2021 GMT
+## Certificate data from Mozilla as of: Tue May 25 03:12:05 2021 GMT
 ##
 ## This is a bundle of X.509 certificates of public Certificate Authorities
 ## (CA). These were automatically extracted from Mozilla's root certificates
@@ -14,7 +14,7 @@
 ## Just configure this file as the SSLCACertificateFile.
 ##
 ## Conversion done with mk-ca-bundle.pl version 1.28.
-## SHA256: f377673fa3c22ba2188a4cea041c7b8c99a4817ffde6821e98325ce89324e5aa
+## SHA256: e292bd4e2d500c86df45b830d89417be5c42ee670408f1d2c454c63d8a782865
 ##
 
 
@@ -893,82 +893,6 @@ Q0iy2+tzJOeRf1SktoA+naM8THLCV8Sg1Mw4J87VBp6iSNnpn86CcDaTmjvfliHjWbcM2pE38P1Z
 WrOZyGlsQyYBNWNgVYkDOnXYukrZVP/u3oDYLdE41V4tC5h9Pmzb/CaIxw==
 -----END CERTIFICATE-----
 
-Chambers of Commerce Root - 2008
-================================
------BEGIN CERTIFICATE-----
-MIIHTzCCBTegAwIBAgIJAKPaQn6ksa7aMA0GCSqGSIb3DQEBBQUAMIGuMQswCQYDVQQGEwJFVTFD
-MEEGA1UEBxM6TWFkcmlkIChzZWUgY3VycmVudCBhZGRyZXNzIGF0IHd3dy5jYW1lcmZpcm1hLmNv
-bS9hZGRyZXNzKTESMBAGA1UEBRMJQTgyNzQzMjg3MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMu
-QS4xKTAnBgNVBAMTIENoYW1iZXJzIG9mIENvbW1lcmNlIFJvb3QgLSAyMDA4MB4XDTA4MDgwMTEy
-Mjk1MFoXDTM4MDczMTEyMjk1MFowga4xCzAJBgNVBAYTAkVVMUMwQQYDVQQHEzpNYWRyaWQgKHNl
-ZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LmNhbWVyZmlybWEuY29tL2FkZHJlc3MpMRIwEAYDVQQF
-EwlBODI3NDMyODcxGzAZBgNVBAoTEkFDIENhbWVyZmlybWEgUy5BLjEpMCcGA1UEAxMgQ2hhbWJl
-cnMgb2YgQ29tbWVyY2UgUm9vdCAtIDIwMDgwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoIC
-AQCvAMtwNyuAWko6bHiUfaN/Gh/2NdW928sNRHI+JrKQUrpjOyhYb6WzbZSm891kDFX29ufyIiKA
-XuFixrYp4YFs8r/lfTJqVKAyGVn+H4vXPWCGhSRv4xGzdz4gljUha7MI2XAuZPeEklPWDrCQiorj
-h40G072QDuKZoRuGDtqaCrsLYVAGUvGef3bsyw/QHg3PmTA9HMRFEFis1tPo1+XqxQEHd9ZR5gN/
-ikilTWh1uem8nk4ZcfUyS5xtYBkL+8ydddy/Js2Pk3g5eXNeJQ7KXOt3EgfLZEFHcpOrUMPrCXZk
-NNI5t3YRCQ12RcSprj1qr7V9ZS+UWBDsXHyvfuK2GNnQm05aSd+pZgvMPMZ4fKecHePOjlO+Bd5g
-D2vlGts/4+EhySnB8esHnFIbAURRPHsl18TlUlRdJQfKFiC4reRB7noI/plvg6aRArBsNlVq5331
-lubKgdaX8ZSD6e2wsWsSaR6s+12pxZjptFtYer49okQ6Y1nUCyXeG0+95QGezdIp1Z8XGQpvvwyQ
-0wlf2eOKNcx5Wk0ZN5K3xMGtr/R5JJqyAQuxr1yW84Ay+1w9mPGgP0revq+ULtlVmhduYJ1jbLhj
-ya6BXBg14JC7vjxPNyK5fuvPnnchpj04gftI2jE9K+OJ9dC1vX7gUMQSibMjmhAxhduub+84Mxh2
-EQIDAQABo4IBbDCCAWgwEgYDVR0TAQH/BAgwBgEB/wIBDDAdBgNVHQ4EFgQU+SSsD7K1+HnA+mCI
-G8TZTQKeFxkwgeMGA1UdIwSB2zCB2IAU+SSsD7K1+HnA+mCIG8TZTQKeFxmhgbSkgbEwga4xCzAJ
-BgNVBAYTAkVVMUMwQQYDVQQHEzpNYWRyaWQgKHNlZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LmNh
-bWVyZmlybWEuY29tL2FkZHJlc3MpMRIwEAYDVQQFEwlBODI3NDMyODcxGzAZBgNVBAoTEkFDIENh
-bWVyZmlybWEgUy5BLjEpMCcGA1UEAxMgQ2hhbWJlcnMgb2YgQ29tbWVyY2UgUm9vdCAtIDIwMDiC
-CQCj2kJ+pLGu2jAOBgNVHQ8BAf8EBAMCAQYwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUH
-AgEWHGh0dHA6Ly9wb2xpY3kuY2FtZXJmaXJtYS5jb20wDQYJKoZIhvcNAQEFBQADggIBAJASryI1
-wqM58C7e6bXpeHxIvj99RZJe6dqxGfwWPJ+0W2aeaufDuV2I6A+tzyMP3iU6XsxPpcG1Lawk0lgH
-3qLPaYRgM+gQDROpI9CF5Y57pp49chNyM/WqfcZjHwj0/gF/JM8rLFQJ3uIrbZLGOU8W6jx+ekbU
-RWpGqOt1glanq6B8aBMz9p0w8G8nOSQjKpD9kCk18pPfNKXG9/jvjA9iSnyu0/VU+I22mlaHFoI6
-M6taIgj3grrqLuBHmrS1RaMFO9ncLkVAO+rcf+g769HsJtg1pDDFOqxXnrN2pSB7+R5KBWIBpih1
-YJeSDW4+TTdDDZIVnBgizVGZoCkaPF+KMjNbMMeJL0eYD6MDxvbxrN8y8NmBGuScvfaAFPDRLLmF
-9dijscilIeUcE5fuDr3fKanvNFNb0+RqE4QGtjICxFKuItLcsiFCGtpA8CnJ7AoMXOLQusxI0zcK
-zBIKinmwPQN/aUv0NCB9szTqjktk9T79syNnFQ0EuPAtwQlRPLJsFfClI9eDdOTlLsn+mCdCxqvG
-nrDQWzilm1DefhiYtUU79nm06PcaewaD+9CL2rvHvRirCG88gGtAPxkZumWK5r7VXNM21+9AUiRg
-OGcEMeyP84LG3rlV8zsxkVrctQgVrXYlCg17LofiDKYGvCYQbTed7N14jHyAxfDZd0jQ
------END CERTIFICATE-----
-
-Global Chambersign Root - 2008
-==============================
------BEGIN CERTIFICATE-----
-MIIHSTCCBTGgAwIBAgIJAMnN0+nVfSPOMA0GCSqGSIb3DQEBBQUAMIGsMQswCQYDVQQGEwJFVTFD
-MEEGA1UEBxM6TWFkcmlkIChzZWUgY3VycmVudCBhZGRyZXNzIGF0IHd3dy5jYW1lcmZpcm1hLmNv
-bS9hZGRyZXNzKTESMBAGA1UEBRMJQTgyNzQzMjg3MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMu
-QS4xJzAlBgNVBAMTHkdsb2JhbCBDaGFtYmVyc2lnbiBSb290IC0gMjAwODAeFw0wODA4MDExMjMx
-NDBaFw0zODA3MzExMjMxNDBaMIGsMQswCQYDVQQGEwJFVTFDMEEGA1UEBxM6TWFkcmlkIChzZWUg
-Y3VycmVudCBhZGRyZXNzIGF0IHd3dy5jYW1lcmZpcm1hLmNvbS9hZGRyZXNzKTESMBAGA1UEBRMJ
-QTgyNzQzMjg3MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMuQS4xJzAlBgNVBAMTHkdsb2JhbCBD
-aGFtYmVyc2lnbiBSb290IC0gMjAwODCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMDf
-VtPkOpt2RbQT2//BthmLN0EYlVJH6xedKYiONWwGMi5HYvNJBL99RDaxccy9Wglz1dmFRP+RVyXf
-XjaOcNFccUMd2drvXNL7G706tcuto8xEpw2uIRU/uXpbknXYpBI4iRmKt4DS4jJvVpyR1ogQC7N0
-ZJJ0YPP2zxhPYLIj0Mc7zmFLmY/CDNBAspjcDahOo7kKrmCgrUVSY7pmvWjg+b4aqIG7HkF4ddPB
-/gBVsIdU6CeQNR1MM62X/JcumIS/LMmjv9GYERTtY/jKmIhYF5ntRQOXfjyGHoiMvvKRhI9lNNgA
-TH23MRdaKXoKGCQwoze1eqkBfSbW+Q6OWfH9GzO1KTsXO0G2Id3UwD2ln58fQ1DJu7xsepeY7s2M
-H/ucUa6LcL0nn3HAa6x9kGbo1106DbDVwo3VyJ2dwW3Q0L9R5OP4wzg2rtandeavhENdk5IMagfe
-Ox2YItaswTXbo6Al/3K1dh3ebeksZixShNBFks4c5eUzHdwHU1SjqoI7mjcv3N2gZOnm3b2u/GSF
-HTynyQbehP9r6GsaPMWis0L7iwk+XwhSx2LE1AVxv8Rk5Pihg+g+EpuoHtQ2TS9x9o0o9oOpE9Jh
-wZG7SMA0j0GMS0zbaRL/UJScIINZc+18ofLx/d33SdNDWKBWY8o9PeU1VlnpDsogzCtLkykPAgMB
-AAGjggFqMIIBZjASBgNVHRMBAf8ECDAGAQH/AgEMMB0GA1UdDgQWBBS5CcqcHtvTbDprru1U8VuT
-BjUuXjCB4QYDVR0jBIHZMIHWgBS5CcqcHtvTbDprru1U8VuTBjUuXqGBsqSBrzCBrDELMAkGA1UE
-BhMCRVUxQzBBBgNVBAcTOk1hZHJpZCAoc2VlIGN1cnJlbnQgYWRkcmVzcyBhdCB3d3cuY2FtZXJm
-aXJtYS5jb20vYWRkcmVzcykxEjAQBgNVBAUTCUE4Mjc0MzI4NzEbMBkGA1UEChMSQUMgQ2FtZXJm
-aXJtYSBTLkEuMScwJQYDVQQDEx5HbG9iYWwgQ2hhbWJlcnNpZ24gUm9vdCAtIDIwMDiCCQDJzdPp
-1X0jzjAOBgNVHQ8BAf8EBAMCAQYwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUHAgEWHGh0
-dHA6Ly9wb2xpY3kuY2FtZXJmaXJtYS5jb20wDQYJKoZIhvcNAQEFBQADggIBAICIf3DekijZBZRG
-/5BXqfEv3xoNa/p8DhxJJHkn2EaqbylZUohwEurdPfWbU1Rv4WCiqAm57OtZfMY18dwY6fFn5a+6
-ReAJ3spED8IXDneRRXozX1+WLGiLwUePmJs9wOzL9dWCkoQ10b42OFZyMVtHLaoXpGNR6woBrX/s
-dZ7LoR/xfxKxueRkf2fWIyr0uDldmOghp+G9PUIadJpwr2hsUF1Jz//7Dl3mLEfXgTpZALVza2Mg
-9jFFCDkO9HB+QHBaP9BrQql0PSgvAm11cpUJjUhjxsYjV5KTXjXBjfkK9yydYhz2rXzdpjEetrHH
-foUm+qRqtdpjMNHvkzeyZi99Bffnt0uYlDXA2TopwZ2yUDMdSqlapskD7+3056huirRXhOukP9Du
-qqqHW2Pok+JrqNS4cnhrG+055F3Lm6qH1U9OAP7Zap88MQ8oAgF9mOinsKJknnn4SPIVqczmyETr
-P3iZ8ntxPjzxmKfFGBI/5rsoM0LpRQp8bfKGeS/Fghl9CYl8slR2iK7ewfPM4W7bMdaTrpmg7yVq
-c5iJWzouE4gev8CSlDQb4ye3ix5vQv/n6TebUB0tovkC7stYWDpxvGjjqsGvHCgfotwjZT+B6q6Z
-09gwzxMNTxXJhLynSC34MCN32EZLeW32jO06f2ARePTpm67VVMB0gNELQp/B
------END CERTIFICATE-----
-
 Go Daddy Root Certificate Authority - G2
 ========================================
 -----BEGIN CERTIFICATE-----

data/lib/github_changelog_generator/task.rb

@@ -58,10 +58,10 @@ module GitHubChangelogGenerator
 
         log = generator.compound_changelog
 
-        output_filename = (options[:output]).to_s
+        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}"
+        puts "Generated log placed in #{File.absolute_path(output_filename)}"
       end
     end
   end

data/lib/github_changelog_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHubChangelogGenerator
-  VERSION = "1.16.3"
+  VERSION = "1.17.0"
 end

data/lib/github_changelog_generator.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require "octokit"
@@ -7,16 +6,15 @@ require "logger"
 require "active_support"
 require "active_support/core_ext/object/blank"
 require "json"
-require "multi_json"
 require "benchmark"
 
-require "github_changelog_generator/helper"
-require "github_changelog_generator/options"
-require "github_changelog_generator/parser"
-require "github_changelog_generator/parser_file"
-require "github_changelog_generator/generator/generator"
-require "github_changelog_generator/version"
-require "github_changelog_generator/reader"
+require_relative "github_changelog_generator/helper"
+require_relative "github_changelog_generator/options"
+require_relative "github_changelog_generator/parser"
+require_relative "github_changelog_generator/parser_file"
+require_relative "github_changelog_generator/generator/generator"
+require_relative "github_changelog_generator/version"
+require_relative "github_changelog_generator/reader"
 
 # The main module, where placed all classes (now, at least)
 module GitHubChangelogGenerator
@@ -24,24 +22,28 @@ module GitHubChangelogGenerator
   class ChangelogGenerator
     # Class, responsible for whole changelog generation cycle
     # @return initialised instance of ChangelogGenerator
-    def initialize
-      @options = Parser.parse_options
-      @generator = Generator.new @options
+    def initialize(params = ARGV)
+      @options = Parser.parse_options(params)
+      @generator = Generator.new(@options)
     end
 
     # The entry point of this script to generate changelog
     # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
     def run
-      log = @generator.compound_changelog
+      log = generator.compound_changelog
 
-      if @options.write_to_file?
-        output_filename = @options[:output].to_s
+      if options.write_to_file?
+        output_filename = options[:output].to_s
         File.open(output_filename, "wb") { |file| file.write(log) }
         puts "Done!"
-        puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+        puts "Generated log placed in #{File.absolute_path(output_filename)}"
       else
         puts log
       end
     end
+
+    private
+
+    attr_reader :generator, :options
   end
 end

data/man/git-generate-changelog.html

@@ -206,11 +206,11 @@
 
 <p>   --github-site URL</p>
 
-<p>   The Enterprise Github site on which your project is hosted.</p>
+<p>   The Enterprise GitHub site on which your project is hosted.</p>
 
 <p>   --github-api URL</p>
 
-<p>   The enterprise endpoint to use for your Github API.</p>
+<p>   The enterprise endpoint to use for your GitHub API.</p>
 
 <p>   --simple-list</p>
 

data/spec/github_changelog_generator_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe GitHubChangelogGenerator::ChangelogGenerator do
+  describe "#run" do
+    let(:arguments) { [] }
+    let(:instance)  { described_class.new(arguments) }
+    let(:output_path) { File.join(__dir__, "tmp", "test.output") }
+
+    after { FileUtils.rm_rf(output_path) }
+
+    let(:generator) { instance_double(::GitHubChangelogGenerator::Generator) }
+
+    before do
+      allow(instance).to receive(:generator) { generator }
+      allow(generator).to receive(:compound_changelog) { "content" }
+    end
+
+    context "when full path given as the --output argument" do
+      let(:arguments) { ["--output", output_path]  }
+      it "puts the complete output path to STDOUT" do
+        expect { instance.run }.to output(Regexp.new(output_path)).to_stdout
+      end
+    end
+
+    context "when empty value given as the --output argument" do
+      let(:arguments) { ["--output", ""] }
+      it "puts the complete output path to STDOUT" do
+        expect { instance.run }.to output(/content/).to_stdout
+      end
+    end
+  end
+end

data/spec/unit/generator/entry_spec.rb

@@ -120,7 +120,7 @@ module GitHubChangelogGenerator
 
       let(:pull_requests) do
         [
-          pr("no labels", [], "",  "20", "login" => "user1"),
+          pr("no labels", [], "", "20", "login" => "user1"),
           pr("breaking", ["breaking"], "", "23", "login" => "user5"),
           pr("enhancement", ["enhancement"], "",  "21", "login" => "user5"),
           pr("bug", ["bug"], "", "22", "login" => "user5"),
@@ -129,7 +129,7 @@ module GitHubChangelogGenerator
           pr("security", ["security"], "", "30", "login" => "user5"),
           pr("all the labels", %w[breaking enhancement bug deprecated removed security], "", "24", "login" => "user5"),
           pr("all the labels different order", %w[bug breaking enhancement security remove deprecated], "", "25", "login" => "user5"),
-          pr("some unmapped labels", %w[tests-fail bug], "",  "26", "login" => "user5"),
+          pr("some unmapped labels", %w[tests-fail bug], "", "26", "login" => "user5"),
           pr("no mapped labels", %w[docs maintenance], "", "27", "login" => "user5")
         ]
       end

data/spec/unit/generator/generator_processor_spec.rb

@@ -137,6 +137,67 @@ module GitHubChangelogGenerator
           it { is_expected.to eq(expected_issues) }
         end
       end
+
+      describe "#find_issues_to_add" do
+        let(:issues) { [issue] }
+        let(:tag_name) { nil }
+        let(:filtered_tags) { [] }
+        before { generator.instance_variable_set(:@filtered_tags, filtered_tags) }
+
+        subject { generator.find_issues_to_add(issues, tag_name) }
+
+        context "issue without milestone" do
+          let(:issue) { { "labels" => [] } }
+
+          it { is_expected.to be_empty }
+        end
+
+        context "milestone title not in the filtered tags" do
+          let(:issue) { { "milestone" => { "title" => "a title" } } }
+          let(:filtered_tags) { [{ "name" => "another name" }] }
+
+          it { is_expected.to be_empty }
+        end
+
+        context "milestone title matches the tag name" do
+          let(:tag_name) { "tag name" }
+          let(:issue) { { "milestone" => { "title" => tag_name } } }
+          let(:filtered_tags) { [{ "name" => tag_name }] }
+
+          it { is_expected.to contain_exactly(issue) }
+        end
+      end
+
+      describe "#remove_issues_in_milestones" do
+        let(:issues) { [issue] }
+
+        context "issue without milestone" do
+          let(:issue) { { "labels" => [] } }
+
+          it "is not filtered" do
+            expect { generator.remove_issues_in_milestones(issues) }.to_not(change { issues })
+          end
+        end
+
+        context "remove issues of open milestones if option is set" do
+          let(:issue) { { "milestone" => { "state" => "open" } } }
+          let(:options) { { issues_of_open_milestones: false } }
+
+          it "is filtered" do
+            expect { generator.remove_issues_in_milestones(issues) }.to change { issues }.to([])
+          end
+        end
+
+        context "milestone in the tag list" do
+          let(:milestone_name) { "milestone name" }
+          let(:issue) { { "milestone" => { "title" => milestone_name } } }
+
+          it "is filtered" do
+            generator.instance_variable_set(:@filtered_tags, [{ "name" => milestone_name }])
+            expect { generator.remove_issues_in_milestones(issues) }.to change { issues }.to([])
+          end
+        end
+      end
     end
   end
 end