github_changelog_generator 1.15.0.pre.rc → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec76ed478bd8c2cf2500a55c75c1a9f12ffc46d6
-  data.tar.gz: 50192107d5f4ef52815262e08980c01a4c348781
+SHA256:
+  metadata.gz: 2ccac267908f4f46f4660f682da9b2d83f3b14e84f987a2c8929c59a928684e3
+  data.tar.gz: ca7866e9ebed6bbfe7dcfd637a63330dafec2d13602a47917faf84ff1cbde656
 SHA512:
-  metadata.gz: 2e40ddcaeb4205c6b44aee5ed18728eba7f6b27423055746edd39b180267d41276b86074dfc7d4c612f65f2218553a7d8fe6ccace873fbc7dd2b025f28dddad6
-  data.tar.gz: 79270b1372d108a8645a246933219804595e88c9226202736926ab511cc0cd780e2bff5654fe32d408363a34904bd5d92e24e39aff8eda49aa7225ee961b51ec
+  metadata.gz: d362fbc5862e8170d82175a6e9adf15eae99b578d894b7df7c15531e80326e17947a5c8f88d2964900a296d9760a53ef339d598de2cf2b703242fb391c805457
+  data.tar.gz: 3e38da7c8a091c7efc681c295f7d6467a227579cddff107a28f7a51a50c8d808008e012a457afd9faa6f92f2021dac648d634ab04aac4958acb54934f40085f5

