github_changelog_generator 1.15.0 → 1.16.3

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.0"
+  VERSION = "1.16.3"
 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
@@ -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"\.
@@ -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
@@ -181,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"\.
@@ -259,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,}"\.
@@ -277,25 +283,31 @@ Changelog will start after specified tag\.
 Changelog will end before specified tag\.
 .
 .P
-\-\-max\-issues [NUMBER]
+\-\-since\-commit x
+.
+.P
+Fetch only commits after this time\. eg\. "2017\-01\-01 10:00:00"
+.
+.P
+\-\-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\.
@@ -307,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\.
@@ -325,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\.
@@ -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

@@ -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>
 
@@ -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>
@@ -197,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>
 
@@ -249,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>
 
@@ -261,19 +265,23 @@
 
 <p>  Changelog will end before specified tag.</p>
 
-<p>  --max-issues [NUMBER]</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>
 
-<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>
 
@@ -281,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>
 
@@ -293,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>
 
@@ -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>