171 lines
7.6 KiB
HTML
171 lines
7.6 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
<title>Github-changelog-generator by skywinder</title>
|
|
|
|
<link rel="stylesheet" href="stylesheets/styles.css">
|
|
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
|
|
<script src="javascripts/scale.fix.js"></script>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
</head>
|
|
<body>
|
|
<div class="wrapper">
|
|
<header>
|
|
<h1 class="header">Github-changelog-generator</h1>
|
|
<p class="header">Automatically generate changelog from your tags, closed issues and merged pull requests.</p>
|
|
|
|
<ul>
|
|
<li class="download"><a class="buttons" href="https://github.com/skywinder/Github-Changelog-Generator/zipball/master">Download ZIP</a></li>
|
|
<li class="download"><a class="buttons" href="https://github.com/skywinder/Github-Changelog-Generator/tarball/master">Download TAR</a></li>
|
|
<li><a class="buttons github" href="https://github.com/skywinder/Github-Changelog-Generator">View On GitHub</a></li>
|
|
</ul>
|
|
|
|
<p class="header">This project is maintained by <a class="header name" href="https://github.com/skywinder">skywinder</a></p>
|
|
|
|
|
|
</header>
|
|
<section>
|
|
<h1>
|
|
<a id="github-changelog-generator" class="anchor" href="#github-changelog-generator" aria-hidden="true"><span class="octicon octicon-link"></span></a>GitHub Changelog Generator</h1>
|
|
|
|
<p><a href="http://badge.fury.io/rb/github_changelog_generator"><img src="https://badge.fury.io/rb/github_changelog_generator.svg" alt="Gem Version"></a></p>
|
|
|
|
<p>Changelog generation has never been so easy.</p>
|
|
|
|
<p>This script automatically generate change-log from your tags and merged pull-requests.</p>
|
|
|
|
<h2>
|
|
<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Installation:</h2>
|
|
|
|
<pre><code>[sudo] gem install github_changelog_generator
|
|
</code></pre>
|
|
|
|
<h2>
|
|
<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span class="octicon octicon-link"></span></a>Usage</h2>
|
|
|
|
<p><strong>It's really simple</strong>: </p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p><code>cd</code> to your Project folder with configured git and just type:</p>
|
|
|
|
<pre><code>github_changelog_generator
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>from anywhere:</p>
|
|
|
|
<pre><code>github_changelog_generator -u github-username -p github-project
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>As output you will get <code>CHANGELOG.md</code> file with <em>pretty Markdown-formatted</em> changelog.</p>
|
|
|
|
<h2>
|
|
<a id="params" class="anchor" href="#params" aria-hidden="true"><span class="octicon octicon-link"></span></a>Params:</h2>
|
|
|
|
<p>Type <code>github_changelog_generator --help</code> for detailed usage.</p>
|
|
|
|
<pre><code>Usage: changelog_generator [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 this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
|
|
-h, --help Displays Help
|
|
-v, --[no-]verbose Run verbosely. Default is true
|
|
--[no-]issues Include closed issues to changelog. Default is true
|
|
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
|
|
--[no-]pull-requests Include pull-requests to changelog. Default is true
|
|
-l, --last-changes Generate log between last 2 tags only
|
|
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
|
|
-o, --output [NAME] Output file. Default is CHANGELOG.md
|
|
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
|
|
</code></pre>
|
|
|
|
<h2>
|
|
<a id="examples" class="anchor" href="#examples" aria-hidden="true"><span class="octicon octicon-link"></span></a>Examples:</h2>
|
|
|
|
<ul>
|
|
<li>Look at changelog for <strong><a href="https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md">CHANGELOG.md</a></strong> for this project</li>
|
|
<li>
|
|
<p>This changelog: <a href="https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md">ActionSheetPicker-3.0/CHANGELOG.md</a> was generated by command:</p>
|
|
|
|
<pre><code>github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
|
</code></pre>
|
|
</li>
|
|
</ul>
|
|
|
|
<h2>
|
|
<a id="faq" class="anchor" href="#faq" aria-hidden="true"><span class="octicon octicon-link"></span></a>FAQ:</h2>
|
|
|
|
<p>Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token</p>
|
|
|
|
<p><strong>You can easily <a href="https://github.com/settings/applications">generate it here</a></strong>.</p>
|
|
|
|
<p>And:</p>
|
|
|
|
<ul>
|
|
<li>Run with key <code>-t [your-16-digit-token]</code> that </li>
|
|
<li>
|
|
<p>Or set environment variable <code>CHANGELOG_GITHUB_TOKEN</code> and specify there your token. </p>
|
|
|
|
<p>i.e. add to your <code>~/.bash_profile</code> or <code>~/.zshrc</code> or any other place to load ENV variables string <code>export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'</code></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>So, if you got error like this:</p>
|
|
|
|
<blockquote>
|
|
<p>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'</p>
|
|
</blockquote>
|
|
|
|
<p>It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.</p>
|
|
|
|
<h2>
|
|
<a id="am-i-missed-some-essential-feature" class="anchor" href="#am-i-missed-some-essential-feature" aria-hidden="true"><span class="octicon octicon-link"></span></a>Am I missed some essential feature?</h2>
|
|
|
|
<p><strong>Nothing is impossible!</strong> Open an <a href="https://github.com/skywinder/Github-Changelog-Generator/issues/new">issue</a> and let's make generator better together!</p>
|
|
|
|
<p><em>Bug reports, feature requests, patches, well-wishes are always welcome!</em></p>
|
|
|
|
<h2>
|
|
<a id="contributing" class="anchor" href="#contributing" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contributing</h2>
|
|
|
|
<ol>
|
|
<li>Create an issue to discuss about your idea</li>
|
|
<li><a href="https://github.com/skywinder/Github-Changelog-Generator/fork">Fork it</a></li>
|
|
<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
|
|
<li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
|
|
<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
|
|
<li>Create a new Pull Request</li>
|
|
</ol>
|
|
|
|
<h2>
|
|
<a id="license" class="anchor" href="#license" aria-hidden="true"><span class="octicon octicon-link"></span></a>License</h2>
|
|
|
|
<p>Github Changelog Generator is released under the <a href="http://www.opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
</section>
|
|
<footer>
|
|
<p><small>Hosted on <a href="http://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
|
|
</footer>
|
|
</div>
|
|
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
|
|
<script type="text/javascript">
|
|
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
</script>
|
|
<script type="text/javascript">
|
|
try {
|
|
var pageTracker = _gat._getTracker("UA-52127948-2");
|
|
pageTracker._trackPageview();
|
|
} catch(err) {}
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|