github_changelog_generator 1.15.2 → 1.16.0

data/lib/github_changelog_generator/options.rb

@@ -37,6 +37,7 @@ module GitHubChangelogGenerator
       exclude_tags
       exclude_tags_regex
       filter_issues_by_milestone
+      issues_of_open_milestones
       frontmatter
       future_release
       github_endpoint
@@ -44,6 +45,7 @@ module GitHubChangelogGenerator
       header
       http_cache
       include_labels
+      include_tags_regex
       issue_prefix
       issue_line_labels
       issue_line_body
@@ -62,6 +64,7 @@ module GitHubChangelogGenerator
       security_prefix
       simple_list
       since_tag
+      since_commit
       ssl_ca_file
       summary_labels
       summary_prefix

data/lib/github_changelog_generator/parser.rb

@@ -37,7 +37,7 @@ module GitHubChangelogGenerator
     def self.setup_parser(options)
       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 target GitHub repo.") do |last|
+        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|
@@ -89,7 +89,7 @@ module GitHubChangelogGenerator
           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|
-          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
+          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
@@ -109,6 +109,9 @@ module GitHubChangelogGenerator
         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
@@ -157,6 +160,9 @@ module GitHubChangelogGenerator
         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
@@ -169,6 +175,9 @@ module GitHubChangelogGenerator
         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
@@ -230,6 +239,7 @@ module GitHubChangelogGenerator
         add_pr_wo_labels: true,
         pulls: true,
         filter_issues_by_milestone: true,
+        issues_of_open_milestones: true,
         author: true,
         unreleased: true,
         unreleased_label: "Unreleased",

data/lib/github_changelog_generator/parser_file.rb

@@ -56,7 +56,7 @@ module GitHubChangelogGenerator
 
     # Returns true if the line starts with a pound sign or a semi-colon.
     def non_configuration_line?(line)
-      line =~ /^[\#;]/ || line =~ /^[\s]+$/
+      line =~ /^[\#;]/ || line =~ /^\s+$/
     end
 
     # Returns a the option name as a symbol and its string value sans newlines.

data/lib/github_changelog_generator/reader.rb

@@ -29,8 +29,8 @@ module GitHubChangelogGenerator
       defaults = {
         heading_level: "##",
         heading_structures: [
-          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
-          /^## (?<version>.+?)( \((?<date>.+?)\))?$/
+          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
+          /^## (?<version>.+?)( \((?<date>.+?)\))?$/ # rubocop:disable Lint/MixedRegexpCaptureTypes
         ]
       }
 

data/lib/github_changelog_generator/task.rb

@@ -15,11 +15,11 @@ module GitHubChangelogGenerator
                   pulls filter_issues_by_milestone author
                   unreleased_only unreleased unreleased_label
                   compare_link include_labels exclude_labels
-                  bug_labels enhancement_labels
+                  bug_labels enhancement_labels include_tags_regex
                   between_tags exclude_tags exclude_tags_regex since_tag max_issues
                   github_site github_endpoint simple_list
                   future_release release_branch verbose release_url
-                  base configure_sections add_sections]
+                  base configure_sections add_sections http_cache]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -31,6 +31,7 @@ module GitHubChangelogGenerator
     #
     #   GitHubChangelogGenerator::RakeTask.new
     def initialize(*args, &task_block)
+      super
       @name = args.shift || :changelog
 
       define(args, &task_block)

data/lib/github_changelog_generator/version.rb

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

data/man/git-generate-changelog.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "May 2018" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "May 2020" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from GitHub
@@ -157,6 +157,12 @@ Include pull\-requests in changelog\. Default is true\.
 Use milestone to detect when issue was resolved\. Default is true\.
 .
 .P
+\-\-[no\-]issues\-of\-open\-milestones
+.
+.P
+Include issues of open milestones\. Default is true\.
+.
+.P
 \-\-[no\-]author
 .
 .P
@@ -277,6 +283,12 @@ Changelog will start after specified tag\.
 Changelog will end before specified tag\.
 .
 .P
