RubyGems - github_changelog_generator - Versions diffs - 1.15.0.pre.rc → 1.15.0 - Mend

github_changelog_generator 1.15.0.pre.rc → 1.15.0

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 (57) hide show

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

@@ -3,7 +3,7 @@
 <head>
   <meta http-equiv='content-type' value='text/html;charset=utf8'>
   <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
-  <title>git-generate-changelog(1) - Generate changelog from github</title>
+  <title>git-generate-changelog(1) - Generate changelog from GitHub</title>
   <style type='text/css' media='all'>
   /* style: man */
   body#manpage {margin:0}
@@ -57,6 +57,7 @@
     <a href="#SYNOPSIS">SYNOPSIS</a>
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#OPTIONS">OPTIONS</a>
+    <a href="#REBASED-COMMITS">REBASED COMMITS</a>
     <a href="#EXAMPLES">EXAMPLES</a>
     <a href="#AUTHOR">AUTHOR</a>
     <a href="#REPORTING-BUGS">REPORTING BUGS</a>
@@ -71,7 +72,7 @@
   <h2 id="NAME">NAME</h2>
 <p class="man-name">
-  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
+  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from GitHub</span>
 </p>
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -80,17 +81,17 @@
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
 <h2 id="OPTIONS">OPTIONS</h2>
 <p>  -u, --user [USER]</p>
-<p>  Username of the owner of target GitHub repo</p>
+<p>  Username of the owner of target GitHub repo.</p>
 <p>  -p, --project [PROJECT]</p>
-<p>  Name of project on GitHub</p>
+<p>  Name of project on GitHub.</p>
 <p>  -t, --token [TOKEN]</p>
@@ -98,176 +99,231 @@
 <p>  -f, --date-format [FORMAT]</p>
-<p>  Date format. Default is %Y-%m-%d</p>
+<p>  Date format. Default is %Y-%m-%d.</p>
 <p>  -o, --output [NAME]</p>
-<p>  Output file. Default is CHANGELOG.md</p>
+<p>  Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.</p>
 <p>  -b, --base [NAME]</p>
 <p>  Optional base file to append generated changes to.</p>
