RubyGems - github_changelog_generator - Versions diffs - 1.10.1 → 1.10.4 - Mend

github_changelog_generator 1.10.1 → 1.10.4

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

checksums.yaml +4 -4
data/.rubocop.yml +40 -0
data/.rubocop_todo.yml +15 -6
data/.travis.yml +1 -1
data/CHANGELOG.md +33 -0
data/Gemfile.lock +28 -36
data/README.md +72 -67
data/Rakefile +17 -1
data/bin/git-generate-changelog +4 -0
data/github_changelog_generator.gemspec +4 -4
data/lib/github_changelog_generator.rb +1 -1
data/lib/github_changelog_generator/fetcher.rb +5 -5
data/lib/github_changelog_generator/generator/generator_generation.rb +25 -23
data/lib/github_changelog_generator/generator/generator_processor.rb +13 -13
data/lib/github_changelog_generator/generator/generator_tags.rb +12 -12
data/lib/github_changelog_generator/helper.rb +6 -6
data/lib/github_changelog_generator/parser.rb +3 -0
data/lib/github_changelog_generator/parser_file.rb +2 -2
data/lib/github_changelog_generator/task.rb +2 -2
data/lib/github_changelog_generator/version.rb +1 -1
data/man/git-generate-changelog.1 +252 -0
data/man/git-generate-changelog.html +262 -0
data/man/git-generate-changelog.md +179 -0
data/spec/files/github_changelog_params_327 +1 -0
data/spec/spec_helper.rb +5 -5
data/spec/unit/parse_file_spec.rb +14 -0
metadata +39 -17

data/man/git-generate-changelog.html ADDED Viewed

