github_changelog_generator 1.15.0.pre.rc → 1.16.2

data/lib/github_changelog_generator/task.rb

@@ -10,17 +10,16 @@ module GitHubChangelogGenerator
 
     OPTIONS = %w[ user project token date_format output
                   bug_prefix enhancement_prefix issue_prefix
-                  breaking_labels issue_line_labels
                   header merge_prefix issues
                   add_issues_wo_labels add_pr_wo_labels
                   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 ]
+                  base configure_sections add_sections http_cache]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -32,13 +31,14 @@ module GitHubChangelogGenerator
     #
     #   GitHubChangelogGenerator::RakeTask.new
     def initialize(*args, &task_block)
+      super()
       @name = args.shift || :changelog
 
       define(args, &task_block)
     end
 
     def define(args, &task_block)
-      desc "Generate a Change log from GitHub"
+      desc "Generate a Changelog from GitHub"
 
       yield(*[self, args].slice(0, task_block.arity)) if task_block
 

data/lib/github_changelog_generator/version.rb

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

data/man/git-generate-changelog.1

@@ -1,124 +1,172 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2017" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "May 2020" "" ""
 .
 .SH "NAME"
-\fBgit\-generate\-changelog\fR \- Generate changelog from github
+\fBgit\-generate\-changelog\fR \- Generate changelog from GitHub
 .
 .SH "SYNOPSIS"
 \fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
 .
 .SH "DESCRIPTION"
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
+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
+Username of the owner of target GitHub repo\.
 .
 .P
-\-p, \-\-project [PROJECT]
+\-p, \-\-project PROJECT
 .
 .P
-Name of project on GitHub
+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
+Date format\. Default is %Y\-%m\-%d\.
 .
 .P
-\-o, \-\-output [NAME]
+\-o, \-\-output NAME
 .
 .P
-Output file\. Default is CHANGELOG\.md
+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
-\-\-bugs\-label [LABEL]
+\-\-summary\-label LABEL
 .
 .P
-Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
+Set up custom label for the release summary section\. Default is ""\.
 .
 .P
-\-\-enhancement\-label [LABEL]
+\-\-breaking\-label LABEL
 .
 .P
-Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
+Set up custom label for breaking changes section\. Default is "\fBBreaking changes:\fR"\.
 .
 .P
-\-\-issues\-label [LABEL]
+\-\-enhancement\-label LABEL
 .
 .P
-Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
+Set up custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"\.
 .
 .P
-\-\-header\-label [LABEL]
+\-\-bugs\-label LABEL
 .
 .P
-Setup custom header label\. Default is "# Change Log"
+Set up custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR"\.
 .
 .P
-\-\-front\-matter [JSON]
+\-\-deprecated\-label LABEL
 .
 .P
-Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
+Set up custom label for deprecated section\. Default is "\fBDeprecated:\fR"\.
 .
 .P
-\-\-pr\-label [LABEL]
+\-\-removed\-label LABEL
 .
 .P
-Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
+Set up custom label for removed section\. Default is "\fBRemoved:\fR"\.
+.
+.P
+\-\-security\-label LABEL
+.
+.P
+Set up custom label for security section\. Default is "\fBSecurity:\fR"\.
+.
+.P
+\-\-issues\-label LABEL
+.
+.P
+Set up custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"\.
+.
+.P
+\-\-header\-label LABEL
+.
+.P
+Set up custom header label\. Default is "# Changelog"\.
+.
+.P
+\-\-configure\-sections HASH, STRING
+.
+.P
+Define your own set of sections which overrides all default sections\.
+.
+.P
+\-\-add\-sections HASH, STRING
+.
+.P
+Add new sections but keep the default sections\.
+.
+.P
+\-\-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
+.
+.P
+Set up custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"\.
 .
 .P
 \-\-[no\-]issues
 .
 .P
-Include closed issues in changelog\. Default is true
+Include closed issues in changelog\. Default is true\.
 .
 .P
 \-\-[no\-]issues\-wo\-labels
 .
 .P
-Include closed issues without labels in changelog\. Default is true
+Include closed issues without labels in changelog\. Default is true\.
 .
 .P
 \-\-[no\-]pr\-wo\-labels
 .
 .P
-Include pull requests without labels in changelog\. Default is true
+Include pull requests without labels in changelog\. Default is true\.
 .
 .P
 \-\-[no\-]pull\-requests
 .
 .P
-Include pull\-requests in changelog\. Default is true
+Include pull\-requests in changelog\. Default is true\.
 .
 .P
 \-\-[no\-]filter\-by\-milestone
 .
 .P
-Use milestone to detect when issue was resolved\. 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
-Add author of pull\-request in the end\. Default is true
+Add author of pull request at the end\. Default is true\.
 .
 .P
 \-\-usernames\-as\-github\-logins
