github_changelog_generator 1.15.2 → 1.16.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d97ec2074cb54d75216a93b42f41a6216a418c1b0e926ab55a0cb9cb32a09b
-  data.tar.gz: 75faf09151502f8f2d3cd4a15da37b26648ed504d42e3829ad95d1d7c71a9268
+  metadata.gz: 36cb65499e406ed1e554d4239e9d36806888d1ca9c3fe0f47e0e8e49053dd2b9
+  data.tar.gz: 991b1251d601d2504d2c610087b43d0deaebbe7f031987eda8dc5a84e7ac46cb
 SHA512:
-  metadata.gz: 9f6adfd28ffcb632837a9d037b0677f6527b03d6a8c787ab9f65b2981b740e1bd478d0f0b64b76f8fab93d00d101b9b5fb80cb86ba7d722c98b0728534485cfc
-  data.tar.gz: 81ee9e88cd5efa0c8acc60ce9f2a1571ea72fb9d9b096af07236477ff560e7561bd3eef31a3c9b26a5bdd6edba2656fe18b32509a7fbe8e40325f4974a94651a
+  metadata.gz: d5d733ce47da1d762b8dd3c4513989955ecd1adfe973ba044baef80fec2917d621841e9779d97b8298f04cd5b05d64c97d78cc872ba73d9b46ed2db3ae709344
+  data.tar.gz: ecfad19e0066fb2e9ddbdbc6c514f1c86bf57c6ff0704999adc05a181812fc182469ad77ba7d9fdabe1cbf06adff20680df06b0121c35e602c27222cab983106

data/README.md

@@ -39,7 +39,7 @@ To update TOC, please run:
 
 ### Changelog generation has never been so easy
 
-**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub.
 
 Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
 
@@ -73,7 +73,9 @@ or use `sudo gem install github_changelog_generator` (Linux).
 
 ### Running with CLI:
 
