changelog_jira 1.12.0

data/lib/github_changelog_generator/parser_file.rb

@@ -0,0 +1,103 @@
+require "pathname"
+
+module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
+  # ParserFile is a configuration file reader which sets options in the
+  # given Hash.
+  #
+  # In your project's root, you can put a file named
+  # <tt>.github_changelog_generator</tt> to override defaults.
+  #
+  # Example:
+  #   header_label=# My Super Changelog
+  #   ; Comments are allowed
+  #   future-release=5.0.0
+  #   # Ruby-style comments, too
+  #   since-tag=1.0.0
+  #
+  # The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
+  #
+  class ParserFile
+    # @param options [Hash] options to be configured from file contents
+    # @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
+    def initialize(options, file = open_settings_file)
+      @options = options
+      @file = file
+    end
+
+    # Sets options using configuration file content
+    def parse!
+      return unless @file
+      @file.each_with_index { |line, i| parse_line!(line, i + 1) }
+      @file.close
+    end
+
+    private
+
+    FILENAME = ".github_changelog_generator"
+
+    def open_settings_file
+      path = Pathname(File.expand_path(FILENAME))
+      File.open(path) if path.exist?
+    end
+
+    def parse_line!(line, line_number)
+      return if non_configuration_line?(line)
+      option_name, value = extract_pair(line)
+      @options[option_key_for(option_name)] = convert_value(value, option_name)
+    rescue
+      raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
+    end
+
+    # Returns true if the line starts with a pound sign or a semi-colon.
+    def non_configuration_line?(line)
+      line =~ /^[\#;]/ || line =~ /^[\s]+$/
+    end
+
+    # Returns a the option name as a symbol and its string value sans newlines.
+    #
+    # @param line [String] unparsed line from config file
+    # @return [Array<Symbol, String>]
+    def extract_pair(line)
+      key, value = line.split("=", 2)
+      [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
+    end
+
+    KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
+                        :enhancement_labels, :between_tags, :exclude_tags]
+    KNOWN_INTEGER_KEYS = [:max_issues]
+
+    def convert_value(value, option_name)
+      if KNOWN_ARRAY_KEYS.include?(option_name)
+        value.split(",")
+      elsif KNOWN_INTEGER_KEYS.include?(option_name)
+        value.to_i
+      elsif value =~ /^(true|t|yes|y|1)$/i
+        true
+      elsif value =~ /^(false|f|no|n|0)$/i
+        false
+      else
+        value
+      end
+    end
+
+    IRREGULAR_OPTIONS = {
+      bugs_label: :bug_prefix,
+      enhancement_label: :enhancement_prefix,
+      issues_label: :issue_prefix,
+      header_label: :header,
+      front_matter: :frontmatter,
+      pr_label: :merge_prefix,
+      issues_wo_labels: :add_issues_wo_labels,
+      pr_wo_labels: :add_pr_wo_labels,
+      pull_requests: :pulls,
+      filter_by_milestone: :filter_issues_by_milestone,
+      github_api: :github_endpoint
+    }
+
+    def option_key_for(option_name)
+      IRREGULAR_OPTIONS.fetch(option_name) { option_name }
+    end
+  end
+end

data/lib/github_changelog_generator/reader.rb

@@ -0,0 +1,84 @@
+#
+# Author:: Enrico Stahn <mail@enricostahn.com>
+#
+# Copyright 2014, Zanui, <engineering@zanui.com.au>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module GitHubChangelogGenerator
+  # A Reader to read an existing ChangeLog file and return a structured object
+  #
+  # Example:
+  #   reader = GitHubChangelogGenerator::Reader.new
+  #   content = reader.read('./CHANGELOG.md')
+  class Reader
+    def initialize(options = {})
+      defaults = {
+        heading_level: "##",
+        heading_structures: [
+          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
+          /^## (?<version>.+?)( \((?<date>.+?)\))?$/
+        ]
+      }
+
+      @options = options.merge(defaults)
+
+      @heading_level = @options[:heading_level]
+      @heading_structures = @options[:heading_structures]
+    end
+
+    # Parse a single heading and return a Hash
+    #
+    # The following heading structures are currently valid:
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
+    # - ## v1.0.2 (2015-03-24)
+    # - ## v1.0.2
+    #
+    # @param [String] heading Heading from the ChangeLog File
+    # @return [Hash] Returns a structured Hash with version, url and date
+    def parse_heading(heading)
+      captures = { "version" => nil, "url" => nil, "date" => nil }
+
+      @heading_structures.each do |regexp|
+        matches = Regexp.new(regexp).match(heading)
+        if matches
+          captures.merge!(Hash[matches.names.zip(matches.captures)])
+          break
+        end
+      end
+
+      captures
+    end
+
+    # Parse the given ChangeLog data into a list of Hashes
+    #
+    # @param [String] data File data from the ChangeLog.md
+    # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
+    def parse(data)
+      sections = data.split(/^## .+?$/)
+      headings = data.scan(/^## .+?$/)
+
+      headings.each_with_index.map do |heading, index|
+        section = parse_heading(heading)
+        section["content"] = sections.at(index + 1)
+        section
+      end
+    end
+
+    def read(file_path)
+      parse File.read(file_path)
+    end
+  end
+end

data/lib/github_changelog_generator/task.rb

@@ -0,0 +1,67 @@
+require "rake"
+require "rake/tasklib"
+require "github_changelog_generator"
+
+module GitHubChangelogGenerator
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    OPTIONS = %w( user project token date_format output
+                  bug_prefix enhancement_prefix issue_prefix
+                  header merge_prefix issues
+                  add_issues_wo_labels add_pr_wo_labels
+                  pulls filter_issues_by_milestone author
+                  unreleased_only unreleased unreleased_label
+                  compare_link include_labels exclude_labels
+                  bug_labels enhancement_labels
+                  between_tags exclude_tags since_tag max_issues
+                  github_site github_endpoint simple_list
+                  future_release release_branch verbose release_url
+                  base )
+
+    OPTIONS.each do |o|
+      attr_accessor o.to_sym
+    end
+
+    # Public: Initialise a new GitHubChangelogGenerator::RakeTask.
+    #
+    # Example
+    #
+    #   GitHubChangelogGenerator::RakeTask.new
+    def initialize(*args, &task_block)
+      @name = args.shift || :changelog
+
+      define(args, &task_block)
+    end
+
+    def define(args, &task_block)
+      desc "Generate a Change log from GitHub"
+
+      yield(*[self, args].slice(0, task_block.arity)) if task_block
+
+      # clear any (auto-)pre-existing task
+      Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+
+      task @name do
+        # mimick parse_options
+        options = Parser.default_options
+
+        Parser.user_and_project_from_git(options)
+
+        OPTIONS.each do |o|
+          v = instance_variable_get("@#{o}")
+          options[o.to_sym] = v unless v.nil?
+        end
+
+        generator = Generator.new options
+
+        log = generator.compound_changelog
+
+        output_filename = (options[:output]).to_s
+        File.open(output_filename, "w") { |file| file.write(log) }
+        puts "Done!"
+        puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+      end
+    end
+  end
+end

data/lib/github_changelog_generator/version.rb

@@ -0,0 +1,3 @@
+module GitHubChangelogGenerator
+  VERSION = "1.12.0"
+end

data/man/git-generate-changelog.1

@@ -0,0 +1,252 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
+.
+.SH "NAME"
+\fBgit\-generate\-changelog\fR \- Generate changelog from github
+.
+.SH "SYNOPSIS"
+\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
+.
+.SH "DESCRIPTION"
+Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
+.
+.SH "OPTIONS"
+\-u, \-\-user [USER]
+.
+.P
+Username of the owner of target GitHub repo
+.
+.P
+\-p, \-\-project [PROJECT]
+.
+.P
+Name of project on GitHub
+.
+.P
+\-t, \-\-token [TOKEN]
+.
+.P
+To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
+.
+.P
+\-f, \-\-date\-format [FORMAT]
+.
+.P
+Date format\. Default is %Y\-%m\-%d
+.
+.P
+\-o, \-\-output [NAME]
+.
+.P
+Output file\. Default is CHANGELOG\.md
+.
+.P
+\-b, \-\-base [NAME]
+.
+.P
+Optional base file to append generated changes to\.
+.
+.P
+\-\-bugs\-label [LABEL]
+.
+.P
+Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
+.
+.P
+\-\-enhancement\-label [LABEL]
+.
+.P
+Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
+.
+.P
+\-\-issues\-label [LABEL]
+.
+.P
+Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
+.
+.P
+\-\-header\-label [LABEL]
+.
+.P
+Setup custom header label\. Default is "# Change Log"
+.
+.P
+\-\-pr\-label [LABEL]
+.
+.P
+Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
+.
+.P
+\-\-[no\-]issues
+.
+.P
+Include closed issues in changelog\. Default is true
+.
+.P
+\-\-[no\-]issues\-wo\-labels
+.
+.P
+Include closed issues without labels in changelog\. Default is true
+.
+.P
+\-\-[no\-]pr\-wo\-labels
+.
+.P
+Include pull requests without labels in changelog\. Default is true
+.
+.P
+\-\-[no\-]pull\-requests
+.
+.P
+Include pull\-requests in changelog\. Default is true
+.
+.P
+\-\-[no\-]filter\-by\-milestone
+.
+.P
+Use milestone to detect when issue was resolved\. Default is true
+.
+.P
+\-\-[no\-]author
+.
+.P
+Add author of pull\-request in the end\. Default is true
+.
+.P
+\-\-unreleased\-only
+.
+.P
+Generate log from unreleased closed issues only\.
+.
+.P
+\-\-[no\-]unreleased
+.
+.P
+Add to log unreleased closed issues\. Default is true
+.
+.P
+\-\-unreleased\-label [label]
+.
+.P
+Add to log unreleased closed issues\. Default is true
+.
+.P
+\-\-[no\-]compare\-link
+.
+.P
+Include compare link (Full Changelog) between older version and newer version\. Default is true
+.
+.P
+\-\-include\-labels x,y,z
+.
+.P
+Only issues with the specified labels will be included in the changelog\.
+.
+.P
+\-\-exclude\-labels x,y,z
+.
+.P
+Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
+.
+.P
+\-\-bug\-labels x,y,z
+.
+.P
+Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
+.
+.P
+\-\-enhancement\-labels x,y,z
+.
+.P
+Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
+.
+.P
+\-\-between\-tags x,y,z
+.
+.P
+Change log will be filled only between specified tags
+.
+.P
+\-\-exclude\-tags x,y,z
+.
+.P
+Change log will exclude specified tags
+.
+.P
+\-\-since\-tag x
+.
+.P
+Change log will start after specified tag
+.
+.P
+\-\-due\-tag x
+.
+.P
+Change log will end before specified tag
+.
+.P
+\-\-max\-issues [NUMBER]
+.
+.P
+Max number of issues to fetch from GitHub\. Default is unlimited
+.
+.P
+\-\-release\-url [URL]
+.
+.P
+The URL to point to for release links, in printf format (with the tag as variable)\.
+.
+.P
+\-\-github\-site [URL]
+.
+.P
+The Enterprise Github site on which your project is hosted\.
+.
+.P
+\-\-github\-api [URL]
+.
+.P
+The enterprise endpoint to use for your Github API\.
+.
+.P
+\-\-simple\-list
+.
+.P
+Create simple list from issues and pull requests\. Default is false\.
+.
+.P
+\-\-future\-release [RELEASE\-VERSION]
+.
+.P
+Put the unreleased changes in the specified release number\.
+.
+.P
+\-\-[no\-]verbose
+.
+.P
+Run verbosely\. Default is true
+.
+.P
+\-v, \-\-version
+.
+.P
+Print version number
+.
+.P
+\-h, \-\-help
+.
+.P
+Displays Help
+.
+.SH "EXAMPLES"
+.
+.SH "AUTHOR"
+Written by Petr Korolev sky4winder@gmail\.com
+.
+.SH "REPORTING BUGS"
+<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
+.
+.SH "SEE ALSO"
+<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>