-<p>   --bugs-label [LABEL]</p>
+<p>  --summary-label [LABEL]</p>
-<p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
+<p>  Set up custom label for the release summary section. Default is "".</p>
-<p>   --enhancement-label [LABEL]</p>
+<p>  --breaking-label [LABEL]</p>
-<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
+<p>  Set up custom label for breaking changes section. Default is "<strong>Breaking changes:</strong>".</p>
-<p>   --issues-label [LABEL]</p>
+<p>  --enhancement-label [LABEL]</p>
-<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
+<p>  Set up custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>".</p>
-<p>   --header-label [LABEL]</p>
+<p>  --bugs-label [LABEL]</p>
-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>  Set up custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong>".</p>
-<p>   --front-matter [JSON]</p>
+<p>  --deprecated-label [LABEL]</p>
-<p>   Add YAML front matter. Formatted as JSON because it's easier to add on the command line</p>
+<p>  Set up custom label for deprecated section. Default is "<strong>Deprecated:</strong>".</p>
-<p>   --pr-label [LABEL]</p>
+<p>  --removed-label [LABEL]</p>
-<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
+<p>  Set up custom label for removed section. Default is "<strong>Removed:</strong>".</p>
-<p>   --[no-]issues</p>
+<p>  --security-label [LABEL]</p>
-<p>   Include closed issues in changelog. Default is true</p>
+<p>  Set up custom label for security section. Default is "<strong>Security:</strong>".</p>
-<p>   --[no-]issues-wo-labels</p>
+<p>  --issues-label [LABEL]</p>
-<p>   Include closed issues without labels in changelog. Default is true</p>
+<p>  Set up custom label for closed-issues section. Default is "<strong>Closed issues:</strong>".</p>
-<p>   --[no-]pr-wo-labels</p>
+<p>  --header-label [LABEL]</p>
-<p>   Include pull requests without labels in changelog. Default is true</p>
+<p>  Set up custom header label. Default is "# Changelog".</p>
-<p>   --[no-]pull-requests</p>
+<p>  --configure-sections [HASH, STRING]</p>
-<p>   Include pull-requests in changelog. Default is true</p>
+<p>  Define your own set of sections which overrides all default sections.</p>
-<p>   --[no-]filter-by-milestone</p>
+<p>  --add-sections [HASH, STRING]</p>
-<p>   Use milestone to detect when issue was resolved. Default is true</p>
+<p>  Add new sections but keep the default sections.</p>
-<p>   --[no-]author</p>
+<p>  --front-matter [JSON]</p>
-<p>   Add author of pull-request in the end. Default is true</p>
+<p>  Add YAML front matter. Formatted as JSON because it's easier to add on the command line.</p>
-<p>   --usernames-as-github-logins</p>
+<p>  --pr-label [LABEL]</p>
-<p>   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</p>
+<p>  Set up custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>".</p>
-<p>   --unreleased-only</p>
+<p>  --[no-]issues</p>
-<p>   Generate log from unreleased closed issues only.</p>
+<p>  Include closed issues in changelog. Default is true.</p>
-<p>   --[no-]unreleased</p>
+<p>  --[no-]issues-wo-labels</p>
-<p>   Add to log unreleased closed issues. Default is true</p>
+<p>  Include closed issues without labels in changelog. Default is true.</p>
-<p>   --unreleased-label [label]</p>
+<p>  --[no-]pr-wo-labels</p>
-<p>   Setup custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>"</p>
+<p>  Include pull requests without labels in changelog. Default is true.</p>
-<p>   --[no-]compare-link</p>
+<p>  --[no-]pull-requests</p>
-<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
+<p>  Include pull-requests in changelog. Default is true.</p>
-<p>   --include-labels x,y,z</p>
+<p>  --[no-]filter-by-milestone</p>
-<p>   Only issues with the specified labels will be included in the changelog.</p>
+<p>  Use milestone to detect when issue was resolved. Default is true.</p>
-<p>   --exclude-labels x,y,z</p>
+<p>  --[no-]author</p>
-<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
+<p>  Add author of pull request at the end. Default is true.</p>
-<p>   --bug-labels x,y,z</p>
+<p>  --usernames-as-github-logins</p>
-<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
+<p>  Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</p>
-<p>   --enhancement-labels x,y,z</p>
+<p>  --unreleased-only</p>
-<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
+<p>  Generate log from unreleased closed issues only.</p>
-<p>   --exclude-tags x,y,z</p>
+<p>  --[no-]unreleased</p>
-<p>   Change log will exclude specified tags</p>
+<p>  Add to log unreleased closed issues. Default is true.</p>
-<p>   --exclude-tags-regex [REGEX]</p>
+<p>  --unreleased-label [label]</p>
-<p>   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}"</p>
+<p>  Set up custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>".</p>
-<p>   --since-tag x</p>
+<p>  --[no-]compare-link</p>
-<p>   Change log will start after specified tag</p>
+<p>  Include compare link (Full Changelog) between older version and newer version. Default is true.</p>
-<p>   --due-tag x</p>
+<p>  --include-labels x,y,z</p>
-<p>   Change log will end before specified tag</p>
+<p>  Of the labeled issues, only include the ones with the specified labels.</p>
-<p>   --max-issues [NUMBER]</p>
+<p>  --exclude-labels x,y,z</p>
-<p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
+<p>  Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.</p>
-<p>   --release-url [URL]</p>
+<p>  --summary-labels x,y,z</p>
-<p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
+<p>  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>
-<p>   --github-site [URL]</p>
+<p>  --breaking-labels x,y,z</p>
-<p>   The Enterprise Github site on which your project is hosted.</p>
+<p>  Issues with these labels will be added to a new section, called "Breaking changes". Default is 'backwards-incompatible,breaking'.</p>
-<p>   --github-api [URL]</p>
+<p>  --enhancement-labels x,y,z</p>
-<p>   The enterprise endpoint to use for your Github API.</p>
+<p>  Issues with the specified labels will be added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'.</p>
-<p>   --simple-list</p>
+<p>  --bug-labels x,y,z</p>
-<p>   Create simple list from issues and pull requests. Default is false.</p>
+<p>  Issues with the specified labels will be added to "Fixed bugs" section. Default is 'bug,Bug'.</p>
-<p>   --future-release [RELEASE-VERSION]</p>
+<p>  --deprecated-labels x,y,z</p>
-<p>   Put the unreleased changes in the specified release number.</p>
+<p>  Issues with the specified labels will be added to a section called "Deprecated". Default is 'deprecated,Deprecated'.</p>
-<p>   --release-branch [RELEASE-BRANCH]</p>
+<p>  --removed-labels x,y,z</p>
-<p>   Limit pull requests to the release branch, such as master or release</p>
+<p>  Issues with the specified labels will be added to a section called "Removed". Default is 'removed,Removed'.</p>
-<p>   --http-cache</p>
+<p>  --security-labels x,y,z</p>
-<p>   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.</p>
+<p>  Issues with the specified labels will be added to a section called "Security fixes". Default is 'security,Security'.</p>
-<p>   --[no-]cache-file [CACHE-FILE]</p>
+<p>  --issue-line-labels x,y,z</p>
-<p>   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
+<p>  The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].</p>
-<p>   --cache-log [CACHE-LOG]</p>
+<p>  --exclude-tags x,y,z</p>
-<p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
+<p>  Changelog will exclude specified tags.</p>
-<pre><code>--ssl-ca-file [PATH]
-</code></pre>
+<p>  --exclude-tags-regex [REGEX]</p>
-<p>   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
+<p>  Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}".</p>
-<p>   --require file1.rb,file2.rb</p>
+<p>  --since-tag x</p>
-<p>   Paths to Ruby file(s) to require before generating changelog.</p>
+<p>  Changelog will start after specified tag.</p>
-<p>   --[no-]verbose</p>
+<p>  --due-tag x</p>
-<p>   Run verbosely. Default is true</p>
+<p>  Changelog will end before specified tag.</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>  The URL to point to for release links, in printf format (with the tag as variable).</p>
+<p>  --github-site [URL]</p>
+<p>  The Enterprise GitHub site where your project is hosted.</p>
+<p>  --github-api [URL]</p>
+<p>  The enterprise endpoint to use for your GitHub API.</p>
+<p>  --simple-list</p>
+<p>  Create a simple list from issues and pull requests. Default is false.</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>  Limit pull requests to the release branch, such as master or release.</p>
+<p>  --http-cache</p>
+<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>  Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</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>  Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
+<p>  --require file1.rb,file2.rb</p>
+<p>  Paths to Ruby file(s) to require before generating changelog.</p>
+<p>  --[no-]verbose</p>
+<p>  Run verbosely. Default is true.</p>
 <p>  -v, --version</p>
