github-changelog-generator/lib/github_changelog_generator/parser.rb

333 lines
14 KiB
Ruby
Raw Normal View History

#!/usr/bin/env ruby
2016-09-22 17:16:29 +00:00
# frozen_string_literal: true
require "optparse"
require "pp"
require_relative "version"
require_relative "helper"
2014-11-17 15:54:13 +00:00
module GitHubChangelogGenerator
class Parser
2015-05-25 14:16:35 +00:00
# parse options with optparse
2014-11-17 15:54:13 +00:00
def self.parse_options
options = default_options
2015-03-26 23:21:42 +00:00
ParserFile.new(options).parse!
2015-09-15 18:38:41 +00:00
2015-05-25 14:16:35 +00:00
parser = setup_parser(options)
parser.parse!
fetch_user_and_project(options)
2015-05-25 14:16:35 +00:00
abort(parser.banner) unless options[:user] && options[:project]
2015-05-25 14:16:35 +00:00
2015-09-01 06:11:52 +00:00
print_options(options)
options
end
2016-07-02 08:33:15 +00:00
# If options set to verbose, print the parsed options.
#
# The GitHub `:token` key is censored in the output.
#
# @param options [Hash] The options to display
# @option options [Boolean] :verbose If false this method does nothing
2015-09-01 06:11:52 +00:00
def self.print_options(options)
2015-05-25 14:16:35 +00:00
if options[:verbose]
Helper.log.info "Performing task with options:"
2015-09-01 06:11:52 +00:00
options_to_display = options.clone
2015-08-26 14:01:18 +00:00
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
pp options_to_display
2015-05-25 14:16:35 +00:00
puts ""
end
end
2015-05-25 14:16:35 +00:00
# setup parsing options
def self.setup_parser(options)
2016-10-20 18:49:02 +00:00
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|
2014-11-17 15:54:13 +00:00
options[:user] = last
end
opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
2014-11-17 15:54:13 +00:00
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|
2014-11-17 15:54:13 +00:00
options[:token] = last
end
opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
2015-05-25 06:56:59 +00:00
options[:date_format] = last
2014-11-24 19:38:06 +00:00
end
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
2014-11-24 19:38:06 +00:00
options[:output] = last
end
2015-08-04 14:03:13 +00:00
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
options[:base] = last
end
2016-07-22 06:28:06 +00:00
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
2015-06-12 08:23:32 +00:00
options[:bug_prefix] = v
end
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
options[:enhancement_prefix] = v
end
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
options[:issue_prefix] = v
end
2015-07-16 11:47:01 +00:00
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
options[:header] = v
end
2016-02-03 12:56:44 +00:00
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
2015-06-12 08:23:32 +00:00
opts.on("--pr-label [LABEL]", "Setup 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|
2014-11-17 15:54:13 +00:00
options[:issues] = v
end
opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
2014-11-17 15:54:13 +00:00
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|
2015-02-18 20:21:00 +00:00
options[:add_pr_wo_labels] = v
end
opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
2014-11-17 15:54:13 +00:00
options[:pulls] = v
end
opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
options[:filter_issues_by_milestone] = last
end
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
2015-02-18 16:27:57 +00:00
options[:author] = author
end
opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
options[:usernames_as_github_logins] = v
end
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
options[:unreleased_only] = v
end
opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
2015-02-18 16:27:57 +00:00
options[:unreleased] = v
end
2016-11-04 21:53:49 +00:00
opts.on("--unreleased-label [label]", "Setup 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|
2015-01-26 12:30:27 +00:00
options[:compare_link] = v
end
2015-07-16 12:29:00 +00:00
opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
2015-02-18 19:50:33 +00:00
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|
options[:exclude_labels] = list
end
2015-06-11 13:35:38 +00:00
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
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|
options[:enhancement_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("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
2015-05-25 14:16:35 +00:00
options[:between_tags] = list
end
2015-08-04 12:56:39 +00:00
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
options[:exclude_tags] = list
end
2016-03-24 12:22:33 +00:00
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
2015-08-04 12:58:25 +00:00
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
options[:since_tag] = v
end
2015-08-24 14:29:07 +00:00
opts.on("--due-tag x", "Change log 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|
options[:max_issues] = max
end
2015-08-05 07:35:03 +00:00
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|
options[:github_site] = last
end
opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
options[:github_endpoint] = last
end
opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
2015-02-25 14:37:34 +00:00
options[:simple_list] = v
end
2015-04-30 23:23:33 +00:00
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
options[:future_release] = future_release
end
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
options[:release_branch] = release_branch
end
opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
options[:http_cache] = http_cache
end
opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is /tmp/github-changelog-http-cache") do |cache_file|
options[:cache_file] = cache_file
end
opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is /tmp/github-changelog-logger.log") do |cache_log|
options[:cache_log] = cache_log
end
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
2015-02-25 12:18:19 +00:00
options[:verbose] = v
end
opts.on("-v", "--version", "Print version number") do |_v|
2014-11-17 15:54:13 +00:00
puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit
end
opts.on("-h", "--help", "Displays Help") do
2014-11-24 19:33:03 +00:00
puts opts
exit
end
2015-03-26 13:43:47 +00:00
end
2015-05-25 14:16:35 +00:00
parser
end
2014-11-17 15:54:13 +00:00
2016-07-02 08:33:15 +00:00
# @return [Hash] Default options
def self.default_options
Options.new(
2015-05-25 14:16:35 +00:00
tag1: nil,
tag2: nil,
date_format: "%Y-%m-%d",
output: "CHANGELOG.md",
2015-08-04 14:03:13 +00:00
base: "HISTORY.md",
2015-05-25 14:16:35 +00:00
issues: true,
add_issues_wo_labels: true,
add_pr_wo_labels: true,
pulls: true,
filter_issues_by_milestone: true,
author: true,
unreleased: true,
unreleased_label: "Unreleased",
compare_link: true,
2015-06-11 13:35:38 +00:00
enhancement_labels: %w(enhancement Enhancement),
bug_labels: %w(bug Bug),
2015-06-11 13:43:45 +00:00
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
issue_line_labels: [],
2015-05-25 14:16:35 +00:00
max_issues: nil,
simple_list: false,
verbose: true,
2015-07-16 11:47:01 +00:00
header: "# Change Log",
2015-05-25 14:16:35 +00:00
merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**",
enhancement_prefix: "**Implemented enhancements:**",
git_remote: "origin",
http_cache: true,
2016-09-27 21:44:49 +00:00
cache_file: "/tmp/github-changelog-http-cache",
cache_log: "/tmp/github-changelog-logger.log"
2016-10-05 21:31:19 +00:00
)
2015-04-03 23:30:02 +00:00
end
2016-07-02 08:33:15 +00:00
# If `:user` or `:project` not set in options, try setting them
# Valid unnamed parameters:
# 1) in 1 param: repo_name/project
# 2) in 2 params: repo name project
def self.fetch_user_and_project(options)
if options[:user].nil? || options[:project].nil?
2016-07-21 14:26:40 +00:00
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
options[:user] ||= user
options[:project] ||= project
end
end
2016-07-02 08:33:15 +00:00
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
2016-07-21 14:26:40 +00:00
# @param [String] arg0 first argument in cli
# @param [String] arg1 second argument in cli
# @return [Array<String>] user and project, or nil if unsuccessful
def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
2016-07-21 14:26:40 +00:00
user, project = user_project_from_option(arg0, arg1, options[:github_site])
unless user && project
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
user = "skywinder"
project = "changelog_test"
else
remote = `git config --get remote.#{options[:git_remote]}.url`
user, project = user_project_from_remote(remote)
end
2015-05-25 10:02:10 +00:00
end
2016-07-21 14:26:40 +00:00
[user, project]
2015-05-25 10:02:10 +00:00
end
2016-07-02 08:33:15 +00:00
# Returns GitHub username and project from CLI arguments
2015-05-25 11:21:23 +00:00
#
2016-07-02 08:33:15 +00:00
# @param arg0 [String] This parameter takes two forms: Either a full
# GitHub URL, or a 'username/projectname', or
# simply a GitHub username
# @param arg1 [String] If arg0 is given as a username,
# then arg1 can given as a projectname
# @param github_site [String] Domain name of GitHub site
#
# @return [Array, nil] user and project, or nil if unsuccessful
def self.user_project_from_option(arg0, arg1, github_site)
2015-05-25 11:21:23 +00:00
user = nil
project = nil
2015-05-25 12:39:24 +00:00
github_site ||= "github.com"
if arg0 && !arg1
2016-07-02 08:33:15 +00:00
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or
# "skywinder/Github-Changelog-Generator" to user and name
2015-05-25 11:21:23 +00:00
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
2014-12-11 16:04:11 +00:00
2015-02-06 14:36:52 +00:00
begin
2015-02-25 17:02:41 +00:00
param = match[2].nil?
2015-02-06 14:36:52 +00:00
rescue
2015-05-25 11:21:23 +00:00
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
return
2015-02-06 14:36:52 +00:00
end
if param
return
2014-12-11 16:04:11 +00:00
else
2015-05-25 11:21:23 +00:00
user = match[1]
project = match[2]
2014-12-11 16:04:11 +00:00
end
end
2015-05-25 11:21:23 +00:00
[user, project]
2015-05-25 10:02:10 +00:00
end
2016-07-02 08:33:15 +00:00
# These patterns match these formats:
2015-05-25 10:02:10 +00:00
#
2016-07-02 08:33:15 +00:00
# ```
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
# git@github.com:skywinder/Github-Changelog-Generator.git
# ```
#
# and
#
# ```
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
# ```
GIT_REMOTE_PATTERNS = [
/.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
/.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
2016-07-02 08:33:15 +00:00
]
2015-05-25 10:02:10 +00:00
2016-07-02 08:33:15 +00:00
# Returns GitHub username and project from git remote output
#
# @param git_remote_output [String] Output of git remote command
#
# @return [Array] user and project
def self.user_project_from_remote(git_remote_output)
2015-05-25 10:02:10 +00:00
user = nil
project = nil
2016-07-02 08:33:15 +00:00
GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
git_remote_pattern =~ git_remote_output
2015-05-25 10:02:10 +00:00
if Regexp.last_match
user = Regexp.last_match(:user)
project = Regexp.last_match(:project)
break
2014-11-17 15:54:13 +00:00
end
end
2015-05-25 10:02:10 +00:00
[user, project]
end
end
end