github_changelog_generator 1.16.4 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36cb65499e406ed1e554d4239e9d36806888d1ca9c3fe0f47e0e8e49053dd2b9
-  data.tar.gz: 991b1251d601d2504d2c610087b43d0deaebbe7f031987eda8dc5a84e7ac46cb
+  metadata.gz: e07c565356c5e5e983b771c56833c9579afd0d174ca6930a70699e38486afb8d
+  data.tar.gz: f9fca1bd85bef606332a6da07c01f093adbecd7a26256c6826a593d8b15a5ebb
 SHA512:
-  metadata.gz: d5d733ce47da1d762b8dd3c4513989955ecd1adfe973ba044baef80fec2917d621841e9779d97b8298f04cd5b05d64c97d78cc872ba73d9b46ed2db3ae709344
-  data.tar.gz: ecfad19e0066fb2e9ddbdbc6c514f1c86bf57c6ff0704999adc05a181812fc182469ad77ba7d9fdabe1cbf06adff20680df06b0121c35e602c27222cab983106
+  metadata.gz: a312859c596e52e04c52d9fef05b2552f64c6efc8117b7c948451566ac2de67416407d3aaed0a675ece080cbf6ebda41b0ed65db3154427525f8896e6829ba94
+  data.tar.gz: 3f44449ed200a68d14670f471a81a36932a2ec171b6b8c44362bc554f3d2aadf484e882eb61888e599d20df362e851d850b861103441ce0d8be3df975b8cc128

data/README.md

