github_changelog_generator 1.15.0.pre.rc → 1.15.0

data/lib/github_changelog_generator/options.rb

@@ -7,7 +7,7 @@ module GitHubChangelogGenerator
   # This class wraps Options, and knows a list of known options. Others options
   # will raise exceptions.
   class Options < SimpleDelegator
-    # Raised on intializing with unknown keys in the values hash,
+    # Raised on initializing with unknown keys in the values hash,
     # and when trying to store a value on an unknown key.
     UnsupportedOptionError = Class.new(ArgumentError)
 
@@ -15,20 +15,24 @@ module GitHubChangelogGenerator
     KNOWN_OPTIONS = %i[
       add_issues_wo_labels
       add_pr_wo_labels
+      add_sections
       author
       base
       between_tags
+      breaking_labels
+      breaking_prefix
       bug_labels
       bug_prefix
       cache_file
       cache_log
       compare_link
+      configure_sections
       date_format
+      deprecated_labels
+      deprecated_prefix
       due_tag
       enhancement_labels
       enhancement_prefix
-      breaking_labels
-      breaking_prefix
       exclude_labels
       exclude_tags
       exclude_tags_regex
@@ -42,6 +46,7 @@ module GitHubChangelogGenerator
       include_labels
       issue_prefix
       issue_line_labels
+      issue_line_body
       issues
       max_issues
       merge_prefix
@@ -50,10 +55,16 @@ module GitHubChangelogGenerator
       pulls
       release_branch
       release_url
+      removed_labels
+      removed_prefix
       require
+      security_labels
+      security_prefix
       simple_list
       since_tag
       ssl_ca_file
+      summary_labels
+      summary_prefix
       token
       unreleased
       unreleased_label
@@ -95,11 +106,31 @@ module GitHubChangelogGenerator
     # Pretty-prints a censored options hash, if :verbose.
     def print_options
       return unless self[:verbose]
+
       Helper.log.info "Using these options:"
-      pp(censored_values)
+      # For ruby 2.5.0+
+      censored_values.each do |key, value|
+        print(key.inspect, "=>", value.inspect)
+        puts ""
+      end
       puts ""
     end
 
+    # Boolean method for whether the user is using configure_sections
+    def configure_sections?
+      !self[:configure_sections].nil? && !self[:configure_sections].empty?
+    end
+
+    # Boolean method for whether the user is using add_sections
+    def add_sections?
+      !self[:add_sections].nil? && !self[:add_sections].empty?
+    end
+
+    # @return [Boolean] whether write to `:output`
+    def write_to_file?
+      self[:output].present?
+    end
+
     private
 
     def values

data/lib/github_changelog_generator/parser.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "optparse"
-require "pp"
 require "github_changelog_generator/version"
 require "github_changelog_generator/helper"
 
@@ -38,61 +37,79 @@ module GitHubChangelogGenerator
     def self.setup_parser(options)
       OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
         opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
-        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last|
+        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo.") do |last|
           options[:user] = last
         end
-        opts.on("-p", "--project PROJECT", "Name of project on GitHub") do |last|
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub.") do |last|
           options[:project] = last
         end
         opts.on("-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") do |last|
           options[:token] = last
         end
-        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last|
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d.") do |last|
           options[:date_format] = last
         end
-        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
+        opts.on("-o", "--output [NAME]", "Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md") do |last|
           options[:output] = last
         end
         opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
           options[:base] = last
         end
-        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
-          options[:bug_prefix] = v
+        opts.on("--summary-label [LABEL]", "Set up custom label for the release summary section. Default is \"\".") do |v|
+          options[:summary_prefix] = v
+        end
+        opts.on("--breaking-label [LABEL]", "Set up custom label for the breaking changes section. Default is \"**Breaking changes:**\".") do |v|
+          options[:breaking_prefix] = v
         end
-        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
+        opts.on("--enhancement-label [LABEL]", "Set up custom label for enhancements section. Default is \"**Implemented enhancements:**\".") do |v|
           options[:enhancement_prefix] = v
         end
-        opts.on("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
-          options[:breaking_prefix] = v
+        opts.on("--bugs-label [LABEL]", "Set up custom label for bug-fixes section. Default is \"**Fixed bugs:**\".") do |v|
+          options[:bug_prefix] = v
+        end
+        opts.on("--deprecated-label [LABEL]", "Set up custom label for the deprecated changes section. Default is \"**Deprecated:**\".") do |v|
+          options[:deprecated_prefix] = v
         end
-        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
+        opts.on("--removed-label [LABEL]", "Set up custom label for the removed changes section. Default is \"**Removed:**\".") do |v|
+          options[:removed_prefix] = v
+        end
+        opts.on("--security-label [LABEL]", "Set up custom label for the security changes section. Default is \"**Security fixes:**\".") do |v|
+          options[:security_prefix] = v
+        end
+        opts.on("--issues-label [LABEL]", "Set up custom label for closed-issues section. Default is \"**Closed issues:**\".") do |v|
           options[:issue_prefix] = v
         end
-        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+        opts.on("--header-label [LABEL]", "Set up custom header label. Default is \"# Changelog\".") do |v|
           options[:header] = v
         end
-        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
+        opts.on("--configure-sections [Hash, String]", "Define your own set of sections which overrides all default sections.") do |v|
+          options[:configure_sections] = v
+        end
+        opts.on("--add-sections [Hash, String]", "Add new sections but keep the default sections.") do |v|
+          options[:add_sections] = v
+        end
+        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line.") do |v|
           options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
         end
-        opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
+        opts.on("--pr-label [LABEL]", "Set up custom label for pull requests section. Default is \"**Merged pull requests:**\".") do |v|
           options[:merge_prefix] = v
         end
-        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true.") do |v|
           options[:issues] = v
         end
-        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true.") do |v|
           options[:add_issues_wo_labels] = v
         end
-        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true.") do |v|
           options[:add_pr_wo_labels] = v
         end
-        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true.") do |v|
           options[:pulls] = v
         end
-        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true.") do |last|
           options[:filter_issues_by_milestone] = last
         end
-        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
+        opts.on("--[no-]author", "Add author of pull request at the end. Default is true.") do |author|
           options[:author] = author
         end
         opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
@@ -101,67 +118,79 @@ module GitHubChangelogGenerator
         opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
           options[:unreleased_only] = v
         end
-        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true.") do |v|
           options[:unreleased] = v
         end
-        opts.on("--unreleased-label [label]", "Setup custom label for unreleased closed issues section. Default is \"**Unreleased:**\"") do |v|
+        opts.on("--unreleased-label [label]", "Set up custom label for unreleased closed issues section. Default is \"**Unreleased:**\".") do |v|
           options[:unreleased_label] = v
         end
-        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
+        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true.") do |v|
           options[:compare_link] = v
         end
-        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
+        opts.on("--include-labels  x,y,z", Array, "Of the labeled issues, only include the ones with the specified labels.") do |list|
           options[:include_labels] = list
         end
-        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.") do |list|
           options[:exclude_labels] = list
         end
-        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
-          options[:bug_labels] = list
+        opts.on("--summary-labels x,y,z", Array, '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,summary\'.') do |list|
+          options[:summary_labels] = list
+        end
+        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking changes". Default is \'backwards-incompatible,breaking\'.') do |list|
+          options[:breaking_labels] = list
         end
-        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
+        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'.') do |list|
           options[:enhancement_labels] = list
         end
-        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|
-          options[:breaking_labels] = list
+        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Fixed bugs" section. Default is \'bug,Bug\'.') do |list|
+          options[:bug_labels] = list
+        end
+        opts.on("--deprecated-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Deprecated". Default is \'deprecated,Deprecated\'.') do |list|
+          options[:deprecated_labels] = list
+        end
+        opts.on("--removed-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Removed". Default is \'removed,Removed\'.') do |list|
+          options[:removed_labels] = list
+        end
+        opts.on("--security-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Security fixes". Default is \'security,Security\'.') do |list|
+          options[:security_labels] = list
         end
         opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
           options[:issue_line_labels] = list
         end
-        opts.on("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
+        opts.on("--exclude-tags  x,y,z", Array, "Changelog will exclude specified tags") do |list|
           options[:exclude_tags] = list
         end
-        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
+        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\".") do |last|
           options[:exclude_tags_regex] = last
         end
-        opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
+        opts.on("--since-tag  x", "Changelog will start after specified tag.") do |v|
           options[:since_tag] = v
         end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+        opts.on("--due-tag  x", "Changelog will end before specified tag.") do |v|
           options[:due_tag] = v
         end
-        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+        opts.on("--max-issues [NUMBER]", Integer, "Maximum number of issues to fetch from GitHub. Default is unlimited.") do |max|
           options[:max_issues] = max
         end
         opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
           options[:release_url] = url
         end
-        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
+        opts.on("--github-site [URL]", "The Enterprise GitHub site where your project is hosted.") do |last|
           options[:github_site] = last
         end
-        opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
+        opts.on("--github-api [URL]", "The enterprise endpoint to use for your GitHub API.") do |last|
           options[:github_endpoint] = last
         end
-        opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
+        opts.on("--simple-list", "Create a simple list from issues and pull requests. Default is false.") do |v|
           options[:simple_list] = v
         end
         opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
           options[:future_release] = future_release
         end
-        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
+        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release.") do |release_branch|
           options[:release_branch] = release_branch
         end
-        opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
+        opts.on("--[no-]http-cache", "Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.") do |http_cache|
           options[:http_cache] = http_cache
         end
         opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.") do |cache_file|
@@ -173,17 +202,17 @@ module GitHubChangelogGenerator
         opts.on("--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.") do |ssl_ca_file|
           options[:ssl_ca_file] = ssl_ca_file
         end
-        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require before generating changelog.") do |paths|
           options[:require] = paths
         end
-        opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
+        opts.on("--[no-]verbose", "Run verbosely. Default is true.") do |v|
           options[:verbose] = v
         end
-        opts.on("-v", "--version", "Print version number") do |_v|
+        opts.on("-v", "--version", "Print version number.") do |_v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
         end
-        opts.on("-h", "--help", "Displays Help") do
+        opts.on("-h", "--help", "Displays Help.") do
           puts opts
           exit
         end
@@ -205,21 +234,31 @@ module GitHubChangelogGenerator
         unreleased: true,
         unreleased_label: "Unreleased",
         compare_link: true,
+        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
+        summary_labels: ["Release summary", "release-summary", "Summary", "summary"],
+        breaking_labels: ["backwards-incompatible", "Backwards incompatible", "breaking"],
         enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
         bug_labels: ["bug", "Bug", "Type: Bug"],
-        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
-        breaking_labels: %w[backwards-incompatible breaking],
+        deprecated_labels: ["deprecated", "Deprecated", "Type: Deprecated"],
+        removed_labels: ["removed", "Removed", "Type: Removed"],
+        security_labels: ["security", "Security", "Type: Security"],
+        configure_sections: {},
+        add_sections: {},
         issue_line_labels: [],
         max_issues: nil,
         simple_list: false,
         ssl_ca_file: nil,
         verbose: true,
-        header: "# Change Log",
+        header: "# Changelog",
         merge_prefix: "**Merged pull requests:**",
         issue_prefix: "**Closed issues:**",
-        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: "**Implemented enhancements:**",
+        summary_prefix: "",
         breaking_prefix: "**Breaking changes:**",
+        enhancement_prefix: "**Implemented enhancements:**",
+        bug_prefix: "**Fixed bugs:**",
+        deprecated_prefix: "**Deprecated:**",
+        removed_prefix: "**Removed:**",
+        security_prefix: "**Security fixes:**",
         http_cache: true,
         require: []
       )

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

data/lib/github_changelog_generator/task.rb

@@ -10,7 +10,6 @@ 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
@@ -20,7 +19,7 @@ module GitHubChangelogGenerator
                   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]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -38,7 +37,7 @@ module GitHubChangelogGenerator
     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.15.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" "October 2017" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "May 2018" "" ""
 .
 .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,118 @@ 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\-]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,73 +178,109 @@ 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
+\-\-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]
 .
 .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
 \-\-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]
@@ -214,19 +292,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]
@@ -238,13 +316,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]
@@ -258,16 +336,9 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
 .P
 Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
-.IP "" 4
-.
-.nf
-
+.P
 \-\-ssl\-ca\-file [PATH]
 .
-.fi
-.
-.IP "" 0
-.
 .P
 Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
 .
@@ -281,19 +352,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 +375,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>