+\-\-since\-commit x
+.
+.P
+Fetch only commits after this time\. eg\. "2017\-01\-01 10:00:00"
+.
+.P
 \-\-max\-issues [NUMBER]
 .
 .P
@@ -375,7 +387,7 @@ GitHub pull requests that have been merged whose merge commit SHA has been modif
 Written by Petr Korolev sky4winder@gmail\.com
 .
 .SH "REPORTING BUGS"
-<\fIhttps://github\.com/github-changelog-generator/github\-changelog\-generator/issues\fR>
+<\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/issues\fR>
 .
 .SH "SEE ALSO"
-<\fIhttps://github\.com/github-changelog-generator/github\-changelog\-generator/\fR>
+<\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/\fR>

data/man/git-generate-changelog.1.html

@@ -181,6 +181,10 @@
 
 <p>  Use milestone to detect when issue was resolved. Default is true.</p>
 
+<p>  --[no-]issues-of-open-milestones</p>
+
+<p>  Include issues of open milestones. Default is true.</p>
+
 <p>  --[no-]author</p>
 
 <p>  Add author of pull request at the end. Default is true.</p>
@@ -261,6 +265,10 @@
 
 <p>  Changelog will end before specified tag.</p>
 
+<p>  --since-commit x</p>
+
+<p>  Fetch only commits after this time. eg. "2017-01-01 10:00:00"</p>
+
 <p>  --max-issues [NUMBER]</p>
 
 <p>  Maximum number of issues to fetch from GitHub. Default is unlimited.</p>
@@ -342,7 +350,7 @@
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>May 2018</li>
+    <li class='tc'>May 2020</li>
     <li class='tr'>git-generate-changelog(1)</li>
   </ol>
 

data/man/git-generate-changelog.md

@@ -107,6 +107,10 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Use milestone to detect when issue was resolved. Default is true.
 
+  --[no-]issues-of-open-milestones
+
+  Include issues of open milestones. Default is true.
+
   --[no-]author
 
   Add author of pull request at the end. Default is true.
@@ -187,6 +191,10 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Changelog will end before specified tag.
 
+  --since-commit x
+  
+  Fetch only commits after this time. eg. "2017-01-01 10:00:00"
+
   --max-issues [NUMBER]
 
   Maximum number of issues to fetch from GitHub. Default is unlimited.

data/spec/spec_helper.rb

@@ -44,7 +44,7 @@ VCR.configure do |c|
     decode_compressed_response: true
   }
   c.filter_sensitive_data("<GITHUB_TOKEN>") do
-    "token #{ENV.fetch('CHANGELOG_GITHUB_TOKEN') { 'frobnitz' }}"
+    "token #{ENV.fetch('CHANGELOG_GITHUB_TOKEN', 'frobnitz')}"
   end
 
   c.configure_rspec_metadata!

data/spec/unit/generator/entry_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ModuleLength
 module GitHubChangelogGenerator
   RSpec.describe Entry do
     def label(name)
@@ -58,9 +57,6 @@ module GitHubChangelogGenerator
     let(:issues) { [] }
     let(:pull_requests) { [] }
     let(:tags) { [] }
-    let(:compare_shas) do
-      { "aaaaa1...master" => ["aaaaa1"] }
-    end
 
     # Default to standard options minus verbose to avoid output during testing.
     let(:options) do
@@ -76,15 +72,14 @@ module GitHubChangelogGenerator
         fetch_closed_issues_and_pr: [issues, pull_requests],
         fetch_closed_pull_requests: [],
         fetch_events_async: issues + pull_requests,
-        fetch_tag_shas_async: nil,
+        fetch_tag_shas: nil,
         fetch_comments_async: nil,
         default_branch: "master",
         oldest_commit: { "sha" => "aaaaa1" },
         fetch_commit: { "commit" => { "author" => { "date" => Time.now.utc } } }
       )
