github_changelog_generator 1.15.0.pre.beta → 1.16.1

data/lib/github_changelog_generator/options.rb

@@ -1,31 +1,43 @@
 # frozen_string_literal: true
 
 require "delegate"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
+  # This class wraps Options, and knows a list of known options. Others options
+  # will raise exceptions.
   class Options < SimpleDelegator
+    # Raised on initializing with unknown keys in the values hash,
+    # and when trying to store a value on an unknown key.
     UnsupportedOptionError = Class.new(ArgumentError)
 
+    # List of valid option names
     KNOWN_OPTIONS = %i[
       add_issues_wo_labels
       add_pr_wo_labels
+      add_sections
       author
       base
       between_tags
+      breaking_labels
+      breaking_prefix
       bug_labels
       bug_prefix
       cache_file
       cache_log
       compare_link
+      configure_sections
       date_format
+      deprecated_labels
+      deprecated_prefix
       due_tag
       enhancement_labels
       enhancement_prefix
-      breaking_labels
-      breaking_prefix
       exclude_labels
       exclude_tags
       exclude_tags_regex
       filter_issues_by_milestone
+      issues_of_open_milestones
       frontmatter
       future_release
       github_endpoint
@@ -33,8 +45,10 @@ module GitHubChangelogGenerator
       header
       http_cache
       include_labels
+      include_tags_regex
       issue_prefix
       issue_line_labels
+      issue_line_body
       issues
       max_issues
       merge_prefix
@@ -43,9 +57,17 @@ module GitHubChangelogGenerator
       pulls
       release_branch
       release_url
+      removed_labels
+      removed_prefix
+      require
+      security_labels
+      security_prefix
       simple_list
       since_tag
+      since_commit
       ssl_ca_file
+      summary_labels
+      summary_prefix
       token
       unreleased
       unreleased_label
@@ -55,26 +77,76 @@ module GitHubChangelogGenerator
       verbose
     ]
 
+    # @param values [Hash]
+    #
+    # @raise [UnsupportedOptionError] if given values contain unknown options
     def initialize(values)
       super(values)
       unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
     end
 
+    # Set option key to val.
+    #
+    # @param key [Symbol]
+    # @param val [Object]
+    #
+    # @raise [UnsupportedOptionError] when trying to set an unknown option
     def []=(key, val)
       supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
       values[key] = val
     end
 
+    # @return [Hash]
     def to_hash
       values
     end
 
+    # Loads the configured Ruby files from the --require option.
+    def load_custom_ruby_files
+      self[:require].each { |f| require f }
+    end
+
+    # Pretty-prints a censored options hash, if :verbose.
+    def print_options
+      return unless self[:verbose]
+
+      Helper.log.info "Using these options:"
+      # For ruby 2.5.0+
+      censored_values.each do |key, value|
+        print(key.inspect, "=>", value.inspect)
+        puts ""
+      end
+      puts ""
+    end
+
+    # Boolean method for whether the user is using configure_sections
+    def configure_sections?
+      !self[:configure_sections].nil? && !self[:configure_sections].empty?
+    end
+
+    # Boolean method for whether the user is using add_sections
+    def add_sections?
+      !self[:add_sections].nil? && !self[:add_sections].empty?
+    end
+
+    # @return [Boolean] whether write to `:output`
+    def write_to_file?
+      self[:output].present?
+    end
+
     private
 
     def values
       __getobj__
     end
 
+    # Returns a censored options hash.
+    #
+    # @return [Hash] The GitHub `:token` key is censored in the output.
+    def censored_values
+      values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
+    end
+
     def unsupported_options
       values.keys - KNOWN_OPTIONS
     end

data/lib/github_changelog_generator/parser.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 require "optparse"
-require "pp"
-require_relative "version"
-require_relative "helper"
+require "github_changelog_generator/version"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
@@ -19,88 +19,100 @@ module GitHubChangelogGenerator
         abort [e, parser].join("\n")
       end
 
-      abort(parser.banner) unless options[:user] && options[:project]
+      unless options[:user] && options[:project]
+        warn "Configure which user and project to work on."
+        warn "Options --user and --project, or settings to that effect. See --help for more."
+        abort(parser.banner)
+      end
 
-      print_options(options)
+      options.print_options
 
       options
     end
 
-    # If options set to verbose, print the parsed options.
-    #
-    # The GitHub `:token` key is censored in the output.
+    # Setup parsing options
     #
