github_changelog_generator 1.15.0.pre.rc → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec76ed478bd8c2cf2500a55c75c1a9f12ffc46d6
-  data.tar.gz: 50192107d5f4ef52815262e08980c01a4c348781
+SHA256:
+  metadata.gz: 7ee18824228b1ec5cade4842046046452afa0c4a0cab01ee3c52f86b60206cfb
+  data.tar.gz: 2c6df785e4d34d416255d1949e58a3a2668453e1a8246ae706989ddf17442bd7
 SHA512:
-  metadata.gz: 2e40ddcaeb4205c6b44aee5ed18728eba7f6b27423055746edd39b180267d41276b86074dfc7d4c612f65f2218553a7d8fe6ccace873fbc7dd2b025f28dddad6
-  data.tar.gz: 79270b1372d108a8645a246933219804595e88c9226202736926ab511cc0cd780e2bff5654fe32d408363a34904bd5d92e24e39aff8eda49aa7225ee961b51ec
+  metadata.gz: cd20b1b8916d83db50428dbe899c346d1a2b2ca1b26427fdc9997b2edf7604db530b9372c4461f443f4e7f0fc0133c6bd01b8643b1ec066cd1c80c4d0657ca3e
+  data.tar.gz: 41169d141f512dbecc520251f50fb9db63d4df6160621c5b8598dabf31095d9b75ae7b3aeab1bc126ac9fc5e5a71131026235bce4acb8661ed29744e6a246fa0

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,54 @@
 [![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)
+
+#### Update:
+
+🖖 Keep it alive: We need more Collaborators to github-changelog-generator [#727](https://github.com/github-changelog-generator/github-changelog-generator/issues/727)
+
+---
+<!--
+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 +58,83 @@ 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).
+
+## Running with Docker
+
+Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
+
+`ferrarimarco` has made a Docker image available that you can use.
 
-See also Troubleshooting.
+Example invocation:
+
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator
 
 ## 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))
+> - support enterprise github via command line options [\#42](https://github.com/github-changelog-generator/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`
+	   $ github_changelog_generator -u github_username -p github_project
+
+	or, on the 1.14.x (current stable release)
+
+	   $ 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/"
+       $ 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.
 
 ### 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
 
@@ -154,6 +195,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 +206,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 +228,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,7 +284,7 @@ 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....
 
@@ -226,15 +295,15 @@ 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
+- 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?***
+- ***I got an "API rate limit exceeded" error message. 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).
 
@@ -268,6 +337,12 @@ 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].

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/generator/entry.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/generator/section"
+
+module GitHubChangelogGenerator
+  # This class generates the content for a single changelog entry. An entry is
+  # generally either for a specific tagged release or the collection of
+  # unreleased changes.
+  #
+  # An entry is comprised of header text followed by a series of sections
+  # relating to the entry.
+  #
+  # @see GitHubChangelogGenerator::Generator
+  # @see GitHubChangelogGenerator::Section
+  class Entry
+    attr_reader :content
+
+    def initialize(options = Options.new({}))
+      @content = ""
+      @options = Options.new(options)
+    end
+
+    # Generates log entry with header and body
+    #
+    # @param [Array] pull_requests List or PR's in new section
+    # @param [Array] issues List of issues in new section
+    # @param [String] newer_tag_name Name of the newer tag. Could be nil for `Unreleased` section.
+    # @param [String] newer_tag_link Name of the newer tag. Could be "HEAD" for `Unreleased` section.
+    # @param [Time] newer_tag_time Time of the newer tag
+    # @param [Hash, nil] older_tag_name Older tag, used for the links. Could be nil for last tag.
+    # @return [String] Ready and parsed section content.
+    def generate_entry_for_tag(pull_requests, issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name) # rubocop:disable Metrics/ParameterLists
+      github_site = @options[:github_site] || "https://github.com"
+      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
+
+      create_sections
+
+      @content = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+      @content += generate_body(pull_requests, issues)
+      @content
+    end
+
+    private
+
+    # Creates section objects for this entry.
+    # @return [Nil]
+    def create_sections
+      @sections = if @options.configure_sections?
+                    parse_sections(@options[:configure_sections])
+                  elsif @options.add_sections?
+                    default_sections.concat parse_sections(@options[:add_sections])
+                  else
+                    default_sections
+                  end
+      nil
+    end
+
+    # Turns the argument from the commandline of --configure-sections or
+    # --add-sections into an array of Section objects.
+    #
+    # @param [String, Hash] sections_desc Either string or hash describing sections
+    # @return [Array] Parsed section objects.
+    def parse_sections(sections_desc)
+      require "json"
+
+      sections_desc = sections_desc.to_json if sections_desc.class == Hash
+
+      begin
+        sections_json = JSON.parse(sections_desc)
+      rescue JSON::ParserError => e
+        raise "There was a problem parsing your JSON string for sections: #{e}"
+      end
+
+      sections_json.collect do |name, v|
+        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
+      end
+    end
+
+    # Generates header text for an entry.
+    #
+    # @param [String] newer_tag_name The name of a newer tag
+    # @param [String] newer_tag_link Used for URL generation. Could be same as #newer_tag_name or some specific value, like HEAD
+    # @param [Time] newer_tag_time Time when the newer tag was created
+    # @param [String] older_tag_name The name of an older tag; used for URLs.
+    # @param [String] project_url URL for the current project.
+    # @return [String] Header text content.
+    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+      header = ""
+
+      # Generate date string:
+      time_string = newer_tag_time.strftime(@options[:date_format])
+
+      # Generate tag name and link
+      release_url = if @options[:release_url]
+                      format(@options[:release_url], newer_tag_link)
+                    else
+                      "#{project_url}/tree/#{newer_tag_link}"
+                    end
+      header += if newer_tag_name.equal?(@options[:unreleased_label])
+                  "## [#{newer_tag_name}](#{release_url})\n\n"
+                else
+                  "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
+                end
+
+      if @options[:compare_link] && older_tag_name
+        # Generate compare link
+        header += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_link})\n\n"
+      end
+
+      header
+    end
+
+    # Generates complete body text for a tag (without a header)
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [String] Content generated from sections of sorted issues & PRs.
+    def generate_body(pull_requests, issues)
+      sort_into_sections(pull_requests, issues)
+      @sections.map(&:generate_content).join
+    end
+
+    # Default sections to used when --configure-sections is not set.
+    #
+    # @return [Array] Section objects.
+    def default_sections
+      [
+        Section.new(name: "summary", prefix: @options[:summary_prefix], labels: @options[:summary_labels], options: @options, body_only: true),
+        Section.new(name: "breaking", prefix: @options[:breaking_prefix], labels: @options[:breaking_labels], options: @options),
+        Section.new(name: "enhancements", prefix: @options[:enhancement_prefix], labels: @options[:enhancement_labels], options: @options),
+        Section.new(name: "bugs", prefix: @options[:bug_prefix], labels: @options[:bug_labels], options: @options),
+        Section.new(name: "deprecated", prefix: @options[:deprecated_prefix], labels: @options[:deprecated_labels], options: @options),
+        Section.new(name: "removed", prefix: @options[:removed_prefix], labels: @options[:removed_labels], options: @options),
+        Section.new(name: "security", prefix: @options[:security_prefix], labels: @options[:security_labels], options: @options)
+      ]
+    end
+
+    # Sorts issues and PRs into entry sections by labels and lack of labels.
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [Nil]
+    def sort_into_sections(pull_requests, issues)
+      if @options[:issues]
+        unmapped_issues = sort_labeled_issues(issues)
+        add_unmapped_section(unmapped_issues)
+      end
+      if @options[:pulls]
+        unmapped_pull_requests = sort_labeled_issues(pull_requests)
+        add_unmapped_section(unmapped_pull_requests)
+      end
+      nil
+    end
+
+    # Iterates through sections and sorts labeled issues into them based on
+    # the label mapping. Returns any unmapped or unlabeled issues.
+    #
+    # @param [Array] issues Issues or pull requests.
+    # @return [Array] Issues that were not mapped into any sections.
+    def sort_labeled_issues(issues)
+      sorted_issues = []
+      issues.each do |issue|
+        label_names = issue["labels"].collect { |l| l["name"] }
+
+        # Add PRs in the order of the @sections array. This will either be the
+        # default sections followed by any --add-sections sections in
+        # user-defined order, or --configure-sections in user-defined order.
+        # Ignore the order of the issue labels from github which cannot be
+        # controled by the user.
+        @sections.each do |section|
+          unless (section.labels & label_names).empty?
+            section.issues << issue
+            sorted_issues << issue
+            break
+          end
+        end
+      end
+      issues - sorted_issues
+    end
+
+    # Creates a section for issues/PRs with no labels or no mapped labels.
+    #
+    # @param [Array] issues
+    # @return [Nil]
+    def add_unmapped_section(issues)
+      unless issues.empty?
+        # Distinguish between issues and pull requests
+        if issues.first.key?("pull_request")
+          name = "merged"
+          prefix = @options[:merge_prefix]
+          add_wo_labels = @options[:add_pr_wo_labels]
+        else
+          name = "issues"
+          prefix = @options[:issue_prefix]
+          add_wo_labels = @options[:add_issues_wo_labels]
+        end
+        add_issues = if add_wo_labels
+                       issues
+                     else
+                       # Only add unmapped issues
+                       issues.select { |issue| issue["labels"].any? }
+                     end
+        merged = Section.new(name: name, prefix: prefix, labels: [], issues: add_issues, options: @options) unless add_issues.empty?
+        @sections << merged
+      end
+      nil
+    end
+
+    def line_labels_for(issue)
+      labels = if @options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
+  end
+end