-      allow(fake_fetcher).to receive(:fetch_compare) do |old, new|
-        # Comparisons has a "commits" key of an array of commit hashes each with a "sha" key.
-        { "commits" => compare_shas["#{old}...#{new}"].collect { |sha| { "sha" => sha } } }
+      allow(fake_fetcher).to receive(:commits_in_branch) do
+        ["aaaaa1"]
       end
       allow(GitHubChangelogGenerator::OctoFetcher).to receive(:new).and_return(fake_fetcher)
       generator = GitHubChangelogGenerator::Generator.new(options)
@@ -426,6 +421,18 @@ module GitHubChangelogGenerator
             sections_json.shift
           end
         end
+        context "parse also body_only" do
+          let(:sections_string) { "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"], \"body_only\": true}}" }
+
+          it "returns correctly constructed sections" do
+            require "json"
+
+            parsed_sections = subject.send(:parse_sections, sections_string)
+
+            expect(parsed_sections[0].body_only).to eq false
+            expect(parsed_sections[1].body_only).to eq true
+          end
+        end
       end
       context "hash" do
         let(:sections_hash) do
@@ -548,14 +555,14 @@ module GitHubChangelogGenerator
         end
 
         it "assigns issues to the correct sections" do
-          breaking_section = entry_sections.select { |section| section.name == "breaking" }[0]
-          enhancement_section = entry_sections.select { |section| section.name == "enhancements" }[0]
-          bug_section = entry_sections.select { |section| section.name == "bugs" }[0]
-          deprecated_section = entry_sections.select { |section| section.name == "deprecated" }[0]
-          removed_section = entry_sections.select { |section| section.name == "removed" }[0]
-          security_section = entry_sections.select { |section| section.name == "security" }[0]
-          issue_section = entry_sections.select { |section| section.name == "issues" }[0]
-          merged_section = entry_sections.select { |section| section.name == "merged" }[0]
+          breaking_section = entry_sections.find { |section| section.name == "breaking" }
+          enhancement_section = entry_sections.find { |section| section.name == "enhancements" }
+          bug_section = entry_sections.find { |section| section.name == "bugs" }
+          deprecated_section = entry_sections.find { |section| section.name == "deprecated" }
+          removed_section = entry_sections.find { |section| section.name == "removed" }
+          security_section = entry_sections.find { |section| section.name == "security" }
+          issue_section = entry_sections.find { |section| section.name == "issues" }
+          merged_section = entry_sections.find { |section| section.name == "merged" }
 
           expect(titles_for(breaking_section.issues)).to eq(["issue breaking", "issue all the labels", "pr breaking", "pr all the labels"])
           expect(titles_for(enhancement_section.issues)).to eq(["issue enhancement", "pr enhancement"])
@@ -612,10 +619,10 @@ module GitHubChangelogGenerator
         end
 
         it "assigns issues to the correct sections" do
-          foo_section = entry_sections.select { |section| section.name == "foo" }[0]
-          bar_section = entry_sections.select { |section| section.name == "bar" }[0]
-          issue_section = entry_sections.select { |section| section.name == "issues" }[0]
-          merged_section = entry_sections.select { |section| section.name == "merged" }[0]
+          foo_section = entry_sections.find { |section| section.name == "foo" }
+          bar_section = entry_sections.find { |section| section.name == "bar" }
+          issue_section = entry_sections.find { |section| section.name == "issues" }
+          merged_section = entry_sections.find { |section| section.name == "merged" }
 
           aggregate_failures "checks all sections" do
             expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "issue some included labels", "pr test1", "pr all the labels", "pr some included labels"])
@@ -670,10 +677,10 @@ module GitHubChangelogGenerator
         end
 
         it "assigns issues to the correct sections" do
-          foo_section = entry_sections.select { |section| section.name == "foo" }[0]
-          bar_section = entry_sections.select { |section| section.name == "bar" }[0]
-          issue_section = entry_sections.select { |section| section.name == "issues" }[0]
-          merged_section = entry_sections.select { |section| section.name == "merged" }[0]
+          foo_section = entry_sections.find { |section| section.name == "foo" }
+          bar_section = entry_sections.find { |section| section.name == "bar" }
+          issue_section = entry_sections.find { |section| section.name == "issues" }
+          merged_section = entry_sections.find { |section| section.name == "merged" }
 
           aggregate_failures "checks all sections" do
             expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
