RubyGems - github_changelog_generator - Versions diffs - 1.16.1 → 1.16.2 - Mend

github_changelog_generator 1.16.1 → 1.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

checksums.yaml +4 -4
data/README.md +1 -1
data/lib/github_changelog_generator/argv_parser.rb +224 -0
data/lib/github_changelog_generator/generator/generator_fetcher.rb +4 -5
data/lib/github_changelog_generator/generator/generator_processor.rb +2 -1
data/lib/github_changelog_generator/octo_fetcher.rb +21 -4
data/lib/github_changelog_generator/options.rb +1 -0
data/lib/github_changelog_generator/parser.rb +70 -258
data/lib/github_changelog_generator/parser_file.rb +28 -13
data/lib/github_changelog_generator/ssl_certs/cacert.pem +851 -1680
data/lib/github_changelog_generator/version.rb +1 -1
data/man/git-generate-changelog.1 +31 -31
data/man/git-generate-changelog.1.html +30 -30
data/man/git-generate-changelog.html +19 -19
data/man/git-generate-changelog.md +31 -31
data/spec/files/config_example +5 -0
data/spec/unit/parser_spec.rb +50 -0
metadata +5 -2

data/lib/github_changelog_generator/version.rb CHANGED Viewed

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

data/man/git-generate-changelog.1 CHANGED Viewed

@@ -13,115 +13,115 @@
 Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
 .
 .SH "OPTIONS"
-\-u, \-\-user [USER]
+\-u, \-\-user USER
 .
 .P
 Username of the owner of target GitHub repo\.
 .
 .P
-\-p, \-\-project [PROJECT]
+\-p, \-\-project PROJECT
 .
 .P
 Name of project on GitHub\.
 .
 .P
-\-t, \-\-token [TOKEN]
+\-t, \-\-token TOKEN
 .
 .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
-\-f, \-\-date\-format [FORMAT]
+\-f, \-\-date\-format FORMAT
 .
 .P
 Date format\. Default is %Y\-%m\-%d\.
 .
 .P
-\-o, \-\-output [NAME]
+\-o, \-\-output NAME
 .
 .P
 Output file\. To print to STDOUT instead, use blank as path\. Default is CHANGELOG\.md\.
 .
 .P
-\-b, \-\-base [NAME]
+\-b, \-\-base NAME
 .
 .P
-Optional base file to append generated changes to\.
+Optional base file to append generated changes to\. Default is HISTORY\.md\.
 .
 .P
-\-\-summary\-label [LABEL]
+\-\-summary\-label LABEL
 .
 .P
 Set up custom label for the release summary section\. Default is ""\.
 .
 .P
-\-\-breaking\-label [LABEL]
+\-\-breaking\-label LABEL
 .
 .P
 Set up custom label for breaking changes section\. Default is "\fBBreaking changes:\fR"\.
 .
 .P
-\-\-enhancement\-label [LABEL]
+\-\-enhancement\-label LABEL
 .
 .P
 Set up custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"\.
 .
 .P
-\-\-bugs\-label [LABEL]
+\-\-bugs\-label LABEL
 .
 .P
 Set up custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR"\.
 .
 .P
-\-\-deprecated\-label [LABEL]
+\-\-deprecated\-label LABEL
 .
 .P
 Set up custom label for deprecated section\. Default is "\fBDeprecated:\fR"\.
 .
 .P
-\-\-removed\-label [LABEL]
+\-\-removed\-label LABEL
 .
 .P
 Set up custom label for removed section\. Default is "\fBRemoved:\fR"\.
 .
 .P
-\-\-security\-label [LABEL]
+\-\-security\-label LABEL
 .
 .P
 Set up custom label for security section\. Default is "\fBSecurity:\fR"\.
 .
 .P
-\-\-issues\-label [LABEL]
+\-\-issues\-label LABEL
 .
 .P
 Set up custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"\.
 .
 .P
-\-\-header\-label [LABEL]
+\-\-header\-label LABEL
 .
 .P
 Set up custom header label\. Default is "# Changelog"\.
 .
 .P
-\-\-configure\-sections [HASH, STRING]
+\-\-configure\-sections HASH, STRING
 .
 .P
 Define your own set of sections which overrides all default sections\.
 .
 .P
-\-\-add\-sections [HASH, STRING]
+\-\-add\-sections HASH, STRING
 .
 .P
 Add new sections but keep the default sections\.
 .
 .P
-\-\-front\-matter [JSON]
+\-\-front\-matter JSON
 .
 .P
 Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line\.
 .
 .P
-\-\-pr\-label [LABEL]
+\-\-pr\-label LABEL
 .
 .P
 Set up custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"\.
@@ -187,7 +187,7 @@ Generate log from unreleased closed issues only\.
 Add to log unreleased closed issues\. Default is true\.
 .
 .P
-\-\-unreleased\-label [label]
+\-\-unreleased\-label LABEL
 .
 .P
 Set up custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"\.
@@ -265,7 +265,7 @@ The specified labels will be shown in brackets next to each matching issue\. Use
 Changelog will exclude specified tags\.
 .
 .P
-\-\-exclude\-tags\-regex [REGEX]
+\-\-exclude\-tags\-regex REGEX
 .
 .P
 Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"\.
@@ -289,25 +289,25 @@ Changelog will end before specified tag\.
 Fetch only commits after this time\. eg\. "2017\-01\-01 10:00:00"
 .
 .P
-\-\-max\-issues [NUMBER]
+\-\-max\-issues NUMBER
 .
 .P
 Maximum number of issues to fetch from GitHub\. Default is unlimited\.
 .
 .P