@@ -0,0 +1,262 @@
+<!DOCTYPE html>
+<html>
+<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>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>git-generate-changelog(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
+</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p>Automatically generate change log 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>  -p, --project [PROJECT]</p>
+<p>  Name of project on GitHub</p>
+<p>  -t, --token [TOKEN]</p>
+<p>  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
+<p>  -f, --date-format [FORMAT]</p>
+<p>  Date format. Default is %Y-%m-%d</p>
+<p>  -o, --output [NAME]</p>
+<p>  Output file. 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>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
+<p>   --enhancement-label [LABEL]</p>
+<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
+<p>   --issues-label [LABEL]</p>
+<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
+<p>   --header-label [LABEL]</p>
+<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   --pr-label [LABEL]</p>
+<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
+<p>   --[no-]issues</p>
+<p>   Include closed issues in changelog. Default is true</p>
+<p>   --[no-]issues-wo-labels</p>
+<p>   Include closed issues without labels in changelog. Default is true</p>
+<p>   --[no-]pr-wo-labels</p>
+<p>   Include pull requests without labels in changelog. Default is true</p>
+<p>   --[no-]pull-requests</p>
+<p>   Include pull-requests in changelog. Default is true</p>
+<p>   --[no-]filter-by-milestone</p>
+<p>   Use milestone to detect when issue was resolved. Default is true</p>
+<p>   --[no-]author</p>
+<p>   Add author of pull-request in the end. Default is true</p>
+<p>   --unreleased-only</p>
+<p>   Generate log from unreleased closed issues only.</p>
+<p>   --[no-]unreleased</p>
+<p>   Add to log unreleased closed issues. Default is true</p>
+<p>   --unreleased-label [label]</p>
+<p>   Add to log unreleased closed issues. Default is true</p>
+<p>   --[no-]compare-link</p>
+<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
+<p>   --include-labels x,y,z</p>
+<p>   Only issues with the specified labels will be included in the changelog.</p>
+<p>   --exclude-labels x,y,z</p>
+<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
+<p>   --bug-labels x,y,z</p>
+<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
+<p>   --enhancement-labels x,y,z</p>
+<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
+<p>   --between-tags x,y,z</p>
+<p>   Change log will be filled only between specified tags</p>
+<p>   --exclude-tags x,y,z</p>
+<p>   Change log will exclude specified tags</p>
+<p>   --since-tag x</p>
+<p>   Change log will start after specified tag</p>
+<p>   --due-tag x</p>
+<p>   Change log will end before specified tag</p>
+<p>   --max-issues [NUMBER]</p>
+<p>   Max 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 on which 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 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>   --[no-]verbose</p>
+<p>   Run verbosely. Default is true</p>
+<p>  -v, --version</p>
+<p>  Print version number</p>
+<p>  -h, --help</p>
+<p>  Displays Help</p>
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<h2 id="AUTHOR">AUTHOR</h2>
+<p>Written by Petr Korolev sky4winder@gmail.com</p>
+<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>
+<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>
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2015</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+  </div>
+</body>
+</html>

data/man/git-generate-changelog.md ADDED Viewed

@@ -0,0 +1,179 @@
+git-generate-changelog(1) - Generate changelog from github
+================================
+## SYNOPSIS
+`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
+## DESCRIPTION
+Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
+## OPTIONS
+  -u, --user [USER]
+  Username of the owner of target GitHub repo
+  -p, --project [PROJECT]
+  Name of project on GitHub
+  -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
+  -f, --date-format [FORMAT]
+  Date format. Default is %Y-%m-%d
+  -o, --output [NAME]
+  Output file. Default is CHANGELOG.md
+  -b, --base [NAME]
+  Optional base file to append generated changes to.
+   --bugs-label [LABEL]
+   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
+   --enhancement-label [LABEL]
+   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
+   --issues-label [LABEL]
+   Setup custom label for closed-issues section. Default is "**Closed issues:**"
+   --header-label [LABEL]
+   Setup custom header label. Default is "# Change Log"
+   --pr-label [LABEL]
+   Setup custom label for pull requests section. Default is "**Merged pull requests:**"
+   --[no-]issues
+   Include closed issues in changelog. Default is true
+   --[no-]issues-wo-labels
+   Include closed issues without labels in changelog. Default is true
+   --[no-]pr-wo-labels
+   Include pull requests without labels in changelog. Default is true
+   --[no-]pull-requests
+   Include pull-requests in changelog. Default is true
+   --[no-]filter-by-milestone
+   Use milestone to detect when issue was resolved. Default is true
+   --[no-]author
+   Add author of pull-request in the end. Default is true
+   --unreleased-only
+   Generate log from unreleased closed issues only.
+   --[no-]unreleased
+   Add to log unreleased closed issues. Default is true
+   --unreleased-label [label]
+   Add to log unreleased closed issues. Default is true
+   --[no-]compare-link
+   Include compare link (Full Changelog) between older version and newer version. Default is true
+   --include-labels x,y,z
+   Only issues with the specified labels will be included in the changelog.
+   --exclude-labels x,y,z
+   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
+   --bug-labels x,y,z
+   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
+   --enhancement-labels x,y,z
+   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
+   --between-tags x,y,z
+   Change log will be filled only between specified tags
+   --exclude-tags x,y,z
+   Change log will exclude specified tags
+   --since-tag x
+   Change log will start after specified tag
+   --due-tag x
+   Change log will end before specified tag
+   --max-issues [NUMBER]
+   Max 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 on which your project is hosted.
+   --github-api [URL]
+   The enterprise endpoint to use for your Github API.
+   --simple-list
+   Create simple list from issues and pull requests. Default is false.
+   --future-release [RELEASE-VERSION]
+   Put the unreleased changes in the specified release number.
+   --[no-]verbose
+   Run verbosely. Default is true
+  -v, --version
+  Print version number
+  -h, --help
+  Displays Help
+## EXAMPLES
+## AUTHOR
+Written by Petr Korolev sky4winder@gmail.com
+## REPORTING BUGS
+&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
+## SEE ALSO
+&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;

data/spec/files/github_changelog_params_327 ADDED Viewed

	@@ -0,0 +1 @@
1	+ exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90

data/spec/spec_helper.rb CHANGED Viewed

@@ -23,11 +23,11 @@ require "coveralls"
 module SpecHelper
 end
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  Coveralls::SimpleCov::Formatter,
-  SimpleCov::Formatter::HTMLFormatter,
-  CodeClimate::TestReporter::Formatter
-]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+                                                                 Coveralls::SimpleCov::Formatter,
+                                                                 SimpleCov::Formatter::HTMLFormatter,
+                                                                 CodeClimate::TestReporter::Formatter
+                                                               ])
 SimpleCov.start
 require "github_changelog_generator"