@@ -737,12 +744,12 @@ module GitHubChangelogGenerator
         end
 
         it "assigns issues to the correct sections" do
-          foo_section = entry_sections.select { |section| section.name == "foo" }[0]
-          breaking_section = entry_sections.select { |section| section.name == "breaking" }[0]
-          enhancement_section = entry_sections.select { |section| section.name == "enhancements" }[0]
-          bug_section = entry_sections.select { |section| section.name == "bugs" }[0]
-          issue_section = entry_sections.select { |section| section.name == "issues" }[0]
-          merged_section = entry_sections.select { |section| section.name == "merged" }[0]
+          foo_section = entry_sections.find { |section| section.name == "foo" }
+          breaking_section = entry_sections.find { |section| section.name == "breaking" }
+          enhancement_section = entry_sections.find { |section| section.name == "enhancements" }
+          bug_section = entry_sections.find { |section| section.name == "bugs" }
+          issue_section = entry_sections.find { |section| section.name == "issues" }
+          merged_section = entry_sections.find { |section| section.name == "merged" }
 
           aggregate_failures "checks all sections" do
             expect(titles_for(breaking_section.issues)).to eq(["issue all the labels", "pr all the labels"])
@@ -757,4 +764,3 @@ module GitHubChangelogGenerator
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/spec/unit/generator/generator_processor_spec.rb

@@ -5,82 +5,137 @@ module GitHubChangelogGenerator
     let(:default_options) { GitHubChangelogGenerator::Parser.default_options.merge(verbose: false) }
     let(:options) { {} }
     let(:generator) { described_class.new(default_options.merge(options)) }
-
     let(:bad_label) { { "name" => "BAD" } }
-    let(:bad_issue) { { "labels" => [bad_label] } }
     let(:good_label) { { "name" => "GOOD" } }
-    let(:good_issue) { { "labels" => [good_label] } }
-    let(:unlabeled_issue) { { "labels" => [] } }
-    let(:issues) { [bad_issue, good_issue, unlabeled_issue] }
 
-    describe "#exclude_issues_by_labels" do
-      subject do
-        generator.exclude_issues_by_labels(issues)
-      end
+    describe "pull requests" do
+      let(:bad_pull_request) { { "pull_request" => {}, "labels" => [bad_label] } }
+      let(:good_pull_request) { { "pull_request" => {}, "labels" => [good_label] } }
+      let(:unlabeled_pull_request) { { "pull_request" => {}, "labels" => [] } }
+      let(:pull_requests) { [bad_pull_request, good_pull_request, unlabeled_pull_request] }
 
-      let(:expected_issues) { issues }
+      describe "#filter_wo_labels" do
+        subject do
+          generator.filter_wo_labels(pull_requests)
+        end
 
-      it { is_expected.to eq(expected_issues) }
+        let(:expected_pull_requests) { pull_requests }
 
-      context "when 'exclude_lables' is provided" do
-        let(:options) { { exclude_labels: %w[BAD BOO] } }
-        let(:expected_issues) { [good_issue, unlabeled_issue] }
+        it { is_expected.to eq(expected_pull_requests) }
 
-        it { is_expected.to eq(expected_issues) }
-      end
+        context "when 'add_pr_wo_labels' is false" do
+          let(:options) { { add_pr_wo_labels: false } }
+          let(:expected_pull_requests) { [bad_pull_request, good_pull_request] }
 
-      context "with no option given" do
-        subject(:generator) { described_class.new }
-        it "passes everything through when no option given" do
-          result = generator.exclude_issues_by_labels(issues)
+          it { is_expected.to eq(expected_pull_requests) }
+        end
+
+        context "when 'add_pr_wo_labels' is true" do
+          let(:options) { { add_pr_wo_labels: true } }
 