-	   github_changelog_generator -u github_username -p github_project
+	   github_changelog_generator -u github_project_namespace -p github_project
+
+(where the project namespace is _likely_ your username if it's a project you own, but it could also be the namespace of the project)
 
 
 ### Running with Docker
@@ -82,11 +84,11 @@ Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative
 
 Example invocation:
 
-    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator
 
 
 
-- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
+- For GitHub Enterprise repos, specify *both* `--github-site` and `--github-api` options:
 
        $ github_changelog_generator --github-site="https://github.yoursite.com" \
                                   --github-api="https://github.yoursite.com/api/v3/"
@@ -318,7 +320,7 @@ Workaround: Create a `C:\tmp`.
 
 ## Contributing
 
-We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
+Would you like to contribute to this project? [CONTRIBUTING.md] has all the details on how to do that.
 
 [CONTRIBUTING.md]: CONTRIBUTING.md
 
@@ -327,4 +329,4 @@ We have collected notes on how to contribute to this project in [CONTRIBUTING.md
 
 ## License
 
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+GitHub Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -13,7 +13,7 @@ RSpec::Core::RakeTask.new
 
 desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
 task :update_ssl_ca_file do
-  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
+  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.se/ca/cacert.pem && popd`
 end
 
 task default: %i[rubocop spec]

data/lib/github_changelog_generator/argv_parser.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "github_changelog_generator/version"
+
+module GitHubChangelogGenerator
+  class ArgvParser
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def parse!(argv)
+      parser.parse(argv)
+    rescue OptionParser::ParseError => e
+      warn [e, parser].join("\n")
+      Kernel.abort
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
+        opts.on("-u", "--user USER", "Username of the owner of the target GitHub repo OR the namespace of target Github repo if owned by an organization.") do |last|
+          options[:user] = last
+        end
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub.") do |last|
+          options[:project] = last
+        end
+        opts.on("-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") do |last|
+          options[:token] = last
+        end
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d.") do |last|
+          options[:date_format] = last
+        end
+        opts.on("-o", "--output NAME", "Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md") do |last|
+          options[:output] = last
+        end
+        opts.on("-b", "--base NAME", "Optional base file to append generated changes to. Default is HISTORY.md") do |last|
+          options[:base] = last
+        end
+        opts.on("--summary-label LABEL", "Set up custom label for the release summary section. Default is \"\".") do |v|
+          options[:summary_prefix] = v
+        end
+        opts.on("--breaking-label LABEL", "Set up custom label for the breaking changes section. Default is \"**Breaking changes:**\".") do |v|
+          options[:breaking_prefix] = v
+        end
+        opts.on("--enhancement-label LABEL", "Set up custom label for enhancements section. Default is \"**Implemented enhancements:**\".") do |v|
+          options[:enhancement_prefix] = v
+        end
+        opts.on("--bugs-label LABEL", "Set up custom label for bug-fixes section. Default is \"**Fixed bugs:**\".") do |v|
+          options[:bug_prefix] = v
+        end
+        opts.on("--deprecated-label LABEL", "Set up custom label for the deprecated changes section. Default is \"**Deprecated:**\".") do |v|
+          options[:deprecated_prefix] = v
+        end
+        opts.on("--removed-label LABEL", "Set up custom label for the removed changes section. Default is \"**Removed:**\".") do |v|
+          options[:removed_prefix] = v
+        end
+        opts.on("--security-label LABEL", "Set up custom label for the security changes section. Default is \"**Security fixes:**\".") do |v|
+          options[:security_prefix] = v
+        end
+        opts.on("--issues-label LABEL", "Set up custom label for closed-issues section. Default is \"**Closed issues:**\".") do |v|
+          options[:issue_prefix] = v
+        end
+        opts.on("--header-label LABEL", "Set up custom header label. Default is \"# Changelog\".") do |v|
+          options[:header] = v
+        end
+        opts.on("--configure-sections HASH, STRING", "Define your own set of sections which overrides all default sections.") do |v|
+          options[:configure_sections] = v
+        end
+        opts.on("--add-sections HASH, STRING", "Add new sections but keep the default sections.") do |v|
+          options[:add_sections] = 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|
+          require "yaml"
+          options[:frontmatter] = "#{JSON.parse(v).to_yaml}---\n"
+        end
+        opts.on("--pr-label LABEL", "Set up 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
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true.") do |v|
+          options[:add_issues_wo_labels] = v
+        end
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true.") do |v|
+          options[:add_pr_wo_labels] = v
+        end
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true.") do |v|
+          options[:pulls] = v
+        end
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true.") do |last|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on("--[no-]issues-of-open-milestones", "Include issues of open milestones. Default is true.") do |v|
+          options[:issues_of_open_milestones] = v
+        end
+        opts.on("--[no-]author", "Add author of pull request at the end. Default is true.") do |author|
+          options[:author] = author
+        end
+        opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
+          options[:usernames_as_github_logins] = v
+        end
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
+          options[:unreleased_only] = v
+        end
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true.") do |v|
+          options[:unreleased] = v
+        end
+        opts.on("--unreleased-label LABEL", "Set up custom label for unreleased closed issues section. Default is \"**Unreleased:**\".") do |v|
+          options[:unreleased_label] = v
+        end
+        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, "Of the labeled issues, only include the ones with the specified labels.") do |list|
+          options[:include_labels] = list
+        end
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.") do |list|
+          options[:exclude_labels] = list
+        end
+        opts.on("--summary-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Release Summary". The section display only body of issues. Default is \'release-summary,summary\'.') do |list|
+          options[:summary_labels] = list
+        end
+        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking changes". Default is \'backwards-incompatible,breaking\'.') do |list|
+          options[:breaking_labels] = list
+        end
+        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'.') do |list|
+          options[:enhancement_labels] = list
+        end
+        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Fixed bugs" section. Default is \'bug,Bug\'.') do |list|
+          options[:bug_labels] = list
+        end
+        opts.on("--deprecated-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Deprecated". Default is \'deprecated,Deprecated\'.') do |list|
+          options[:deprecated_labels] = list
+        end
+        opts.on("--removed-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Removed". Default is \'removed,Removed\'.') do |list|
+          options[:removed_labels] = list
+        end
+        opts.on("--security-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Security fixes". Default is \'security,Security\'.') do |list|
+          options[:security_labels] = list
+        end
+        opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
+          options[:issue_line_labels] = list
+        end
+        opts.on("--include-tags-regex REGEX", "Apply a regular expression on tag names so that they can be included, for example: --include-tags-regex \".*\+\d{1,}\".") do |last|
+          options[:include_tags_regex] = last
+        end
+        opts.on("--exclude-tags  x,y,z", Array, "Changelog will exclude specified tags") do |list|
+          options[:exclude_tags] = list
+        end
+        opts.on("--exclude-tags-regex REGEX", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\".") do |last|
+          options[:exclude_tags_regex] = last
+        end
+        opts.on("--since-tag  x", "Changelog will start after specified tag.") do |v|
+          options[:since_tag] = v
+        end
+        opts.on("--due-tag  x", "Changelog will end before specified tag.") do |v|
+          options[:due_tag] = v
+        end
+        opts.on("--since-commit  x", "Fetch only commits after this time. eg. \"2017-01-01 10:00:00\"") do |v|
+          options[:since_commit] = v
+        end
+        opts.on("--max-issues NUMBER", Integer, "Maximum number of issues to fetch from GitHub. Default is unlimited.") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--release-url URL", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
+          options[:release_url] = url
+        end
+        opts.on("--github-site URL", "The Enterprise GitHub site where your project is hosted.") do |last|
+          options[:github_site] = last
+        end
+        opts.on("--github-api URL", "The enterprise endpoint to use for your GitHub API.") do |last|
+          options[:github_endpoint] = last
+        end
+        opts.on("--simple-list", "Create a simple list from issues and pull requests. Default is false.") do |v|
+          options[:simple_list] = v
+        end
+        opts.on("--future-release RELEASE-VERSION", "Put the unreleased changes in the specified release number.") do |future_release|
+          options[:future_release] = future_release
+        end
+        opts.on("--release-branch RELEASE-BRANCH", "Limit pull requests to the release branch, such as master or release.") do |release_branch|
+          options[:release_branch] = release_branch
+        end
+        opts.on("--[no-]http-cache", "Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.") do |http_cache|
+          options[:http_cache] = http_cache
+        end
+        opts.on("--cache-file CACHE-FILE", "Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.") do |cache_file|
+          options[:cache_file] = cache_file
+        end
+        opts.on("--cache-log CACHE-LOG", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
+          options[:cache_log] = cache_log
+        end
+        opts.on("--config-file CONFIG-FILE", "Path to configuration file. Default is .github_changelog_generator.") do |config_file|
+          options[:config_file] = config_file
+        end
+        opts.on("--ssl-ca-file PATH", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
+          options[:ssl_ca_file] = ssl_ca_file
+        end
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require before generating changelog.") do |paths|
+          options[:require] = paths
+        end
+        opts.on("--[no-]verbose", "Run verbosely. Default is true.") do |v|
+          options[:verbose] = v
+        end
+        opts.on("-v", "--version", "Print version number.") do |_v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on("-h", "--help", "Displays Help.") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    class << self
+      def banner
+        new.parser.banner
+      end
+    end
+  end
+end

data/lib/github_changelog_generator/generator/entry.rb

@@ -40,6 +40,15 @@ module GitHubChangelogGenerator
       @content
     end
 
+    def line_labels_for(issue)
+      labels = if @options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
+
     private
 
     # Creates section objects for this entry.
@@ -72,7 +81,7 @@ module GitHubChangelogGenerator
       end
 
       sections_json.collect do |name, v|
-        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
+        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], body_only: v["body_only"], options: @options)
       end
     end
 
@@ -205,14 +214,5 @@ module GitHubChangelogGenerator
       end
       nil
     end
-
-    def line_labels_for(issue)
-      labels = if @options[:issue_line_labels] == ["ALL"]
-                 issue["labels"]
-               else
-                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
-               end
-      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
-    end
   end
 end

data/lib/github_changelog_generator/generator/generator.rb

@@ -26,6 +26,12 @@ module GitHubChangelogGenerator
   class Generator
     attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags
 
+    CREDIT_LINE = <<~CREDIT
+      \\* *This Changelog was automatically generated \
+      by [github_changelog_generator]\
+      (https://github.com/github-changelog-generator/github-changelog-generator)*
+    CREDIT
+
     # A Generator responsible for all logic, related with changelog generation from ready-to-parse issues
     #
     # Example:
@@ -43,26 +49,21 @@ module GitHubChangelogGenerator
     # @return [String] Generated changelog file
     def compound_changelog
       @options.load_custom_ruby_files
-      fetch_and_filter_tags
-      fetch_issues_and_pr
-
-      log = ""
-      log += @options[:frontmatter] if @options[:frontmatter]
-      log += "#{options[:header]}\n\n"
-
-      log += if @options[:unreleased_only]
-               generate_entry_between_tags(@filtered_tags[0], nil)
-             else
-               generate_entries_for_all_tags
-             end
-
-      log += File.read(@options[:base]) if File.file?(@options[:base])
-
-      credit_line = "\n\n\\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*"
-      log.gsub!(/#{credit_line}(\n)?/, "") # Remove old credit lines
-      log += "#{credit_line}\n"
 
-      @log = log
+      Sync do
+        fetch_and_filter_tags
+        fetch_issues_and_pr
+
+        log = if @options[:unreleased_only]
+                generate_entry_between_tags(@filtered_tags[0], nil)
+              else
+                generate_entries_for_all_tags
+              end
+        log += File.read(@options[:base]) if File.file?(@options[:base])
+        log = remove_old_fixed_string(log)
+        log = insert_fixed_string(log)
+        @log = log
+      end
     end
 
     private
@@ -151,5 +152,26 @@ module GitHubChangelogGenerator
       add_first_occurring_tag_to_prs(@sorted_tags, @pull_requests)
       nil
     end
+
+    # Remove the previously assigned fixed message.
+    # @param log [String] Old lines are fixed
+    def remove_old_fixed_string(log)
+      log.gsub!(/#{Regexp.escape(@options[:frontmatter])}/, "") if @options[:frontmatter]
+      log.gsub!(/#{Regexp.escape(@options[:header])}\n{,2}/, "")
+      log.gsub!(/\n{,2}#{Regexp.escape(CREDIT_LINE)}/, "") # Remove old credit lines
+      log
+    end
+
+    # Add template messages to given string. Previously added
+    # messages of the same wording are removed.
+    # @param log [String]
+    def insert_fixed_string(log)
+      ins = ""
+      ins += @options[:frontmatter] if @options[:frontmatter]
+      ins += "#{@options[:header]}\n\n"
+      log.insert(0, ins)
+      log += "\n\n#{CREDIT_LINE}"
+      log
+    end
   end
 end

data/lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -2,8 +2,6 @@
 
 module GitHubChangelogGenerator
   class Generator
-    MAX_THREAD_NUMBER = 25
-
     # Fetch event for issues and pull requests
     # @return [Array] array of fetched issues
     def fetch_events_for_issues_and_pr
@@ -64,7 +62,7 @@ module GitHubChangelogGenerator
     # @param [Array] prs The PRs to associate.
     # @return [Array] PRs without their merge_commit_sha in a tag.
     def associate_tagged_prs(tags, prs, total)
-      @fetcher.fetch_tag_shas_async(tags)
+      @fetcher.fetch_tag_shas(tags)
 
       i = 0
       prs.reject do |pr|
@@ -106,7 +104,7 @@ module GitHubChangelogGenerator
         i = total - prs_left.count
         prs_left.reject do |pr|
           found = false
-          if pr["events"] && (event = pr["events"].find { |e| e["event"] == "merged" }) && sha_in_release_branch(event["commit_id"])
+          if pr["events"] && (event = pr["events"].find { |e| e["event"] == "merged" }) && sha_in_release_branch?(event["commit_id"])
             found = true
             i += 1
             print("Associating PRs with tags: #{i}/#{total}\r") if @options[:verbose]
@@ -139,7 +137,7 @@ module GitHubChangelogGenerator
             pr["first_occurring_tag"] = oldest_tag["name"]
             found = true
             i += 1
-          elsif sha_in_release_branch(rebased_sha)
+          elsif sha_in_release_branch?(rebased_sha)
             found = true
             i += 1
           else
@@ -197,11 +195,9 @@ module GitHubChangelogGenerator
     #
     # @param [String] sha SHA to check.
     # @return [Boolean] True if SHA is in the branch git history.
-    def sha_in_release_branch(sha)
+    def sha_in_release_branch?(sha)
       branch = @options[:release_branch] || @fetcher.default_branch
-      commits_in_branch = @fetcher.fetch_compare(@fetcher.oldest_commit["sha"], branch)
-      shas_in_branch = commits_in_branch["commits"].collect { |commit| commit["sha"] }
-      shas_in_branch.include?(sha)
+      @fetcher.commits_in_branch(branch).include?(sha)
     end
   end
 end