github_changelog_generator 1.15.0 → 1.16.3

data/man/git-generate-changelog.html

@@ -84,47 +84,47 @@
 
 <h2 id="OPTIONS">OPTIONS</h2>
 
-<p>  -u, --user [USER]</p>
+<p>  -u, --user USER</p>
 
 <p>  Username of the owner of target GitHub repo</p>
 
-<p>  -p, --project [PROJECT]</p>
+<p>  -p, --project PROJECT</p>
 
 <p>  Name of project on GitHub</p>
 
-<p>  -t, --token [TOKEN]</p>
+<p>  -t, --token TOKEN</p>
 
 <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>
 
-<p>  -f, --date-format [FORMAT]</p>
+<p>  -f, --date-format FORMAT</p>
 
 <p>  Date format. Default is %Y-%m-%d</p>
 
-<p>  -o, --output [NAME]</p>
+<p>  -o, --output NAME</p>
 
 <p>  Output file. Default is CHANGELOG.md</p>
 
-<p>  -b, --base [NAME]</p>
+<p>  -b, --base NAME</p>
 
 <p>  Optional base file to append generated changes to.</p>
 
-<p>   --bugs-label [LABEL]</p>
+<p>   --bugs-label LABEL</p>
 
 <p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
 
-<p>   --enhancement-label [LABEL]</p>
+<p>   --enhancement-label LABEL</p>
 
 <p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
 
-<p>   --issues-label [LABEL]</p>
+<p>   --issues-label LABEL</p>
 
 <p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
 
-<p>   --header-label [LABEL]</p>
+<p>   --header-label LABEL</p>
 
 <p>   Setup custom header label. Default is "# Changelog"</p>
 
-<p>   --pr-label [LABEL]</p>
+<p>   --pr-label LABEL</p>
 
 <p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
 
@@ -160,7 +160,7 @@
 
 <p>   Add to log unreleased closed issues. Default is true</p>
 
-<p>   --unreleased-label [label]</p>
+<p>   --unreleased-label LABEL</p>
 
 <p>   Add to log unreleased closed issues. Default is true</p>
 
@@ -196,19 +196,19 @@
 
 <p>   Changelog will end before specified tag</p>
 
-<p>   --max-issues [NUMBER]</p>
+<p>   --max-issues NUMBER</p>
 
 <p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
 
-<p>   --release-url [URL]</p>
+<p>   --release-url URL</p>
 
 <p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
 
-<p>   --github-site [URL]</p>
+<p>   --github-site URL</p>
 
 <p>   The Enterprise Github site on which your project is hosted.</p>
 
-<p>   --github-api [URL]</p>
+<p>   --github-api URL</p>
 
 <p>   The enterprise endpoint to use for your Github API.</p>
 
@@ -216,15 +216,15 @@
 
 <p>   Create simple list from issues and pull requests. Default is false.</p>
 
-<p>   --future-release [RELEASE-VERSION]</p>
+<p>   --future-release RELEASE-VERSION</p>
 
 <p>   Put the unreleased changes in the specified release number.</p>
 
-<p>   --configure-sections [HASH, STRING]</p>
+<p>   --configure-sections HASH, STRING</p>
 
 <p>   Define your own set of sections which overrides all default sections") do |v|</p>
 
-<p>   --add-sections [HASH, STRING]</p>
+<p>   --add-sections HASH, STRING</p>
 
 <p>   Add new sections but keep the default sections"</p>
 

data/man/git-generate-changelog.md

@@ -11,79 +11,79 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
 ## OPTIONS
 
-  -u, --user [USER]
+  -u, --user USER
 
   Username of the owner of target GitHub repo.
 
-  -p, --project [PROJECT]
+  -p, --project PROJECT
 
   Name of project on GitHub.
 
-  -t, --token [TOKEN]
+  -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]
+  -f, --date-format FORMAT
 
   Date format. Default is %Y-%m-%d.
 
-  -o, --output [NAME]
+  -o, --output NAME
 
   Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.
 
