<aid="changelog-generation-has-never-been-so-easy"class="anchor"href="#changelog-generation-has-never-been-so-easy"aria-hidden="true"><spanclass="octicon octicon-link"></span></a>Changelog generation has never been so easy:</h3>
<p><strong>Fully automate changelog generation</strong> - This gem generate change log file based on <strong>tags</strong>, <strong>issues</strong> and merged <strong>pull requests</strong> (and split them to separate lists according labels) from <imgclass="emoji"title=":octocat:"alt=":octocat:"src="https://assets-cdn.github.com/images/icons/emoji/octocat.png"height="20"width="20"align="absmiddle"> GitHub Issue Tracker.</p>
<p>Since now you don't have to fill your <code>CHANGELOG.md</code> manually: just run script, relax and take a cup of <imgclass="emoji"title=":coffee:"alt=":coffee:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/2615.png"height="20"width="20"align="absmiddle"> before your next release! <imgclass="emoji"title=":tada:"alt=":tada:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f389.png"height="20"width="20"align="absmiddle"></p>
<blockquote>
<h3>
<aid="whats-the-point-of-a-change-log"class="anchor"href="#whats-the-point-of-a-change-log"aria-hidden="true"><spanclass="octicon octicon-link"></span></a><em>What’s the point of a change log?</em>
</h3>
<p>To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.</p>
<h3>
<aid="why-should-i-care"class="anchor"href="#why-should-i-care"aria-hidden="true"><spanclass="octicon octicon-link"></span></a><em>Why should I care?</em>
</h3>
<p>Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.</p>
<li>Look at <strong><ahref="https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md">CHANGELOG.md</a></strong> for this project</li>
<li>
<p><ahref="https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md">ActionSheetPicker-3.0/CHANGELOG.md</a> was generated by command:</p>
<li><p>PrettyPrint class is included using lowercase 'pp' <ahref="https://github.com/skywinder/Github-Changelog-Generator/pull/43">#43</a> (<ahref="https://github.com/schwing">schwing</a>)</p></li>
<li><p>support enterprise github via command line options <ahref="https://github.com/skywinder/Github-Changelog-Generator/pull/42">#42</a> (<ahref="https://github.com/glenlovett">glenlovett</a>)</p></li>
-t, --token [TOKEN] To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
<p>Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (<code>-t, --token</code> option)</p>
<aid="features-and-advantages-of-this-project"class="anchor"href="#features-and-advantages-of-this-project"aria-hidden="true"><spanclass="octicon octicon-link"></span></a>Features and advantages of this project</h2>
<li>Possible to generate <strong>Unreleased</strong> changes (closed issues that have not released yet) <imgclass="emoji"title=":dizzy:"alt=":dizzy:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f4ab.png"height="20"width="20"align="absmiddle">
<strong>GitHub Enterprise support</strong> via command line options! <imgclass="emoji"title=":factory:"alt=":factory:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f3ed.png"height="20"width="20"align="absmiddle">
<strong>Customize</strong> issues, that <strong>should be added</strong> to changelog <imgclass="emoji"title=":eight_spoked_asterisk:"alt=":eight_spoked_asterisk:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/2733.png"height="20"width="20"align="absmiddle">
<strong>Custom date format</strong> supported <imgclass="emoji"title=":date:"alt=":date:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f4c5.png"height="20"width="20"align="absmiddle">
</li>
<li>Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting <code>milestone</code> of issue the same name as tag of required version <imgclass="emoji"title=":pushpin:"alt=":pushpin:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f4cc.png"height="20"width="20"align="absmiddle">
</li>
<li>Automatically <strong>exclude specific issues</strong>, not-related to change log (any issue, that has label <code>question</code><code>duplicate</code><code>invalid</code><code>wontfix</code>by default) <imgclass="emoji"title=":scissors:"alt=":scissors:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/2702.png"height="20"width="20"align="absmiddle">
<li><p>You manually can set which labels should be included/excluded. <imgclass="emoji"title=":wrench:"alt=":wrench:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f527.png"height="20"width="20"align="absmiddle"></p></li>
<li>Apply a lot of other customisations, to fit changelog for your personal style <imgclass="emoji"title=":tophat:"alt=":tophat:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f3a9.png"height="20"width="20"align="absmiddle">
(<em>look <code>github_changelog_generator --help</code> for details)</em>
<p>Here is a <ahref="https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives">wikipage list of alternatives</a>, that I found. But no one was satisfy my requirements.</p>
<p><em>If you know other projects - feel free to edit this Wiki page!</em></p>
<h3>
<aid="projects-using-this-library"class="anchor"href="#projects-using-this-library"aria-hidden="true"><spanclass="octicon octicon-link"></span></a>Projects using this library</h3>
<p><ahref="https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator">Wikipage with list of projects</a></p>
<p><em>If you are using <code>github_changelog_generator</code> for generation change log in your project or know another project that uses it, please add it to <ahref="https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator">this</a> list.</em></p>
<aid="am-i-missed-some-essential-feature"class="anchor"href="#am-i-missed-some-essential-feature"aria-hidden="true"><spanclass="octicon octicon-link"></span></a>Am I missed some essential feature?</h2>
<li><p><strong>Nothing is impossible!</strong></p></li>
<li><p>Open an <ahref="https://github.com/skywinder/Github-Changelog-Generator/issues/new">issue</a> and let's make generator better together! </p></li>
<li><p><em>Bug reports, feature requests, patches, well-wishes are always welcome</em><imgclass="emoji"title=":heavy_exclamation_mark:"alt=":heavy_exclamation_mark:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/2757.png"height="20"width="20"align="absmiddle"></p></li>
<li><strong><em>I already use GitHub Releases. Why do I need this?</em></strong></li>
</ul>
<p>GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! <imgclass="emoji"title=":congratulations:"alt=":congratulations:"src="https://assets-cdn.github.com/images/icons/emoji/unicode/3297.png"height="20"width="20"align="absmiddle"></p>
<p>I'm not try to compare quality of auto-generated and manually generated logs.</p>
<p>When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by # in <code>CHANGELOG.md</code>.</p>
<ul>
<li>it's not so quite easy to find it in manually filled Releases notes.</li>
<li>this file can also help you to build your Release note and not miss features in manually-filled list.</li>
</ul>
<p>In the end:</p>
<p>I think, that GitHub Releases is more for end-users.
But <code>CHANGELOG.md</code> could stay in the repo for developers with detailed list of changes.
And it's nothing bad to combine GitHub Releases and <code>CHANGELOG.md</code> file together in that manner.</p>