-<p>  Print version number</p>
+<p>  Print version number.</p>
 <p>  -h, --help</p>
-<p>  Displays Help</p>
+<p>  Displays Help.</p>
+<h2 id="REBASED-COMMITS">REBASED COMMITS</h2>
+<p>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 <code>/rebased commit: ([0-9a-f]{40})/i</code> will be used in place of the original merge SHA when being added to the changelog.</p>
 <h2 id="EXAMPLES">EXAMPLES</h2>
@@ -277,16 +333,16 @@
 <h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
+<p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/issues" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/issues</a>&gt;</p>
 <h2 id="SEE-ALSO">SEE ALSO</h2>
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
+<p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/</a>&gt;</p>
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>October 2017</li>
+    <li class='tc'>May 2018</li>
     <li class='tr'>git-generate-changelog(1)</li>
   </ol>

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

@@ -80,7 +80,7 @@
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
 <h2 id="OPTIONS">OPTIONS</h2>
@@ -122,7 +122,7 @@
 <p>   --header-label [LABEL]</p>
-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   Setup custom header label. Default is "# Changelog"</p>
 <p>   --pr-label [LABEL]</p>
@@ -186,15 +186,15 @@
 <p>   --exclude-tags x,y,z</p>
-<p>   Change log will exclude specified tags</p>
+<p>   Changelog will exclude specified tags</p>
 <p>   --since-tag x</p>
-<p>   Change log will start after specified tag</p>
+<p>   Changelog will start after specified tag</p>
 <p>   --due-tag x</p>
-<p>   Change log will end before specified tag</p>
+<p>   Changelog will end before specified tag</p>
 <p>   --max-issues [NUMBER]</p>
@@ -220,6 +220,18 @@
 <p>   Put the unreleased changes in the specified release number.</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 new sections but keep the default sections"</p>
+<p>   --include-merged</p>
+<p>   If configure_sections is set, use this to restore the merged pull requests sections</p>
 <p>   --[no-]verbose</p>
 <p>   Run verbosely. Default is true</p>
@@ -240,11 +252,11 @@
 <h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
+<p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/issues" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/issues</a>&gt;</p>
 <h2 id="SEE-ALSO">SEE ALSO</h2>
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
+<p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/</a>&gt;</p>
   <ol class='man-decor man-foot man foot'>

data/man/git-generate-changelog.md CHANGED