-  -b, --base [NAME]
+  -b, --base NAME
 
-  Optional base file to append generated changes to.
+  Optional base file to append generated changes to. Default is HISTORY.md.
 
-  --summary-label [LABEL]
+  --summary-label LABEL
 
   Set up custom label for the release summary section. Default is "".
 
-  --breaking-label [LABEL]
+  --breaking-label LABEL
 
   Set up custom label for breaking changes section. Default is "**Breaking changes:**".
 
-  --enhancement-label [LABEL]
+  --enhancement-label LABEL
 
   Set up custom label for enhancements section. Default is "**Implemented enhancements:**".
 
-  --bugs-label [LABEL]
+  --bugs-label LABEL
 
   Set up custom label for bug-fixes section. Default is "**Fixed bugs:**".
 
-  --deprecated-label [LABEL]
+  --deprecated-label LABEL
 
   Set up custom label for deprecated section. Default is "**Deprecated:**".
 
-  --removed-label [LABEL]
+  --removed-label LABEL
 
   Set up custom label for removed section. Default is "**Removed:**".
 
-  --security-label [LABEL]
+  --security-label LABEL
 
   Set up custom label for security section. Default is "**Security:**".
 
-  --issues-label [LABEL]
+  --issues-label LABEL
 
   Set up custom label for closed-issues section. Default is "**Closed issues:**".
 
-  --header-label [LABEL]
+  --header-label LABEL
 
   Set up custom header label. Default is "# Changelog".
 
-  --configure-sections [HASH, STRING]
+  --configure-sections HASH, STRING
 
   Define your own set of sections which overrides all default sections.
 
-  --add-sections [HASH, STRING]
+  --add-sections HASH, STRING
 
   Add new sections but keep the default sections.
 
-  --front-matter [JSON]
+  --front-matter JSON
 
   Add YAML front matter. Formatted as JSON because it's easier to add on the command line.
 
-  --pr-label [LABEL]
+  --pr-label LABEL
 
   Set up custom label for pull requests section. Default is "**Merged pull requests:**".
 
@@ -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.
@@ -123,7 +127,7 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Add to log unreleased closed issues. Default is true.
 
-  --unreleased-label [label]
+  --unreleased-label LABEL
 
   Set up custom label for unreleased closed issues section. Default is "**Unreleased:**".
 
@@ -175,7 +179,7 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Changelog will exclude specified tags.
 
-  --exclude-tags-regex [REGEX]
+  --exclude-tags-regex REGEX
 
   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}".
 
@@ -187,19 +191,23 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Changelog will end before specified tag.
 
-  --max-issues [NUMBER]
+  --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.
 
-  --release-url [URL]
+  --release-url URL
 
   The URL to point to for release links, in printf format (with the tag as variable).
 
-  --github-site [URL]
+  --github-site URL
 
   The Enterprise GitHub site where your project is hosted.
 
-  --github-api [URL]
+  --github-api URL
 
   The enterprise endpoint to use for your GitHub API.
 
@@ -207,11 +215,11 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Create a simple list from issues and pull requests. Default is false.
 
-  --future-release [RELEASE-VERSION]
+  --future-release RELEASE-VERSION
 
   Put the unreleased changes in the specified release number.
 
-  --release-branch [RELEASE-BRANCH]
+  --release-branch RELEASE-BRANCH
 
   Limit pull requests to the release branch, such as master or release.
 
@@ -219,15 +227,15 @@ Automatically generate changelog from your tags, issues, labels and pull request
 
   Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.
 
-  --[no-]cache-file [CACHE-FILE]
+  --[no-]cache-file CACHE-FILE
 
   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
 
-  --cache-log [CACHE-LOG]
+  --cache-log CACHE-LOG
 
   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
 
-  --ssl-ca-file [PATH]
+  --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.
 

data/spec/files/config_example

@@ -0,0 +1,5 @@
+user=spec_user
+project=spec_project
+unreleased=false
+future-release=5.0.0
+since-tag=1.0.0

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