data/LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016-2017 Petr Korolev
+Copyright (c) 2016-2019 Petr Korolev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,35 +1,49 @@
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
-[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
-[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
-[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
-[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
-[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
+[![CircleCI](https://circleci.com/gh/github-changelog-generator/github-changelog-generator.svg?style=svg)](https://circleci.com/gh/github-changelog-generator/github-changelog-generator)
+[![Inline docs](http://inch-ci.org/github/github-changelog-generator/github-changelog-generator.svg)](http://inch-ci.org/github/github-changelog-generator/github-changelog-generator)
 [![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
-==================
-
-  - [Installation](#installation)
-  - [Output example](#output-example)
-  - [Usage](#usage)
-    - [Params](#params)
-    - [GitHub token](#github-token)
-  - [Features and advantages of this project](#features-and-advantages-of-this-project)
-    - [Alternatives](#alternatives)
-    - [Projects using this library](#projects-using-this-library)
-  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
-  - [Contributing](#contributing)
-  - [License](#license)
+# github-changelog-generator ![GitHub Logo](../master/images/logo.jpg)
+
+<!--
+To update TOC, please run:
+> doctoc ./README.md --github
+ -->
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+  - [Changelog generation has never been so easy](#changelog-generation-has-never-been-so-easy)
+  - [*What’s the point of a changelog?*](#whats-the-point-of-a-changelog)
+  - [*Why should I care?*](#why-should-i-care)
+- [Installation](#installation)
+- [Running with Docker](#running-with-docker)
+- [Output example](#output-example)
+- [Usage](#usage)
+  - [Params](#params)
+  - [Params File](#params-file)
+  - [GitHub token](#github-token)
+- [Migrating from a manual changelog](#migrating-from-a-manual-changelog)
+  - [Rake task](#rake-task)
+- [Features and advantages of this project](#features-and-advantages-of-this-project)
+  - [Using the summary section feature](#using-the-summary-section-feature)
+  - [Alternatives](#alternatives)
+  - [Projects using this library](#projects-using-this-library)
+- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+- [FAQ](#faq)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 
 ### Changelog generation has never been so easy
 
-**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
 
 Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
 
-### *What’s the point of a change log?*
+### *What’s the point of a changelog?*
 
 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.
 
@@ -39,61 +53,84 @@ Because software tools are for _people_. "Changelogs make it easier for users an
 contributors to see precisely what notable changes have been made between each
 release (or version) of the project."
 
-:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+:arrow_right: *[https://keepachangelog.com](https://keepachangelog.com)*
 
 ## Installation
 
-    gem install github_changelog_generator
+GitHub Changelog Generator is a [Ruby](https://www.ruby-lang.org/)
+program, distributed as a RubyGem. The Ruby language homepage has an [Installation page](https://www.ruby-lang.org/en/documentation/installation/).
+
+Install the gem like:
+
+    $ gem install github_changelog_generator
+
+Depending on your system, you _may_ need to run the shell as an Administrator (Windows),
+or use `sudo gem install github_changelog_generator` (Linux).
+
+
+## Usage
+
+
+### Running with CLI:
+
+	   github_changelog_generator -u github_project_namespace -p github_project
+
+(where the project namespace is _likely_ your username if it's a project you own, but it could also be the namespace of the project)
+
+
+### Running with Docker
+
+Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
+
+Example invocation:
+
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator
+
+
+
+- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
+
+       $ github_changelog_generator --github-site="https://github.yoursite.com" \
+                                  --github-api="https://github.yoursite.com/api/v3/"
+
+
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
 
-See also Troubleshooting.
 
 ## Output example
 
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
-- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+- Look at **[CHANGELOG.md](https://github.com/github-changelog-generator/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/develop/CHANGELOG.md) was generated by command:
 
-      github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+      $ github_changelog_generator -u github-changelog-generator -p ActionSheetPicker-3.0
 
 - In general, it looks like this:
 
-> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+> ## [1.2.5](https://github.com/github-changelog-generator/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
 >
-> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+> [Full Changelog](https://github.com/github-changelog-generator/Github-Changelog-Generator/compare/1.2.4...1.2.5)
 >
 > **Implemented enhancements:**
 >
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/github-changelog-generator/Github-Changelog-Generator/issues/22)
 >
 > **Fixed bugs:**
 >
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/github-changelog-generator/Github-Changelog-Generator/issues/32)
 >
 > **Merged pull requests:**
 >
-> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/github-changelog-generator/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
 >
-> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-
-
-## Usage
-
--  Run this:
-
-      `github_changelog_generator -u github_username -p github_project`
-      `github_changelog_generator  github_username/github_project`
-
-- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-
-      github_changelog_generator --github-site="https://github.yoursite.com" \
-                                 --github-api="https://github.yoursite.com/api/v3/"
-
-This generates a `CHANGELOG.md`, with pretty Markdown formatting.
+> - support enterprise github via command line options [\#42](https://github.com/github-changelog-generator/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
 ### Params
 
-Type `github_changelog_generator --help` for details.
+Print help for all command-line options to learn more details:
+
+    $ github_changelog_generator --help
 
-For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+For more details about params, read the Wiki page: [**Advanced changelog generation examples**](https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
 
 ### Params File
 
@@ -109,7 +146,7 @@ since-tag=1.0.0
 
 ### GitHub token
 
-GitHub only allows 50 unauthenticated requests per hour.
+GitHub only allows **50 unauthenticated requests per hour**.
 
 Therefore, it's recommended to run this script with authentication by using a **token**.
 
@@ -120,7 +157,7 @@ Here's how:
     - Run the script with `--token <your-40-digit-token>`; **OR**
     - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
 
-You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `.env`, `~/.bash_profile`, `~/.zshrc`, etc):
 
     export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
 
@@ -154,6 +191,8 @@ Configure the task in your `Rakefile`:
 require 'github_changelog_generator/task'
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'username'
+  config.project = 'project-name'
   config.since_tag = '0.1.14'
   config.future_release = '0.2.0'
 end
@@ -163,11 +202,11 @@ All command-line options can be passed to the `rake` task as `config`
 parameters. And since you're naming the `rake` task yourself, you can create
 as many as you want.
 
-You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
+You can look for params names from the [parser source code (#setup_parser)](https://github.com/github-changelog-generator/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
 
 ## Features and advantages of this project
 
-- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+- Generate canonical, neat changelog file, with default sections that follow [basic changelog guidelines](http://keepachangelog.com) :gem:
 - Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
 - **GitHub Enterprise support** via command line options! :factory:
 - Flexible format **customization**:
@@ -185,27 +224,53 @@ You can look for params names from the [parser source code (#setup_parser)](http
 - Customize lots more! Tweak the changelog to fit your preferences :tophat:
 (*See `github_changelog_generator --help`  for details)*
 
+### Using the summary section feature
+
+For each version, you can add a _release summary_ with text, images, gif animations,
+etc, and show new features and notes clearly to the user. This is done using GitHub metadata.
+
+**Example**: adding the release summary for v1.0.0:
+
+1. Create a new GitHub Issue
+2. In the Issue's _Description_ field, add your release summary content
+```
+![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png)
+
+Hello, World! :tada:
+```
+3. Set the Issue Label `release-summary` and add it to the GitHub Milestone `v1.0.0`
+4. Close the Issue and execute `github-changelog-generator`
+5. The result looks like this:
+> ## [v1.0.0](https://github.com/github-changelog-generator/github-changelog-generator/tree/1.0.0) (2014-11-07)
+> [Full Changelog](https://github.com/github-changelog-generator/github-changelog-generator/compare/0.1.0...1.0.0)
+>
+> ![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png)
+>
+> Hello, World! :tada:
+>
+> **Implemented enhancements:**
+> - Add some features
 
 ### Alternatives
 
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+Here is a [wikipage list of alternatives](https://github.com/github-changelog-generator/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
 
 *If you know other projects, feel free to edit this Wiki page!*
 
 
 ### Projects using this library
 
-Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+Here's a [wikipage list of projects](https://github.com/github-changelog-generator/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
 
 If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
 
-*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list](https://github.com/skywinder/github-changelog-generator/wiki/Projects-using-Github-Changelog-Generator).*
+*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list](https://github.com/github-changelog-generator/github-changelog-generator/wiki/Projects-using-Github-Changelog-Generator).*
 
 ## Am I missing some essential feature?
 
 - **Nothing is impossible!**
 
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+- Open an [issue](https://github.com/github-changelog-generator/Github-Changelog-Generator/issues/new) and let's make the generator better together!
 
 - *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
 
@@ -215,33 +280,12 @@ If you've used this project in a live app, please let me know! Nothing makes me
 
 GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
 
-*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/github-changelog-generator/github-changelog-generator/issues/56) ;)*
 
 I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
 
 An auto-generated changelog really helps, even if you manually fill in the release notes!
 
-For example:
-
-When you find a closed bug, it is very useful to know which release fixed it.
-So that you can easily find the issue by \# in `CHANGELOG.md`.
-
-- it's not quite as easy to find this in handwritten releases notes
-- a generated file saves you the trouble of remembering everything;
-  sometimes people forget to add things to a handwritten file
-
-Ultimately, I think GitHub Releases are ideal for end-users.
-Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-
-- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
-
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
-
-If you're seeing this warning, please do the following:
-
-1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
-2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
 - ***My Ruby version is very old, can I use this?***
 
@@ -268,12 +312,21 @@ gem 'rack', '~> 1.6'
 This way, you can keep on using github_changelog_generator, even if you
 can't get the latest version of Ruby installed.
 
+- ***Windows: 1.14.x wants to create a file on an invalid path. Why?***
+
+Windows: [v1.14.0 introduced a bug where it attempts to create /tmp/github_changelog-logger.log... which isn't a valid path on Windows and thus fails](https://github.com/github-changelog-generator/github-changelog-generator/issues/458)
+
+Workaround: Create a `C:\tmp`.
+
 ## Contributing
 
 We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
 
 [CONTRIBUTING.md]: CONTRIBUTING.md
 
+## Contact us
+[Join the chat at gitter : github-changelog-generator](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ## License
 
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -13,7 +13,7 @@ RSpec::Core::RakeTask.new
 
 desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
 task :update_ssl_ca_file do
-  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
+  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.se/ca/cacert.pem && popd`
 end
 
 task default: %i[rubocop spec]

data/bin/git-generate-changelog

@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../lib/github_changelog_generator"

data/lib/github_changelog_generator.rb

@@ -22,22 +22,26 @@ require "github_changelog_generator/reader"
 module GitHubChangelogGenerator
   # Main class and entry point for this script.
   class ChangelogGenerator
-    # Class, responsible for whole change log generation cycle
+    # Class, responsible for whole changelog generation cycle
     # @return initialised instance of ChangelogGenerator
     def initialize
       @options = Parser.parse_options
       @generator = Generator.new @options
     end
 
-    # The entry point of this script to generate change log
+    # The entry point of this script to generate changelog
     # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
     def run
       log = @generator.compound_changelog
 
-      output_filename = @options[:output].to_s
-      File.open(output_filename, "wb") { |file| file.write(log) }
-      puts "Done!"
-      puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+      if @options.write_to_file?
+        output_filename = @options[:output].to_s
+        File.open(output_filename, "wb") { |file| file.write(log) }
+        puts "Done!"
+        puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+      else
+        puts log
+      end
     end
   end
 end

data/lib/github_changelog_generator/argv_parser.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "github_changelog_generator/version"
+
+module GitHubChangelogGenerator
+  class ArgvParser
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def parse!(argv)
+      parser.parse(argv)
+    rescue OptionParser::ParseError => e
+      warn [e, parser].join("\n")
+      Kernel.abort
+    end
+
+    def parser
+      @parser ||= 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 the target GitHub repo OR the namespace of target Github repo if owned by an organization.") do |last|
+          options[:user] = last
+        end
+        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|
+          options[:date_format] = last
+        end
+        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. Default is HISTORY.md") do |last|
+          options[:base] = last
+        end
+        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", "Set up custom label for enhancements section. Default is \"**Implemented enhancements:**\".") do |v|
+          options[:enhancement_prefix] = v
+        end
+        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("--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", "Set up custom header label. Default is \"# Changelog\".") do |v|
+          options[:header] = v
+        end
+        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", "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|
+          options[:issues] = v
+        end
+        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|
+          options[:add_pr_wo_labels] = v
+        end
+        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|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on("--[no-]issues-of-open-milestones", "Include issues of open milestones. Default is true.") do |v|
+          options[:issues_of_open_milestones] = v
+        end
+        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|
+          options[:usernames_as_github_logins] = v
+        end
+        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|
+          options[:unreleased] = v
+        end
+        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|
+          options[:compare_link] = v
+        end
+        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 excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.") do |list|
+          options[:exclude_labels] = list
+        end
+        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 added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'.') do |list|
+          options[:enhancement_labels] = list
+        end
+        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("--include-tags-regex REGEX", "Apply a regular expression on tag names so that they can be included, for example: --include-tags-regex \".*\+\d{1,}\".") do |last|
+          options[:include_tags_regex] = last
+        end
+        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|
+          options[:exclude_tags_regex] = last
+        end
+        opts.on("--since-tag  x", "Changelog will start after specified tag.") do |v|
+          options[:since_tag] = v
+        end
+        opts.on("--due-tag  x", "Changelog will end before specified tag.") do |v|
+          options[:due_tag] = v
+        end
+        opts.on("--since-commit  x", "Fetch only commits after this time. eg. \"2017-01-01 10:00:00\"") do |v|
+          options[:since_commit] = v
+        end
+        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 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|
+          options[:github_endpoint] = last
+        end
+        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|
+          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|
+          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|
+          options[:cache_file] = cache_file
+        end
+        opts.on("--cache-log CACHE-LOG", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
+          options[:cache_log] = cache_log
+        end
+        opts.on("--config-file CONFIG-FILE", "Path to configuration file. Default is .github_changelog_generator.") do |config_file|
+          options[:config_file] = config_file
+        end
+        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 before generating changelog.") do |paths|
+          options[:require] = paths
+        end
+        opts.on("--[no-]verbose", "Run verbosely. Default is true.") do |v|
+          options[:verbose] = v
+        end
+        opts.on("-v", "--version", "Print version number.") do |_v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on("-h", "--help", "Displays Help.") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    class << self
+      def banner
+        new.parser.banner
+      end
+    end
+  end
+end