@@ -136,137 +184,172 @@ Generate log from unreleased closed issues only\.
 \-\-[no\-]unreleased
 .
 .P
-Add to log unreleased closed issues\. Default is true
+Add to log unreleased closed issues\. Default is true\.
 .
 .P
-\-\-unreleased\-label [label]
+\-\-unreleased\-label LABEL
 .
 .P
-Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
+Set up custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"\.
 .
 .P
 \-\-[no\-]compare\-link
 .
 .P
-Include compare link (Full Changelog) between older version and newer version\. Default is true
+Include compare link (Full Changelog) between older version and newer version\. Default is true\.
 .
 .P
 \-\-include\-labels x,y,z
 .
 .P
-Only issues with the specified labels will be included in the changelog\.
+Of the labeled issues, only include the ones with the specified labels\.
 .
 .P
 \-\-exclude\-labels x,y,z
 .
 .P
-Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
+Issues with the specified labels will be excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'\.
 .
 .P
-\-\-bug\-labels x,y,z
+\-\-summary\-labels x,y,z
 .
 .P
-Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
+Issues with these labels will be added to a new section, called "Release Summary"\. The section display only body of issues\. Default is \'Release summary,release\-summary,Summary,summary\'\.
+.
+.P
+\-\-breaking\-labels x,y,z
+.
+.P
+Issues with these labels will be added to a new section, called "Breaking changes"\. Default is \'backwards\-incompatible,breaking\'\.
 .
 .P
 \-\-enhancement\-labels x,y,z
 .
 .P
-Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
+Issues with the specified labels will be added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'\.
+.
+.P
+\-\-bug\-labels x,y,z
+.
+.P
+Issues with the specified labels will be added to "Fixed bugs" section\. Default is \'bug,Bug\'\.
+.
+.P
+\-\-deprecated\-labels x,y,z
+.
+.P
+Issues with the specified labels will be added to a section called "Deprecated"\. Default is \'deprecated,Deprecated\'\.
+.
+.P
+\-\-removed\-labels x,y,z
+.
+.P
+Issues with the specified labels will be added to a section called "Removed"\. Default is \'removed,Removed\'\.
+.
+.P
+\-\-security\-labels x,y,z
+.
+.P
+Issues with the specified labels will be added to a section called "Security fixes"\. Default is \'security,Security\'\.
+.
+.P
+\-\-issue\-line\-labels x,y,z
+.
+.P
+The specified labels will be shown in brackets next to each matching issue\. Use "ALL" to show all labels\. Default is []\.
 .
 .P
 \-\-exclude\-tags x,y,z
 .
 .P
-Change log will exclude specified tags
+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,}"
+Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"\.
 .
 .P
 \-\-since\-tag x
 .
 .P
-Change log will start after specified tag
+Changelog will start after specified tag\.
 .
 .P
 \-\-due\-tag x
 .
 .P
-Change log will end before 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]
+\-\-max\-issues NUMBER
 .
 .P
-Max number of issues to fetch from GitHub\. Default is unlimited
+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 on which your project is hosted\.
+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\.
+The enterprise endpoint to use for your GitHub API\.
 .
 .P
 \-\-simple\-list
 .
 .P
-Create simple list from issues and pull requests\. Default is false\.
+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
+Limit pull requests to the release branch, such as master or release\.
 .
 .P
 \-\-http\-cache
 .
 .P
-Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
+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\.
 .
-.IP "" 4
-.
-.nf
-
-\-\-ssl\-ca\-file [PATH]
-.
-.fi
-.
-.IP "" 0
+.P
+\-\-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\.
@@ -281,19 +364,22 @@ Paths to Ruby file(s) to require before generating changelog\.
 \-\-[no\-]verbose
 .
 .P
-Run verbosely\. Default is true
+Run verbosely\. Default is true\.
 .
 .P
 \-v, \-\-version
 .
 .P
-Print version number
+Print version number\.
 .
 .P
 \-h, \-\-help
 .
 .P
-Displays Help
+Displays Help\.
+.
+.SH "REBASED COMMITS"
+GitHub pull requests that have been merged whose merge commit SHA has been modified through rebasing, cherry picking, or some other method may be tracked via a special comment on GitHub\. Git commit SHAs found in comments on pull requests matching the regular expression \fB/rebased commit: ([0\-9a\-f]{40})/i\fR will be used in place of the original merge SHA when being added to the changelog\.
 .
 .SH "EXAMPLES"
 .
@@ -301,7 +387,7 @@ Displays Help
 Written by Petr Korolev sky4winder@gmail\.com
 .
 .SH "REPORTING BUGS"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
+<\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/issues\fR>
 .
 .SH "SEE ALSO"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>
+<\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/\fR>