-          expect(result).to eq(issues)
+          it { is_expected.to eq(expected_pull_requests) }
         end
       end
     end
 
-    describe "#get_filtered_issues" do
-      subject do
-        generator.get_filtered_issues(issues)
-      end
+    describe "issues" do
+      let(:bad_issue) { { "labels" => [bad_label] } }
+      let(:good_issue) { { "labels" => [good_label] } }
+      let(:unlabeled_issue) { { "labels" => [] } }
+      let(:issues) { [bad_issue, good_issue, unlabeled_issue] }
 
-      let(:expected_issues) { issues }
-
-      it { is_expected.to eq(expected_issues) }
+      describe "#filter_wo_labels" do
+        subject do
+          generator.filter_wo_labels(issues)
+        end
 
-      context "when 'exclude_labels' is provided" do
-        let(:options) { { exclude_labels: %w[BAD BOO] } }
-        let(:expected_issues) { [good_issue, unlabeled_issue] }
+        let(:expected_issues) { issues }
 
         it { is_expected.to eq(expected_issues) }
+
+        context "when 'add_issues_wo_labels' is false" do
+          let(:options) { { add_issues_wo_labels: false } }
+          let(:expected_issues) { [bad_issue, good_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+        end
+
+        context "when 'add_issues_wo_labels' is true" do
+          let(:options) { { add_issues_wo_labels: true } }
+
+          it { is_expected.to eq(expected_issues) }
+        end
       end
 
-      context "when 'add_issues_wo_labels' is false" do
-        let(:options) { { add_issues_wo_labels: false } }
-        let(:expected_issues) { [bad_issue, good_issue] }
+      describe "#exclude_issues_by_labels" do
+        subject do
+          generator.exclude_issues_by_labels(issues)
+        end
+
+        let(:expected_issues) { issues }
 
         it { is_expected.to eq(expected_issues) }
 
-        context "with 'exclude_labels'" do
-          let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
-          let(:expected_issues) { [bad_issue] }
+        context "when 'exclude_labels' is provided" do
+          let(:options) { { exclude_labels: %w[BAD BOO] } }
+          let(:expected_issues) { [good_issue, unlabeled_issue] }
 
           it { is_expected.to eq(expected_issues) }
         end
 
-        context "with 'include_labels'" do
-          let(:options) { { add_issues_wo_labels: false, include_labels: %w[GOOD] } }
-          let(:expected_issues) { [good_issue] }
+        context "with no option given" do
+          subject(:generator) { described_class.new }
+          it "passes everything through when no option given" do
+            result = generator.exclude_issues_by_labels(issues)
 
-          it { is_expected.to eq(expected_issues) }
+            expect(result).to eq(issues)
+          end
         end
       end
 
-      context "when 'include_labels' is specified" do
-        let(:options) { { include_labels: %w[GOOD] } }
-        let(:expected_issues) { [good_issue, unlabeled_issue] }
+      describe "#get_filtered_issues" do
+        subject do
+          generator.get_filtered_issues(issues)
+        end
+
+        let(:expected_issues) { issues }
 
         it { is_expected.to eq(expected_issues) }
+
+        context "when 'exclude_labels' is provided" do
+          let(:options) { { exclude_labels: %w[BAD BOO] } }
+          let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+        end
+
+        context "when 'add_issues_wo_labels' is false" do
+          let(:options) { { add_issues_wo_labels: false } }
+          let(:expected_issues) { [bad_issue, good_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+
+          context "with 'exclude_labels'" do
+            let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
+            let(:expected_issues) { [bad_issue] }
+
+            it { is_expected.to eq(expected_issues) }
+          end
+
+          context "with 'include_labels'" do
+            let(:options) { { add_issues_wo_labels: false, include_labels: %w[GOOD] } }
+            let(:expected_issues) { [good_issue] }
+
+            it { is_expected.to eq(expected_issues) }
+          end
+        end
+
+        context "when 'include_labels' is specified" do
+          let(:options) { { include_labels: %w[GOOD] } }
+          let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+        end
       end
     end
   end