github_changelog_generator 1.16.1 → 1.16.2

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:**".
 
@@ -127,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:**".
 
@@ -179,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,}".
 
@@ -195,19 +195,19 @@ Automatically generate changelog from your tags, issues, labels and pull request
   
   Fetch only commits after this time. eg. "2017-01-01 10:00:00"
 
-  --max-issues [NUMBER]
+  --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.
 
@@ -215,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.
 
@@ -227,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/unit/parser_spec.rb

@@ -1,4 +1,54 @@
 # frozen_string_literal: true
 
 describe GitHubChangelogGenerator::Parser do
+  let(:argv) { [] }
+
+  before do
+    # Calling abort will abort the test run, allow calls to abort to not accidentaly get positive falses
+    allow(Kernel).to receive(:abort)
+  end
+
+  describe ".parse_options" do
+    context "when required arguments are given" do
+      let(:argv) { ["--user", "the user", "--project", "the_project"] }
+
+      it "executes and prints the configuration" do
+        expect { described_class.parse_options(argv) }.to output(/config_file=>".github_changelog_generator"/).to_stdout
+      end
+    end
+
+    context "when --config-file is overridden to something that is not there" do
+      let(:argv) { ["--config-file", "does_not_exist"] }
+
+      it "aborts the execution" do
+        expect(Kernel).to receive(:abort)
+        expect { described_class.parse_options(argv) }.to output(/Configure which user and project to work on./).to_stderr
+      end
+    end
+
+    context "when an option with incorrect type is given" do
+      let(:argv) { ["--max-issues", "X"] }
+
+      it "aborts the execution with error message from parser" do
+        expect(Kernel).to receive(:abort)
+        expect { described_class.parse_options(argv) }.to output(/invalid argument: --max-issues X/).to_stderr
+      end
+    end
+
+    context "when path to configuration file is given" do
+      let(:argv) { ["--config-file", File.join(__dir__, "..", "files", "config_example")] }
+
+      it "uses the values from the configuration file" do
+        expect { described_class.parse_options(argv) }.to output(/spec_project/).to_stdout
+      end
+    end
+
+    context "when configuration file and parameters are given" do
+      let(:argv) { ["--project", "stronger_project", "--config-file", File.join(__dir__, "..", "files", "config_example")] }
+
+      it "uses the values from the arguments" do
+        expect { described_class.parse_options(argv) }.to output(/stronger_project/).to_stdout
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.16.2
 platform: ruby
 authors:
 - Petr Korolev
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -154,6 +154,7 @@ files:
 - bin/git-generate-changelog
 - bin/github_changelog_generator
 - lib/github_changelog_generator.rb
+- lib/github_changelog_generator/argv_parser.rb
 - lib/github_changelog_generator/generator/entry.rb
 - lib/github_changelog_generator/generator/generator.rb
 - lib/github_changelog_generator/generator/generator_fetcher.rb
@@ -175,6 +176,7 @@ files:
 - man/git-generate-changelog.md
 - spec/files/angular.js.md
 - spec/files/bundler.md
+- spec/files/config_example
 - spec/files/github-changelog-generator.md
 - spec/install_gem_in_bundler.gemfile
 - spec/spec_helper.rb
@@ -237,6 +239,7 @@ summary: Script, that automatically generate changelog from your tags, issues, l
 test_files:
 - spec/files/angular.js.md
 - spec/files/bundler.md
+- spec/files/config_example
 - spec/files/github-changelog-generator.md
 - spec/install_gem_in_bundler.gemfile
 - spec/spec_helper.rb