-    # @param options [Hash] The options to display
-    # @option options [Boolean] :verbose If false this method does nothing
-    def self.print_options(options)
-      if options[:verbose]
-        Helper.log.info "Performing task with options:"
-        options_to_display = options.clone
-        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
-        pp options_to_display
-        puts ""
-      end
-    end
-
-    # setup parsing options
+    # @param options [Options]
+    # @return [OptionParser]
     def self.setup_parser(options)
-      parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator [options]"
-        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+      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|
+        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|
+        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. Default is CHANGELOG.md") do |last|
+        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.") do |last|
           options[:base] = last
         end
-        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
-          options[:bug_prefix] = v
+        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]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
+        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("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
-          options[:breaking_prefix] = v
+        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("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
+        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]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+        opts.on("--header-label [LABEL]", "Set up custom header label. Default is \"# Changelog\".") do |v|
           options[:header] = 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"
+        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("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
+        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|
+        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|
+        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|
+        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|
+        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|
+        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-]author", "Add author of pull-request in the end. Default is true") do |author|
+        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|
@@ -109,67 +121,85 @@ module GitHubChangelogGenerator
         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|
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true.") do |v|
           options[:unreleased] = v
         end
-        opts.on("--unreleased-label [label]", "Setup custom label for unreleased closed issues section. Default is \"**Unreleased:**\"") do |v|
+        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|
+        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, "Only issues with the specified labels will be included in the changelog.") do |list|
+        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 always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        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("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
-          options[:bug_labels] = list
+        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 always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
+        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("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|
-          options[:breaking_labels] = list
+        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("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
+        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|
+        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", "Change log will start after specified tag") do |v|
+        opts.on("--since-tag  x", "Changelog will start after specified tag.") do |v|
           options[:since_tag] = v
         end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+        opts.on("--due-tag  x", "Changelog will end before specified tag.") do |v|
           options[:due_tag] = v
         end
-        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+        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 on which your project is hosted.") do |last|
+        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|
+        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 simple list from issues and pull requests. Default is false.") do |v|
+        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|
+        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|
+        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|
@@ -181,22 +211,24 @@ module GitHubChangelogGenerator
         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("--[no-]verbose", "Run verbosely. Default is true") do |v|
+        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|
+        opts.on("-v", "--version", "Print version number.") do |_v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
         end
-        opts.on("-h", "--help", "Displays Help") do
+        opts.on("-h", "--help", "Displays Help.") do
           puts opts
           exit
         end
       end
-      parser
     end
 
-    # @return [Hash] Default options
+    # @return [Options] Default options
     def self.default_options
       Options.new(
         date_format: "%Y-%m-%d",
@@ -207,26 +239,38 @@ module GitHubChangelogGenerator
         add_pr_wo_labels: true,
         pulls: true,
         filter_issues_by_milestone: true,
+        issues_of_open_milestones: true,
         author: true,
         unreleased: true,
         unreleased_label: "Unreleased",
         compare_link: true,
+        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
+        summary_labels: ["Release summary", "release-summary", "Summary", "summary"],
+        breaking_labels: ["backwards-incompatible", "Backwards incompatible", "breaking"],
         enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
         bug_labels: ["bug", "Bug", "Type: Bug"],
-        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
-        breaking_labels: %w[backwards-incompatible breaking],
+        deprecated_labels: ["deprecated", "Deprecated", "Type: Deprecated"],
+        removed_labels: ["removed", "Removed", "Type: Removed"],
+        security_labels: ["security", "Security", "Type: Security"],
+        configure_sections: {},
+        add_sections: {},
         issue_line_labels: [],
         max_issues: nil,
         simple_list: false,
         ssl_ca_file: nil,
         verbose: true,
-        header: "# Change Log",
+        header: "# Changelog",
         merge_prefix: "**Merged pull requests:**",
         issue_prefix: "**Closed issues:**",
-        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: "**Implemented enhancements:**",
+        summary_prefix: "",
         breaking_prefix: "**Breaking changes:**",
-        http_cache: true
+        enhancement_prefix: "**Implemented enhancements:**",
+        bug_prefix: "**Fixed bugs:**",
+        deprecated_prefix: "**Deprecated:**",
+        removed_prefix: "**Removed:**",
+        security_prefix: "**Security fixes:**",
+        http_cache: true,
+        require: []
       )
     end
   end