will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'develop' into feature/fetcher

Browse Source 
Conflicts:
	lib/github_changelog_generator.rb
This commit is contained in:
Petr Korolev
2015-04-03 18:40:11 +03:00
parent b5d073c0af 115762af82
commit ce7f35777b
15 changed files with 192 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/github_changelog_generator.rb
+44 -44
View File
@@ -1,23 +1,23 @@
#!/usr/bin/env ruby
require 'github_api'
require 'json'
require 'colorize'
require 'benchmark'
require "github_api"
require "json"
require "colorize"
require "benchmark"
require_relative 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/generator'
require_relative 'github_changelog_generator/version'
require_relative 'github_changelog_generator/reader'
require_relative 'github_changelog_generator/fetcher'
require_relative "github_changelog_generator/parser"
require_relative "github_changelog_generator/generator"
require_relative "github_changelog_generator/version"
require_relative "github_changelog_generator/reader"
require_relative "github_changelog_generator/fetcher"
module GitHubChangelogGenerator
class ChangelogGenerator
attr_accessor :options, :all_tags, :github
PER_PAGE_NUMBER = 30
GH_RATE_LIMIT_EXCEEDED_MSG = 'Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be ' \
'missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument.'
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be " \
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
def initialize
@options = Parser.parse_options
@@ -84,16 +84,16 @@ module GitHubChangelogGenerator
threads.each(&:join)
if @options[:verbose]
puts 'Fetching closed dates for issues: Done!'
puts "Fetching closed dates for issues: Done!"
end
end
def find_closed_date_by_commit(issue)
unless issue['events'].nil?
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'
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
# reverse! - to find latest closed event. (event goes in date order)
issue['events'].reverse!.each { |event|
issue["events"].reverse!.each { |event|
if event[:event].eql? compare_string
if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at]
@@ -123,7 +123,7 @@ module GitHubChangelogGenerator
end
pull_requests = []
begin
response = @github.pull_requests.list @options[:user], @options[:project], state: 'closed'
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
@@ -146,7 +146,7 @@ module GitHubChangelogGenerator
}
if @options[:verbose]
puts 'Fetching merged dates: Done!'
puts "Fetching merged dates: Done!"
end
end
@@ -192,7 +192,7 @@ module GitHubChangelogGenerator
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
all_tags.each { |x| tags_strings.push(x['name']) }
all_tags.each { |x| tags_strings.push(x["name"]) }
if tags_strings.include?(tag1)
if tags_strings.include?(tag2)
@@ -216,8 +216,8 @@ module GitHubChangelogGenerator
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
puts 'Done!'
File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!"
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
end
@@ -225,16 +225,16 @@ module GitHubChangelogGenerator
fetch_tags_dates
if @options[:verbose]
puts 'Sorting tags...'
puts "Sorting tags..."
end
@all_tags.sort_by! { |x| get_time_of_tag(x) }.reverse!
if @options[:verbose]
puts 'Generating log...'
puts "Generating log..."
end
log = ''
log = ""
if @options[:unreleased] && @all_tags.count != 0
unreleased_log = generate_log_between_tags(all_tags[0], nil)
@@ -314,11 +314,11 @@ module GitHubChangelogGenerator
end
def fetch_github_token
env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
env_var = @options[:token] ? @options[:token] : (ENV.fetch "CHANGELOG_GITHUB_TOKEN", nil)
unless env_var
puts 'Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.'.yellow
puts 'This script can make only 50 requests per hour to GitHub API without a token!'.yellow
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
puts "This script can make only 50 requests per hour to GitHub API without a token!".yellow
end
@github_token ||= env_var
@@ -329,8 +329,8 @@ module GitHubChangelogGenerator
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
older_tag_name = older_tag.nil? ? nil : older_tag['name']
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
if @options[:filter_issues_by_milestone]
# delete excess irrelevant issues (according milestones)
@@ -340,7 +340,7 @@ module GitHubChangelogGenerator
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
# do not generate empty unreleased section
return ''
return ""
end
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
@@ -382,7 +382,7 @@ module GitHubChangelogGenerator
end
def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
fail 'At least one of the tags should be not nil!' if older_tag.nil? && newer_tag.nil?
fail "At least one of the tags should be not nil!" if older_tag.nil? && newer_tag.nil?
newer_tag_time = get_time_of_tag(newer_tag)
older_tag_time = get_time_of_tag(older_tag)
@@ -421,10 +421,10 @@ module GitHubChangelogGenerator
# @return [String] Ready and parsed section
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag['name']
newer_tag_link = newer_tag.nil? ? 'HEAD' : newer_tag_name
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
github_site = options[:github_site] || 'https://github.com'
github_site = options[:github_site] || "https://github.com"
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
@@ -438,12 +438,12 @@ module GitHubChangelogGenerator
issues.each { |dict|
added = false
dict.labels.each { |label|
if label.name == 'bug'
if label.name == "bug"
bugs_a.push dict
added = true
next
end
if label.name == 'enhancement'
if label.name == "enhancement"
enhancement_a.push dict
added = true
next
@@ -471,7 +471,7 @@ module GitHubChangelogGenerator
# @param [String] prefix Nae of sub-section
# @return [String] Generate ready-to-go sub-section
def generate_sub_section(issues, prefix)
log = ''
log = ""
if options[:simple_list] != true && issues.any?
log += "#{prefix}\n\n"
@@ -495,7 +495,7 @@ module GitHubChangelogGenerator
# @param [String] project_url - url for current project.
# @return [String] - Generate one ready-to-add section.
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
log = ''
log = ""
# Generate date string:
time_string = newer_tag_time.strftime @options[:dateformat]
@@ -520,17 +520,17 @@ module GitHubChangelogGenerator
return nil
end
if tag_times_hash[tag_name['name']]
return @tag_times_hash[tag_name['name']]
if tag_times_hash[tag_name["name"]]
return @tag_times_hash[tag_name["name"]]
end
begin
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name["commit"]["sha"]
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
time_string = github_git_data_commits_get['committer']['date']
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
time_string = github_git_data_commits_get["committer"]["date"]
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
end
def get_filtered_issues
@@ -573,7 +573,7 @@ module GitHubChangelogGenerator
issues = []
begin
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
response = @github.issues.list user: @options[:user], repo: @options[:project], state: "closed", filter: "all", labels: nil
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
@@ -620,7 +620,7 @@ module GitHubChangelogGenerator
issues_slice.each { |issue|
threads << Thread.new {
begin
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue["number"]
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
lib/github_changelog_generator/fetcher.rb
+3 -3
View File
@@ -27,11 +27,11 @@ module GitHubChangelogGenerator
#
# @return [String]
def fetch_github_token
env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
env_var = @options[:token] ? @options[:token] : (ENV.fetch "CHANGELOG_GITHUB_TOKEN", nil)
unless env_var
puts 'Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.'.yellow
puts 'This script can make only 50 requests to GitHub API per hour without token!'.yellow
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
end
env_var
lib/github_changelog_generator/generator.rb
+1 -1
View File
@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
unless issue.pull_request.nil?
if @options[:author]
if issue.user.nil?
title_with_number += ' ({Null user})'
title_with_number += " ({Null user})"
else
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
end
lib/github_changelog_generator/parser.rb
+39 -39
View File
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
require 'optparse'
require 'pp'
require_relative 'version'
require "optparse"
require "pp"
require_relative "version"
module GitHubChangelogGenerator
class Parser
@@ -9,8 +9,8 @@ module GitHubChangelogGenerator
options = {
tag1: nil,
tag2: nil,
dateformat: '%Y-%m-%d',
output: 'CHANGELOG.md',
dateformat: "%Y-%m-%d",
output: "CHANGELOG.md",
issues: true,
add_issues_wo_labels: true,
add_pr_wo_labels: true,
@@ -18,7 +18,7 @@ module GitHubChangelogGenerator
filter_issues_by_milestone: true,
author: true,
unreleased: true,
unreleased_label: 'Unreleased',
unreleased_label: "Unreleased",
compare_link: true,
include_labels: %w(bug enhancement),
exclude_labels: %w(duplicate question invalid wontfix),
@@ -26,86 +26,86 @@ module GitHubChangelogGenerator
simple_list: false,
verbose: true,
merge_prefix: '**Merged pull requests:**',
issue_prefix: '**Closed issues:**',
bug_prefix: '**Fixed bugs:**',
enhancement_prefix: '**Implemented enhancements:**',
branch: 'origin'
merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**",
enhancement_prefix: "**Implemented enhancements:**",
branch: "origin"
}
parser = OptionParser.new do |opts|
opts.banner = 'Usage: github_changelog_generator [options]'
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
opts.banner = "Usage: github_changelog_generator [options]"
opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") 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|
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[:dateformat] = last
end
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
options[:output] = last
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-]author", "Add author of pull-request in the end. Default is true") do |author|
options[:author] = author
end
opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
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]', 'Add to log unreleased closed issues. Default is true') do |v|
opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") 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. Default is \'bug,enhancement\'') do |list|
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') 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 always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
options[:exclude_labels] = list
end
opts.on('--max-issues [NUMBER]', Integer, 'Max number of issues to fetch from GitHub. Default is unlimited') do |max|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
options[:max_issues] = max
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 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|
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 simple list from issues and pull requests. Default is false.") do |v|
options[:simple_list] = v
end
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
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
@@ -114,7 +114,7 @@ module GitHubChangelogGenerator
parser.parse!
if ARGV[0] && !ARGV[1]
github_site = options[:github_site] ? options[:github_site] : 'github.com'
github_site = options[:github_site] ? options[:github_site] : "github.com"
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
@@ -166,9 +166,9 @@ module GitHubChangelogGenerator
end
if options[:verbose]
puts 'Performing task with options:'
puts "Performing task with options:"
pp options
puts ''
puts ""
end
options
lib/github_changelog_generator/reader.rb
+3 -3
View File
@@ -25,7 +25,7 @@ module GitHubChangelogGenerator
class Reader
def initialize(options = {})
defaults = {
heading_level: '##',
heading_level: "##",
heading_structures: [
/^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
/^## (?<version>.+?)( \((?<date>.+?)\))?$/
@@ -49,7 +49,7 @@ module GitHubChangelogGenerator
# @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 }
captures = { "version" => nil, "url" => nil, "date" => nil }
@heading_structures.each do |regexp|
matches = Regexp.new(regexp).match(heading)
@@ -73,7 +73,7 @@ module GitHubChangelogGenerator
headings.each_with_index do |heading, index|
captures = parse_heading(heading)
captures['content'] = sections.at(index + 1)
captures["content"] = sections.at(index + 1)
changelog.push captures
end
lib/github_changelog_generator/version.rb
+1 -1
View File
@@ -1,3 +1,3 @@
module GitHubChangelogGenerator
VERSION = '1.3.11'
VERSION = "1.3.11"
end