@@ -1,4 +1,4 @@
-git-generate-changelog(1) - Generate changelog from github
+git-generate-changelog(1) - Generate changelog from GitHub
 ================================
 ## SYNOPSIS
@@ -7,17 +7,17 @@ git-generate-changelog(1) - Generate changelog from github
 ## 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.
 ## OPTIONS
   -u, --user [USER]
-  Username of the owner of target GitHub repo
+  Username of the owner of target GitHub repo.
   -p, --project [PROJECT]
-  Name of project on GitHub
+  Name of project on GitHub.
   -t, --token [TOKEN]
@@ -25,176 +25,231 @@ Automatically generate change log from your tags, issues, labels and pull reques
   -f, --date-format [FORMAT]
-  Date format. Default is %Y-%m-%d
+  Date format. Default is %Y-%m-%d.
   -o, --output [NAME]
-  Output file. Default is CHANGELOG.md
+  Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.
   -b, --base [NAME]
   Optional base file to append generated changes to.
-   --bugs-label [LABEL]
+  --summary-label [LABEL]
-   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
+  Set up custom label for the release summary section. Default is "".
-   --enhancement-label [LABEL]
+  --breaking-label [LABEL]
-   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
+  Set up custom label for breaking changes section. Default is "**Breaking changes:**".
-   --issues-label [LABEL]
+  --enhancement-label [LABEL]
-   Setup custom label for closed-issues section. Default is "**Closed issues:**"
+  Set up custom label for enhancements section. Default is "**Implemented enhancements:**".
-   --header-label [LABEL]
+  --bugs-label [LABEL]
-   Setup custom header label. Default is "# Change Log"
+  Set up custom label for bug-fixes section. Default is "**Fixed bugs:**".
-   --front-matter [JSON]
+  --deprecated-label [LABEL]
-   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 "**Deprecated:**".
-   --pr-label [LABEL]
+  --removed-label [LABEL]
-   Setup custom label for pull requests section. Default is "**Merged pull requests:**"
+  Set up custom label for removed section. Default is "**Removed:**".
-   --[no-]issues
+  --security-label [LABEL]
-   Include closed issues in changelog. Default is true
+  Set up custom label for security section. Default is "**Security:**".
-   --[no-]issues-wo-labels
+  --issues-label [LABEL]
-   Include closed issues without labels in changelog. Default is true
+  Set up custom label for closed-issues section. Default is "**Closed issues:**".
-   --[no-]pr-wo-labels
+  --header-label [LABEL]
-   Include pull requests without labels in changelog. Default is true
+  Set up custom header label. Default is "# Changelog".
-   --[no-]pull-requests
+  --configure-sections [HASH, STRING]
-   Include pull-requests in changelog. Default is true
+  Define your own set of sections which overrides all default sections.
-   --[no-]filter-by-milestone
+  --add-sections [HASH, STRING]
-   Use milestone to detect when issue was resolved. Default is true
+  Add new sections but keep the default sections.
-   --[no-]author
+  --front-matter [JSON]
-   Add author of pull-request in the end. Default is true
+  Add YAML front matter. Formatted as JSON because it's easier to add on the command line.
-   --usernames-as-github-logins
+  --pr-label [LABEL]
-   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
+  Set up custom label for pull requests section. Default is "**Merged pull requests:**".
-   --unreleased-only
+  --[no-]issues
-   Generate log from unreleased closed issues only.
+  Include closed issues in changelog. Default is true.
-   --[no-]unreleased
+  --[no-]issues-wo-labels
-   Add to log unreleased closed issues. Default is true
+  Include closed issues without labels in changelog. Default is true.
-   --unreleased-label [label]
+  --[no-]pr-wo-labels
-   Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
+  Include pull requests without labels in changelog. Default is true.
-   --[no-]compare-link
+  --[no-]pull-requests
-   Include compare link (Full Changelog) between older version and newer version. Default is true
+  Include pull-requests in changelog. Default is true.
-   --include-labels x,y,z
+  --[no-]filter-by-milestone
-   Only issues with the specified labels will be included in the changelog.
+  Use milestone to detect when issue was resolved. Default is true.
-   --exclude-labels x,y,z
+  --[no-]author
-   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
+  Add author of pull request at the end. Default is true.
-   --bug-labels x,y,z
+  --usernames-as-github-logins
-   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
+  Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
-   --enhancement-labels x,y,z
+  --unreleased-only
-   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
+  Generate log from unreleased closed issues only.
-   --exclude-tags x,y,z
+  --[no-]unreleased
-   Change log will exclude specified tags
+  Add to log unreleased closed issues. Default is true.
-   --exclude-tags-regex [REGEX]
+  --unreleased-label [label]
-   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"
+  Set up custom label for unreleased closed issues section. Default is "**Unreleased:**".
-   --since-tag x
+  --[no-]compare-link
-   Change log will start after specified tag
+  Include compare link (Full Changelog) between older version and newer version. Default is true.
-   --due-tag x
+  --include-labels x,y,z
-   Change log will end before specified tag
+  Of the labeled issues, only include the ones with the specified labels.
-   --max-issues [NUMBER]
+  --exclude-labels x,y,z
-   Max number of issues to fetch from GitHub. Default is unlimited
+  Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.
-   --release-url [URL]
+  --summary-labels x,y,z
-   The URL to point to for release links, in printf format (with the tag as variable).
+  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'.
-   --github-site [URL]
+  --breaking-labels x,y,z
-   The Enterprise Github site on which your project is hosted.
+  Issues with these labels will be added to a new section, called "Breaking changes". Default is 'backwards-incompatible,breaking'.
-   --github-api [URL]
+  --enhancement-labels x,y,z
-   The enterprise endpoint to use for your Github API.
+  Issues with the specified labels will be added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'.
-   --simple-list
+  --bug-labels x,y,z
-   Create simple list from issues and pull requests. Default is false.
+  Issues with the specified labels will be added to "Fixed bugs" section. Default is 'bug,Bug'.
-   --future-release [RELEASE-VERSION]
+  --deprecated-labels x,y,z
-   Put the unreleased changes in the specified release number.
+  Issues with the specified labels will be added to a section called "Deprecated". Default is 'deprecated,Deprecated'.
-   --release-branch [RELEASE-BRANCH]
+  --removed-labels x,y,z
-   Limit pull requests to the release branch, such as master or release
+  Issues with the specified labels will be added to a section called "Removed". Default is 'removed,Removed'.
-   --http-cache
+  --security-labels x,y,z
-   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
+  Issues with the specified labels will be added to a section called "Security fixes". Default is 'security,Security'.
-   --[no-]cache-file [CACHE-FILE]
+  --issue-line-labels x,y,z
-   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
+  The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].
-   --cache-log [CACHE-LOG]
+  --exclude-tags x,y,z
-   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
+  Changelog will exclude specified tags.
-    --ssl-ca-file [PATH]
+  --exclude-tags-regex [REGEX]
-   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
+  Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}".
-   --require file1.rb,file2.rb
+  --since-tag x
-   Paths to Ruby file(s) to require before generating changelog.
+  Changelog will start after specified tag.
-   --[no-]verbose
+  --due-tag x
-   Run verbosely. Default is true
+  Changelog will end before specified tag.
+  --max-issues [NUMBER]
+  Maximum number of issues to fetch from GitHub. Default is unlimited.
+  --release-url [URL]
+  The URL to point to for release links, in printf format (with the tag as variable).
+  --github-site [URL]
+  The Enterprise GitHub site where your project is hosted.
+  --github-api [URL]
+  The enterprise endpoint to use for your GitHub API.
+  --simple-list
+  Create a simple list from issues and pull requests. Default is false.
+  --future-release [RELEASE-VERSION]
+  Put the unreleased changes in the specified release number.
+  --release-branch [RELEASE-BRANCH]
+  Limit pull requests to the release branch, such as master or release.
+  --http-cache
+  Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.
+  --[no-]cache-file [CACHE-FILE]
+  Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
+  --cache-log [CACHE-LOG]
+  Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
+  --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.
+  --require file1.rb,file2.rb
+  Paths to Ruby file(s) to require before generating changelog.
+  --[no-]verbose
+  Run verbosely. Default is true.
   -v, --version
-  Print version number
+  Print version number.
   -h, --help
-  Displays Help
+  Displays Help.
+## 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 `/rebased commit: ([0-9a-f]{40})/i` will be used in place of the original merge SHA when being added to the changelog.
 ## EXAMPLES
@@ -204,8 +259,8 @@ Written by Petr Korolev sky4winder@gmail.com
 ## REPORTING BUGS
-&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
+&lt;<https://github.com/github-changelog-generator/github-changelog-generator/issues>&gt;
 ## SEE ALSO
-&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;
+&lt;<https://github.com/github-changelog-generator/github-changelog-generator/>&gt;