-\-\-release\-url [URL]
+\-\-release\-url URL
 .
 .P
 The URL to point to for release links, in printf format (with the tag as variable)\.
 .
 .P
-\-\-github\-site [URL]
+\-\-github\-site URL
 .
 .P
 The Enterprise GitHub site where your project is hosted\.
 .
 .P
-\-\-github\-api [URL]
+\-\-github\-api URL
 .
 .P
 The enterprise endpoint to use for your GitHub API\.
@@ -319,13 +319,13 @@ The enterprise endpoint to use for your GitHub API\.
 Create a simple list from issues and pull requests\. Default is false\.
 .
 .P
-\-\-future\-release [RELEASE\-VERSION]
+\-\-future\-release RELEASE\-VERSION
 .
 .P
 Put the unreleased changes in the specified release number\.
 .
 .P
-\-\-release\-branch [RELEASE\-BRANCH]
+\-\-release\-branch RELEASE\-BRANCH
 .
 .P
 Limit pull requests to the release branch, such as master or release\.
@@ -337,19 +337,19 @@ Limit pull requests to the release branch, such as master or release\.
 Use HTTP Cache to cache GitHub API requests (useful for large repos)\. Default is true\.
 .
 .P
-\-\-[no\-]cache\-file [CACHE\-FILE]
+\-\-[no\-]cache\-file CACHE\-FILE
 .
 .P
 Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
 .
 .P
-\-\-cache\-log [CACHE\-LOG]
+\-\-cache\-log CACHE\-LOG
 .
 .P
 Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
 .P
-\-\-ssl\-ca\-file [PATH]
+\-\-ssl\-ca\-file PATH
 .
 .P
 Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.

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

@@ -85,79 +85,79 @@
 <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. To print to STDOUT instead, use blank as path. 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>  --summary-label [LABEL]</p>
+<p>  --summary-label LABEL</p>
 <p>  Set up custom label for the release summary section. Default is "".</p>
-<p>  --breaking-label [LABEL]</p>
+<p>  --breaking-label LABEL</p>
 <p>  Set up custom label for breaking changes section. Default is "<strong>Breaking changes:</strong>".</p>
-<p>  --enhancement-label [LABEL]</p>
+<p>  --enhancement-label LABEL</p>
 <p>  Set up custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>".</p>
-<p>  --bugs-label [LABEL]</p>
+<p>  --bugs-label LABEL</p>
 <p>  Set up custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong>".</p>
-<p>  --deprecated-label [LABEL]</p>
+<p>  --deprecated-label LABEL</p>
 <p>  Set up custom label for deprecated section. Default is "<strong>Deprecated:</strong>".</p>
-<p>  --removed-label [LABEL]</p>
+<p>  --removed-label LABEL</p>
 <p>  Set up custom label for removed section. Default is "<strong>Removed:</strong>".</p>
-<p>  --security-label [LABEL]</p>
+<p>  --security-label LABEL</p>
 <p>  Set up custom label for security section. Default is "<strong>Security:</strong>".</p>
-<p>  --issues-label [LABEL]</p>
+<p>  --issues-label LABEL</p>
 <p>  Set up custom label for closed-issues section. Default is "<strong>Closed issues:</strong>".</p>
-<p>  --header-label [LABEL]</p>
+<p>  --header-label LABEL</p>
 <p>  Set up custom header label. Default is "# Changelog".</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.</p>
-<p>  --add-sections [HASH, STRING]</p>
+<p>  --add-sections HASH, STRING</p>
 <p>  Add new sections but keep the default sections.</p>
-<p>  --front-matter [JSON]</p>
+<p>  --front-matter JSON</p>
 <p>  Add YAML front matter. Formatted as JSON because it's easier to add on the command line.</p>
-<p>  --pr-label [LABEL]</p>
+<p>  --pr-label LABEL</p>
 <p>  Set up custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>".</p>
@@ -201,7 +201,7 @@
 <p>  Add to log unreleased closed issues. Default is true.</p>
-<p>  --unreleased-label [label]</p>
+<p>  --unreleased-label LABEL</p>
 <p>  Set up custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>".</p>
@@ -253,7 +253,7 @@
 <p>  Changelog will exclude specified tags.</p>
-<p>  --exclude-tags-regex [REGEX]</p>
+<p>  --exclude-tags-regex REGEX</p>
 <p>  Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}".</p>
@@ -269,19 +269,19 @@
 <p>  Fetch only commits after this time. eg. "2017-01-01 10:00:00"</p>
-<p>  --max-issues [NUMBER]</p>
+<p>  --max-issues NUMBER</p>
 <p>  Maximum 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 where 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>
@@ -289,11 +289,11 @@
 <p>  Create a 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>  --release-branch [RELEASE-BRANCH]</p>
+<p>  --release-branch RELEASE-BRANCH</p>
 <p>  Limit pull requests to the release branch, such as master or release.</p>
@@ -301,15 +301,15 @@
 <p>  Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.</p>
-<p>  --[no-]cache-file [CACHE-FILE]</p>
+<p>  --[no-]cache-file CACHE-FILE</p>
 <p>  Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
-<p>  --cache-log [CACHE-LOG]</p>
+<p>  --cache-log CACHE-LOG</p>
 <p>  Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
-<p>  --ssl-ca-file [PATH]</p>
+<p>  --ssl-ca-file PATH</p>
 <p>  Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>

data/man/git-generate-changelog.html CHANGED Viewed

@@ -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>