@@ -1,6 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/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)
+[![Ruby CI](https://github.com/github-changelog-generator/github-changelog-generator/actions/workflows/test.yml/badge.svg)](https://github.com/github-changelog-generator/github-changelog-generator/actions/workflows/test.yml)
 [![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)
@@ -12,14 +11,14 @@ To update TOC, please run:
 <!-- 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)
+  - [Running with CLI:](#running-with-cli)
+  - [Running with Docker](#running-with-docker)
+- [Output example](#output-example)
   - [Params](#params)
   - [Params File](#params-file)
   - [GitHub token](#github-token)
@@ -29,9 +28,12 @@ To update TOC, please run:
   - [Using the summary section feature](#using-the-summary-section-feature)
   - [Alternatives](#alternatives)
   - [Projects using this library](#projects-using-this-library)
+- [Practical Use Cases](#practical-use-cases)
+  - [Creating GitHub Release Notes](#creating-github-release-notes)
 - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
 - [FAQ](#faq)
 - [Contributing](#contributing)
+- [Contact us](#contact-us)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -99,30 +101,30 @@ This generates a `CHANGELOG.md`, with pretty Markdown formatting.
 
 ## Output example
 
-- Look at **[CHANGELOG.md](https://github.com/github-changelog-generator/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- 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 github-changelog-generator -p ActionSheetPicker-3.0
 
 - In general, it looks like this:
 
-> ## [1.2.5](https://github.com/github-changelog-generator/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/github-changelog-generator/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/github-changelog-generator/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/github-changelog-generator/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/github-changelog-generator/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/github-changelog-generator/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))
 
 ### Params
 
@@ -219,6 +221,7 @@ You can look for params names from the [parser source code (#setup_parser)](http
     - Bug fixes (issues labeled `bug`) :beetle:
     - Enhancements (issues labeled `enhancement`) :star2:
     - Issues (closed issues with no labels) :non-potable_water:
+    - Plus any additional custom label-to-section mappings you want :gear:
 
 - Manually include or exclude issues by labels :wrench:
 - Customize lots more! Tweak the changelog to fit your preferences :tophat:
@@ -253,24 +256,46 @@ Hello, World! :tada:
 
 ### Alternatives
 
-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.
+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/github-changelog-generator/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/github-changelog-generator/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).*
+
+## Practical Use Cases
+
+### Creating GitHub Release Notes
+
+`github_changelog_generator` can be used in combination with the [github cli](https://cli.github.com/) to create release notes.  Use the `--since-tag` and `--output` options of `github_changelog_generator` to create a changelog for the current release and store the results in a file.  In the
+example below, version `2.0.0` is the current release and version `1.0.0` is the previous release.
+
+```
+mkdir -p build
+github_changelog_generator \
+  --since-tag 1.0.0 \
+  --output build/changelog.md
+```
+
+Then use the [release create](https://cli.github.com/manual/gh_release_create) feature of the github cli to create a new github release
+
+```
+gh release create 2.0.0 \
+  --notes-file build/changelog.md \
+  --title 2.0.0
+```
 
 ## Am I missing some essential feature?
 
 - **Nothing is impossible!**
 
-- Open an [issue](https://github.com/github-changelog-generator/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/choose) and let's make the generator better together!
 
 - *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
 
@@ -286,6 +311,17 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th
 
 An auto-generated changelog really helps, even if you manually fill in the release notes!
 
+- **I want to define my own label-to-section mapping, how can I do it?**
+
+This is possible using either the ``add-sections`` or ``configure-sections``
+entry in ``.github_changelog_generator``. For example, to add a single new
+entry called "Maintenance" that will catch PRs tagged with your ``maintenance``
+label, you can add to ``.github_changelog_generator`` the line:
+```
+add-sections= {"maintenance":{"prefix":"**Project maintenance**","labels":["maintenance"]}}
+```
+A similar approach can be used via ``configure-sections`` to set all section
+properties (including adding new ones!).
 
 - ***My Ruby version is very old, can I use this?***
 

data/bin/github_changelog_generator

@@ -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/argv_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "optparse"
-require "github_changelog_generator/version"
+require_relative "version"
 
 module GitHubChangelogGenerator
   class ArgvParser
@@ -21,7 +21,7 @@ module GitHubChangelogGenerator
     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|
+        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|

data/lib/github_changelog_generator/file_parser_chooser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module GitHubChangelogGenerator
+  class FileParserChooser
+    def initialize(options)
+      @options = options
+      @config_file = Pathname.new(options[:config_file])
+    end
+
+    def parse!(_argv)
+      return nil unless (path = resolve_path)
+
+      ParserFile.new(@options, File.open(path)).parse!
+    end
+
+    def resolve_path
+      return @config_file if @config_file.exist?
+
+      path = @config_file.expand_path
+      return path if File.exist?(path)
+
+      nil
+    end
+  end
+end

data/lib/github_changelog_generator/generator/entry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "github_changelog_generator/generator/section"
+require_relative "section"
 
 module GitHubChangelogGenerator
   # This class generates the content for a single changelog entry. An entry is
@@ -72,7 +72,7 @@ module GitHubChangelogGenerator
     def parse_sections(sections_desc)
       require "json"
 
-      sections_desc = sections_desc.to_json if sections_desc.class == Hash
+      sections_desc = sections_desc.to_json if sections_desc.instance_of?(Hash)
 
       begin
         sections_json = JSON.parse(sections_desc)
@@ -175,7 +175,7 @@ module GitHubChangelogGenerator
         # 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.
+        # controlled by the user.
         @sections.each do |section|
           unless (section.labels & label_names).empty?
             section.issues << issue

data/lib/github_changelog_generator/generator/generator.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "github_changelog_generator/octo_fetcher"
-require "github_changelog_generator/generator/generator_fetcher"
-require "github_changelog_generator/generator/generator_processor"
-require "github_changelog_generator/generator/generator_tags"
-require "github_changelog_generator/generator/entry"
-require "github_changelog_generator/generator/section"
+require_relative "../octo_fetcher"
+require_relative "generator_fetcher"
+require_relative "generator_processor"
+require_relative "generator_tags"
+require_relative "entry"
+require_relative "section"
 
 module GitHubChangelogGenerator
   # Default error for ChangelogGenerator
@@ -76,7 +76,7 @@ module GitHubChangelogGenerator
 
       if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
         # do not generate empty unreleased section
-        return ""
+        return +""
       end
 
       newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
@@ -128,7 +128,7 @@ module GitHubChangelogGenerator
     end
 
     def generate_unreleased_entry
-      entry = ""
+      entry = +""
       if options[:unreleased]
         start_tag        = @filtered_tags[0] || @sorted_tags.last
         unreleased_entry = generate_entry_between_tags(start_tag, nil)
@@ -149,7 +149,12 @@ module GitHubChangelogGenerator
 
       fetch_events_for_issues_and_pr
       detect_actual_closed_dates(@issues + @pull_requests)
-      add_first_occurring_tag_to_prs(@sorted_tags, @pull_requests)
+      prs_left = add_first_occurring_tag_to_prs(@sorted_tags, @pull_requests)
+
+      # PRs in prs_left will be untagged, not in release branch, and not
+      # rebased. They should not be included in the changelog as they probably
+      # have been merged to a branch other than the release branch.
+      @pull_requests -= prs_left
       nil
     end
 
@@ -166,7 +171,7 @@ module GitHubChangelogGenerator
     # messages of the same wording are removed.
     # @param log [String]
     def insert_fixed_string(log)
-      ins = ""
+      ins = +""
       ins += @options[:frontmatter] if @options[:frontmatter]
       ins += "#{@options[:header]}\n\n"
       log.insert(0, ins)

data/lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -48,11 +48,10 @@ module GitHubChangelogGenerator
       prs_left = associate_tagged_prs(tags, prs, total)
       prs_left = associate_release_branch_prs(prs_left, total)
       prs_left = associate_rebase_comment_prs(tags, prs_left, total) if prs_left.any?
-      # PRs in prs_left will be untagged, not in release branch, and not
-      # rebased. They should not be included in the changelog as they probably
-      # have been merged to a branch other than the release branch.
-      @pull_requests -= prs_left
+
       Helper.log.info "Associating PRs with tags: #{total}/#{total}"
+
+      prs_left
     end
 
     # Associate merged PRs by the merge SHA contained in each tag. If the
@@ -80,7 +79,7 @@ module GitHubChangelogGenerator
             print("Associating PRs with tags: #{i}/#{total}\r") if @options[:verbose]
           end
         else
-          # Either there were no events or no merged event. Github's api can be
+          # Either there were no events or no merged event. GitHub's api can be
           # weird like that apparently. Check for a rebased comment before erroring.
           no_events_pr = associate_rebase_comment_prs(tags, [pr], total)
           raise StandardError, "No merge sha found for PR #{pr['number']} via the GitHub API" unless no_events_pr.empty?
@@ -154,15 +153,15 @@ module GitHubChangelogGenerator
     # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
     # @param [Hash] issue
     def find_closed_date_by_commit(issue)
-      unless issue["events"].nil?
-        # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
-        compare_string = issue["merged_at"].nil? ? "closed" : "merged"
-        # reverse! - to find latest closed event. (event goes in date order)
-        issue["events"].reverse!.each do |event|
-          if event["event"].eql? compare_string
-            set_date_from_event(event, issue)
-            break
-          end
+      return if issue["events"].nil?
+
+      # if it's PR -> then find "merged event", in case of usual issue -> found closed date
+      compare_string = issue["merged_at"].nil? ? "closed" : "merged"
+      # reverse! - to find latest closed event. (event goes in date order)
+      issue["events"].reverse!.each do |event|
+        if event["event"] == compare_string
+          set_date_from_event(event, issue)
+          break
         end
       end
       # TODO: assert issues, that remain without 'actual_date' hash for some reason.
@@ -175,17 +174,16 @@ module GitHubChangelogGenerator
     def set_date_from_event(event, issue)
       if event["commit_id"].nil?
         issue["actual_date"] = issue["closed_at"]
-      else
-        begin
-          commit = @fetcher.fetch_commit(event["commit_id"])
-          issue["actual_date"] = commit["commit"]["author"]["date"]
-
-          # issue['actual_date'] = commit['author']['date']
-        rescue StandardError
-          puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
-          issue["actual_date"] = issue["closed_at"]
-        end
+        return
       end
+
+      commit = @fetcher.fetch_commit(event["commit_id"])
+      issue["actual_date"] = commit["commit"]["author"]["date"]
+
+      # issue['actual_date'] = commit['author']['date']
+    rescue StandardError
+      puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
+      issue["actual_date"] = issue["closed_at"]
     end
 
     private

data/lib/github_changelog_generator/generator/generator_processor.rb

@@ -46,19 +46,13 @@ module GitHubChangelogGenerator
     # @return [Array] issues with milestone #tag_name
     def find_issues_to_add(all_issues, tag_name)
       all_issues.select do |issue|
-        if issue["milestone"].nil?
+        if (milestone = issue["milestone"]).nil?
+          false
+        # check, that this milestone in tag list:
+        elsif (tag = find_tag_for_milestone(milestone)).nil?
           false
         else
-          # check, that this milestone in tag list:
-          milestone_is_tag = @filtered_tags.find do |tag|
-            tag["name"] == issue["milestone"]["title"]
-          end
-
-          if milestone_is_tag.nil?
-            false
-          else
-            issue["milestone"]["title"] == tag_name
-          end
+          tag["name"] == tag_name
         end
       end
     end
@@ -67,18 +61,22 @@ module GitHubChangelogGenerator
     def remove_issues_in_milestones(filtered_issues)
       filtered_issues.select! do |issue|
         # leave issues without milestones
-        if issue["milestone"].nil?
+        if (milestone = issue["milestone"]).nil?
           true
         # remove issues of open milestones if option is set
-        elsif issue["milestone"]["state"] == "open"
+        elsif milestone["state"] == "open"
           @options[:issues_of_open_milestones]
         else
           # check, that this milestone in tag list:
-          @filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
+          find_tag_for_milestone(milestone).nil?
         end
       end
     end
 
+    def find_tag_for_milestone(milestone)
+      @filtered_tags.find { |tag| tag["name"] == milestone["title"] }
+    end
+
     # Method filter issues, that belong only specified tag range
     #
     # @param [Array] issues issues to filter
@@ -133,19 +131,11 @@ module GitHubChangelogGenerator
     end
 
     def tag_older_new_tag?(newer_tag_time, time)
-      if newer_tag_time.nil?
-        true
-      else
-        time <= newer_tag_time
-      end
+      newer_tag_time.nil? || time <= newer_tag_time
     end
 
     def tag_newer_old_tag?(older_tag_time, time)
-      if older_tag_time.nil?
-        true
-      else
-        time > older_tag_time
-      end
+      older_tag_time.nil? || time > older_tag_time
     end
 
     # Include issues with labels, specified in :include_labels

data/lib/github_changelog_generator/generator/generator_tags.rb

@@ -7,7 +7,7 @@ module GitHubChangelogGenerator
       since_tag
       due_tag
 
-      all_tags = @fetcher.get_all_tags
+      all_tags = @fetcher.fetch_all_tags
       fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
       all_sorted_tags = sort_tags_by_date(all_tags)
 
@@ -119,41 +119,29 @@ module GitHubChangelogGenerator
     # @param [Array] all_tags all tags
     # @return [Array] filtered tags according :since_tag option
     def filter_since_tag(all_tags)
-      filtered_tags = all_tags
-      tag = since_tag
-      if tag
-        if all_tags.map { |t| t["name"] }.include? tag
-          idx = all_tags.index { |t| t["name"] == tag }
-          filtered_tags = if idx
-                            all_tags[0..idx]
-                          else
-                            []
-                          end
-        else
-          raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --since-tag option."
-        end
+      return all_tags unless (tag = since_tag)
+
+      raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --since-tag option." if all_tags.none? { |t| t["name"] == tag }
+
+      if (idx = all_tags.index { |t| t["name"] == tag })
+        all_tags[0..idx]
+      else
+        []
       end
-      filtered_tags
     end
 
     # @param [Array] all_tags all tags
     # @return [Array] filtered tags according :due_tag option
     def filter_due_tag(all_tags)
-      filtered_tags = all_tags
-      tag           = due_tag
-      if tag
-        if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
-          idx = all_tags.index { |t| t["name"] == tag }
-          filtered_tags = if idx > 0
-                            all_tags[(idx + 1)..-1]
-                          else
-                            []
-                          end
-        else
-          raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --due-tag option."
-        end
+      return all_tags unless (tag = due_tag)
+
+      raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --due-tag option." if all_tags.none? { |t| t["name"] == tag }
+
+      if (idx = all_tags.index { |t| t["name"] == tag }) > 0
+        all_tags[(idx + 1)..]
+      else
+        []
       end
-      filtered_tags
     end
 
     # @param [Array] all_tags all tags
@@ -207,14 +195,16 @@ module GitHubChangelogGenerator
     end
 
     def warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
-      unless all_tags.map { |t| t["name"] }.any? { |t| regex =~ t }
-        Helper.log.warn "Warning: unable to reject any tag, using regex "\
-                        "#{regex.inspect} in #{regex_option_name} option."
-      end
+      return if all_tags.any? { |t| regex.match?(t["name"]) }
+
+      Helper.log.warn "Warning: unable to reject any tag, using regex "\
+                      "#{regex.inspect} in #{regex_option_name} option."
     end
 
     def warn_if_tag_not_found(all_tags, tag)
-      Helper.log.warn("Warning: can't find tag #{tag}, specified with --exclude-tags option.") unless all_tags.map { |t| t["name"] }.include?(tag)
+      return if all_tags.any? { |t| t["name"] == tag }
+
+      Helper.log.warn("Warning: can't find tag #{tag}, specified with --exclude-tags option.")
     end
   end
 end

data/lib/github_changelog_generator/generator/section.rb

@@ -39,7 +39,7 @@ module GitHubChangelogGenerator
     #
     # @return [String] Generated section content
     def generate_content
-      content = ""
+      content = +""
 
       if @issues.any?
         content += "#{@prefix}\n\n" unless @options[:simple_list] || @prefix.blank?
@@ -72,11 +72,11 @@ module GitHubChangelogGenerator
     end
 
     def issue_line_with_body(line, issue)
-      return issue["body"] if @body_only && issue["body"].present?
+      return normalize_body(issue["body"]) if @body_only && issue["body"].present?
       return line if !@options[:issue_line_body] || issue["body"].blank?
 
       # get issue body till first line break
-      body_paragraph = body_till_first_break(issue["body"])
+      body_paragraph = body_till_first_break(normalize_body(issue["body"]))
       # remove spaces from beginning of the string
       body_paragraph.rstrip!
       # encapsulate to md
@@ -85,6 +85,11 @@ module GitHubChangelogGenerator
       "**#{line}** #{encapsulated_body}"
     end
 
+    # Normalize line endings from CRLF to LF
+    def normalize_body(body)
+      body.gsub(/\r?\n/, "\n")
+    end
+
     def body_till_first_break(body)
       body.split(/\n/, 2).first
     end
@@ -109,7 +114,7 @@ module GitHubChangelogGenerator
     # @param [String] string
     # @return [String] encapsulated input string
     def encapsulate_string(string)
-      string = string.gsub('\\', '\\\\')
+      string = string.gsub("\\", "\\\\")
 
       ENCAPSULATED_CHARACTERS.each do |char|
         # Only replace char with escaped version if it isn't inside backticks (markdown inline code).