github_changelog_generator 1.15.0.pre.alpha → 1.16.0

data/lib/github_changelog_generator/parser_file.rb

@@ -31,6 +31,7 @@ module GitHubChangelogGenerator
     # Sets options using configuration file content
     def parse!
       return unless @file
+
       @file.each_with_index { |line, i| parse_line!(line, i + 1) }
       @file.close
     end
@@ -46,6 +47,7 @@ module GitHubChangelogGenerator
 
     def parse_line!(line, line_number)
       return if non_configuration_line?(line)
+
       option_name, value = extract_pair(line)
       @options[option_key_for(option_name)] = convert_value(value, option_name)
     rescue StandardError
@@ -54,7 +56,7 @@ module GitHubChangelogGenerator
 
     # Returns true if the line starts with a pound sign or a semi-colon.
     def non_configuration_line?(line)
-      line =~ /^[\#;]/ || line =~ /^[\s]+$/
+      line =~ /^[\#;]/ || line =~ /^\s+$/
     end
 
     # Returns a the option name as a symbol and its string value sans newlines.
@@ -66,8 +68,10 @@ module GitHubChangelogGenerator
       [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
 
-    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
-                          enhancement_labels issue_line_labels between_tags exclude_tags]
+    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels
+                          summary_labels breaking_labels enhancement_labels bug_labels
+                          deprecated_labels removed_labels security_labels
+                          issue_line_labels between_tags exclude_tags]
     KNOWN_INTEGER_KEYS = [:max_issues]
 
     def convert_value(value, option_name)
@@ -91,6 +95,7 @@ module GitHubChangelogGenerator
       header_label: :header,
       front_matter: :frontmatter,
       pr_label: :merge_prefix,
+      breaking_label: :breaking_prefix,
       issues_wo_labels: :add_issues_wo_labels,
       pr_wo_labels: :add_pr_wo_labels,
       pull_requests: :pulls,

data/lib/github_changelog_generator/reader.rb

@@ -29,8 +29,8 @@ module GitHubChangelogGenerator
       defaults = {
         heading_level: "##",
         heading_structures: [
-          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
-          /^## (?<version>.+?)( \((?<date>.+?)\))?$/
+          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
+          /^## (?<version>.+?)( \((?<date>.+?)\))?$/ # rubocop:disable Lint/MixedRegexpCaptureTypes
         ]
       }
 

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 ]
+                  base configure_sections add_sections http_cache]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -31,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
 
@@ -48,13 +49,11 @@ module GitHubChangelogGenerator
         # mimick parse_options
         options = Parser.default_options
 
-        Parser.fetch_user_and_project(options)
-
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")
           options[o.to_sym] = v unless v.nil?
         end
-
+        abort "user and project are required." unless options[:user] && options[:project]
         generator = Generator.new options
 
         log = generator.compound_changelog

data/lib/github_changelog_generator/version.rb

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

data/man/git-generate-changelog.1

@@ -1,28 +1,28 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
+.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]
 .
 .P
-Username of the owner of target GitHub repo
+Username of the owner of target GitHub repo\.
 .
 .P
 \-p, \-\-project [PROJECT]
 .
 .P
-Name of project on GitHub
+Name of project on GitHub\.
 .
 .P
 \-t, \-\-token [TOKEN]
@@ -34,13 +34,13 @@ To make more than 50 requests per hour your GitHub token is required\. You can g
 \-f, \-\-date\-format [FORMAT]
 .
 .P
-Date format\. Default is %Y\-%m\-%d
+Date format\. Default is %Y\-%m\-%d\.
 .
 .P
 \-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]
@@ -49,76 +49,124 @@ Output file\. Default is CHANGELOG\.md
 Optional base file to append generated changes to\.
 .
 .P
-\-\-bugs\-label [LABEL]
+\-\-summary\-label [LABEL]
+.
+.P
+Set up custom label for the release summary section\. Default is ""\.
+.
+.P
+\-\-breaking\-label [LABEL]
 .
 .P
-Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
+Set up custom label for breaking changes section\. Default is "\fBBreaking changes:\fR"\.
 .
 .P
 \-\-enhancement\-label [LABEL]
 .
 .P
-Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
+Set up custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"\.
+.
+.P
+\-\-bugs\-label [LABEL]
+.
+.P
+Set up custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR"\.
+.
+.P
+\-\-deprecated\-label [LABEL]
+.
+.P
+Set up custom label for deprecated section\. Default is "\fBDeprecated:\fR"\.
+.
+.P
+\-\-removed\-label [LABEL]
+.
+.P
+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
-Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
+Set up custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"\.
 .
 .P
 \-\-header\-label [LABEL]
 .
 .P
-Setup custom header label\. Default is "# Change Log"
+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
+Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line\.
 .
 .P
 \-\-pr\-label [LABEL]
 .
 .P
-Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
+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,79 +184,115 @@ 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]
 .
 .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
-\-\-between\-tags x,y,z
+\-\-security\-labels x,y,z
 .
 .P
-Change log will be filled only between specified tags
+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]
 .
 .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]
 .
 .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]
@@ -220,19 +304,19 @@ The URL to point to for release links, in printf format (with the tag as variabl
 \-\-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]
 .
 .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]
@@ -244,13 +328,13 @@ Put the unreleased changes in the specified release number\.
 \-\-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]
@@ -265,22 +349,37 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
 Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
 .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\.
+.
+.P
+\-\-require file1\.rb,file2\.rb
+.
+.P
+Paths to Ruby file(s) to require before generating changelog\.
+.
+.P
 \-\-[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"
 .
@@ -288,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>