github-changelog-generator/lib/github_changelog_generator.rb

538 lines
15 KiB
Ruby
Raw Normal View History

2014-11-06 13:51:15 +00:00
#!/usr/bin/env ruby
require 'github_api'
require 'json'
require 'colorize'
2014-12-15 12:15:39 +00:00
require 'benchmark'
require_relative 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/generator'
2014-11-17 16:01:10 +00:00
require_relative 'github_changelog_generator/version'
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
module GitHubChangelogGenerator
class ChangelogGenerator
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
attr_accessor :options, :all_tags, :github
2014-11-06 13:51:15 +00:00
PER_PAGE_NUMBER = 30
2014-11-18 13:20:57 +00:00
def initialize
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
@options = Parser.parse_options
2014-11-06 13:51:15 +00:00
2014-11-19 15:28:49 +00:00
if options[:verbose]
puts 'Input options:'
pp options
puts ''
end
2014-11-17 15:54:13 +00:00
github_token
github_options = {per_page: PER_PAGE_NUMBER}
github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
@github = Github.new github_options
2014-12-03 14:08:20 +00:00
@generator = Generator.new(@options)
2014-11-17 15:54:13 +00:00
@all_tags = self.get_all_tags
2015-02-10 12:36:56 +00:00
@pull_requests = self.get_filtered_pull_requests
if @options[:issues]
@issues = self.get_all_issues
2015-02-17 20:39:37 +00:00
fetch_event_for_issues(@issues)
detect_actual_closed_dates
else
@issues = []
end
2014-11-17 15:54:13 +00:00
@tag_times_hash = {}
end
2014-11-06 13:51:15 +00:00
2015-02-17 20:39:37 +00:00
def detect_actual_closed_dates
2015-02-17 21:21:19 +00:00
if @options[:verbose]
print "Fetching close commit date for issues...\r"
end
threads = []
@issues.each{|issue|
threads << Thread.new {
find_closed_date_by_commit(issue)
}
2015-02-17 20:39:37 +00:00
}
2015-02-17 21:21:19 +00:00
threads.each { |thr| thr.join }
if @options[:verbose]
puts 'Fetching close commit date for issues: Done!'
end
2015-02-17 20:39:37 +00:00
end
def find_closed_date_by_commit(issue)
unless issue['events'].nil?
2015-02-17 21:09:07 +00:00
# reverse! - to find latest closed event. (event goes in date order)
issue['events'].reverse!.each{|event|
if event[:event].eql? 'closed'
if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at]
else
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
issue[:actual_date] = commit[:author][:date]
end
break
end
2015-02-17 20:39:37 +00:00
}
end
2015-02-17 21:25:14 +00:00
#TODO: assert issues, that remain without 'actual_date' hash for some reason.
2015-02-17 20:39:37 +00:00
end
2014-11-17 15:54:13 +00:00
def print_json(json)
puts JSON.pretty_generate(json)
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
def exec_command(cmd)
2014-11-19 15:28:49 +00:00
exec_cmd = "cd #{$project_path} and #{cmd}"
2014-11-17 15:54:13 +00:00
%x[#{exec_cmd}]
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
def get_all_closed_pull_requests
2014-11-19 10:43:55 +00:00
if @options[:verbose]
print "Fetching pull requests...\r"
2014-11-19 10:43:55 +00:00
end
2014-11-17 15:54:13 +00:00
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
pull_requests = []
page_i = 0
2014-11-17 15:54:13 +00:00
response.each_page do |page|
page_i += PER_PAGE_NUMBER
2015-02-13 13:17:46 +00:00
count_pages = response.count_pages
print "Fetching pull requests... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
2014-11-17 15:54:13 +00:00
pull_requests.concat(page)
end
2015-02-13 13:28:01 +00:00
print " \r"
2014-11-17 15:54:13 +00:00
if @options[:verbose]
2015-02-13 13:28:01 +00:00
puts "Received pull requests: #{pull_requests.count}"
2014-11-17 15:54:13 +00:00
end
2014-11-19 12:56:08 +00:00
2015-02-10 12:36:56 +00:00
pull_requests
end
def get_filtered_pull_requests
pull_requests = self.get_all_closed_pull_requests
unless @options[:pull_request_labels].nil?
2014-11-19 12:56:08 +00:00
if @options[:verbose]
puts 'Filter all pull requests by labels.'
end
filtered_pull_requests = pull_requests.select { |pull_request|
2015-02-10 12:36:56 +00:00
#fetch this issue to get labels array
issue = @github.issues.get @options[:user], @options[:project], pull_request.number
2015-02-10 12:36:56 +00:00
#compare is there any labels from @options[:labels] array
2015-02-10 12:36:56 +00:00
issue_without_labels = !issue.labels.map { |label| label.name }.any?
if @options[:verbose]
puts "Filter request \##{issue.number}."
end
2014-11-06 13:51:15 +00:00
if @options[:pull_request_labels].any?
select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
else
select_by_label = false
end
2015-02-10 12:36:56 +00:00
select_by_label | issue_without_labels
}
if @options[:verbose]
puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
end
return filtered_pull_requests
end
2014-11-19 14:23:54 +00:00
2014-11-17 15:54:13 +00:00
pull_requests
2014-11-06 13:51:15 +00:00
end
2014-11-17 15:54:13 +00:00
def compund_changelog
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
log = "# Changelog\n\n"
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
if @options[:last]
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
2014-11-19 15:28:49 +00:00
elsif @options[:tag1] and @options[:tag2]
2014-11-17 15:54:13 +00:00
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
self.all_tags.each { |x| tags_strings.push(x['name']) }
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
if tags_strings.include?(tag1)
if tags_strings.include?(tag2)
hash = Hash[tags_strings.map.with_index.to_a]
index1 = hash[tag1]
index2 = hash[tag2]
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
else
puts "Can't find tag #{tag2} -> exit"
exit
end
2014-11-06 13:51:15 +00:00
else
2014-11-17 15:54:13 +00:00
puts "Can't find tag #{tag1} -> exit"
2014-11-06 13:51:15 +00:00
exit
end
else
2014-11-17 15:54:13 +00:00
log += self.generate_log_for_all_tags
2014-11-06 13:51:15 +00:00
end
2014-11-17 15:54:13 +00:00
log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
2014-11-17 15:54:13 +00:00
output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
2014-11-06 13:51:15 +00:00
2014-12-03 14:08:20 +00:00
puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
def generate_log_for_all_tags
log = ''
2014-11-17 15:43:37 +00:00
2015-02-17 19:18:52 +00:00
if @options[:verbose]
puts "Fetching tags dates.."
end
2014-12-15 12:15:39 +00:00
# Async fetching tags:
threads = []
@all_tags.each { |tag|
2015-02-17 19:18:52 +00:00
# explicit set @tag_times_hash to write data safety.
threads << Thread.new { self.get_time_of_tag(tag, @tag_times_hash) }
2014-12-15 12:15:39 +00:00
}
threads.each { |thr| thr.join }
2014-11-17 15:43:37 +00:00
2014-11-17 15:54:13 +00:00
if @options[:verbose]
puts "Sorting tags.."
end
2014-11-17 15:43:37 +00:00
2014-11-17 15:54:13 +00:00
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
2014-11-17 15:43:37 +00:00
2014-11-17 15:54:13 +00:00
if @options[:verbose]
puts "Generating log.."
end
2014-12-03 09:09:11 +00:00
(1 ... self.all_tags.size).each { |index|
2014-11-17 15:54:13 +00:00
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
2014-12-03 09:09:11 +00:00
}
2014-11-17 15:43:37 +00:00
2014-12-03 09:09:11 +00:00
log += generate_log_between_tags(nil, self.all_tags.last)
2014-11-17 15:54:13 +00:00
log
2014-11-06 13:51:15 +00:00
end
2014-11-17 15:54:13 +00:00
def is_megred(number)
@github.pull_requests.merged? @options[:user], @options[:project], number
end
2014-11-07 09:45:01 +00:00
2014-11-17 15:54:13 +00:00
def get_all_tags
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
if @options[:verbose]
print "Fetching tags...\r"
2014-11-17 15:54:13 +00:00
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
response = @github.repos.tags @options[:user], @options[:project]
2014-11-12 15:23:16 +00:00
2014-11-17 15:54:13 +00:00
tags = []
page_i = 0
2015-02-13 13:17:46 +00:00
count_pages = response.count_pages
2014-11-17 15:54:13 +00:00
response.each_page do |page|
page_i += PER_PAGE_NUMBER
2015-02-13 13:17:46 +00:00
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
2014-11-17 15:54:13 +00:00
tags.concat(page)
end
2015-02-13 13:28:01 +00:00
print " \r"
2014-11-17 15:54:13 +00:00
if @options[:verbose]
puts "Found #{tags.count} tags"
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
tags
2014-11-17 14:53:47 +00:00
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
def github_token
if @options[:token]
return @github_token ||= @options[:token]
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
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
end
2014-11-17 15:54:13 +00:00
@github_token ||= env_var
end
2014-11-17 15:54:13 +00:00
def generate_log_between_tags(older_tag, newer_tag)
2014-12-22 13:51:45 +00:00
if newer_tag.nil?
puts "Can't find tag -> terminate"
exit 1
end
2014-11-19 12:14:28 +00:00
newer_tag_time = self.get_time_of_tag(newer_tag)
2014-11-17 15:54:13 +00:00
newer_tag_name = newer_tag['name']
2014-11-06 13:51:15 +00:00
2015-02-17 17:45:11 +00:00
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag)
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag)
2014-11-06 13:51:15 +00:00
2015-02-17 17:45:11 +00:00
older_tag_name = older_tag.nil? ? nil : older_tag['name']
2014-12-22 13:14:01 +00:00
if @options[:filter_issues_by_milestone]
#delete excess irrelevant issues (according milestones)
filtered_issues.select! { |issue|
if issue.milestone.nil?
true
else
#check, that this milestone in tag list:
milestone_is_tag = @all_tags.find { |tag|
tag.name == issue.milestone.title
}
milestone_is_tag.nil?
end
2014-12-22 13:31:49 +00:00
}
2014-12-22 13:14:01 +00:00
#add missed issues (according milestones)
issues_to_add = @issues.select { |issue|
if issue.milestone.nil?
2014-12-22 13:31:49 +00:00
false
2014-12-22 13:14:01 +00:00
else
#check, that this milestone in tag list:
milestone_is_tag = @all_tags.find { |tag|
tag.name == issue.milestone.title
}
if milestone_is_tag.nil?
false
else
issue.milestone.title == newer_tag_name
end
2014-12-22 13:14:01 +00:00
end
}
2014-12-22 13:14:01 +00:00
filtered_issues |= issues_to_add
end
2014-12-22 13:14:01 +00:00
self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time, older_tag_name)
2014-11-06 13:51:15 +00:00
2014-11-19 12:14:28 +00:00
end
2014-11-06 13:51:15 +00:00
2015-02-17 17:45:11 +00:00
def delete_by_time(array, hash_key, newer_tag_time, older_tag = nil)
older_tag_time = self.get_time_of_tag(older_tag)
2014-11-19 15:28:49 +00:00
array.select { |req|
2014-11-19 12:14:28 +00:00
if req[hash_key]
t = Time.parse(req[hash_key]).utc
2014-11-06 13:51:15 +00:00
2014-11-19 12:14:28 +00:00
if older_tag_time.nil?
2014-11-19 15:28:49 +00:00
tag_in_range_old = true
2014-11-19 12:14:28 +00:00
else
2014-11-19 15:28:49 +00:00
tag_in_range_old = t > older_tag_time
2014-11-19 12:14:28 +00:00
end
2014-11-07 15:45:35 +00:00
2014-11-19 15:28:49 +00:00
tag_in_range_new = t <= newer_tag_time
2014-11-07 15:45:35 +00:00
2014-11-19 15:28:49 +00:00
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
2014-12-03 09:09:11 +00:00
2014-11-19 15:28:49 +00:00
tag_in_range
2014-11-17 15:54:13 +00:00
else
2014-11-19 15:28:49 +00:00
false
2014-11-17 15:54:13 +00:00
end
}
end
2014-11-06 13:51:15 +00:00
# @param [Array] pull_requests
# @param [Array] issues
# @param [String] newer_tag_name
# @param [String] newer_tag_time
# @param [String] older_tag_name
# @return [String]
def create_log(pull_requests, issues, newer_tag_name, newer_tag_time, older_tag_name = nil)
2014-11-06 13:51:15 +00:00
github_site = options[:github_site] || 'https://github.com'
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
2014-11-17 15:54:13 +00:00
# Generate tag name and link
log = "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name})\n"
2015-01-26 12:30:27 +00:00
if @options[:compare_link] && older_tag_name
# Generate compare link
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name})\n"
end
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
#Generate date string:
time_string = newer_tag_time.strftime @options[:format]
2014-11-17 15:54:13 +00:00
log += "#### #{time_string}\n"
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
if @options[:pulls]
# Generate pull requests:
pull_requests.each { |pull_request|
2014-12-03 14:08:20 +00:00
merge = @generator.get_string_for_pull_request(pull_request)
log += "- #{merge}"
2014-12-03 09:59:45 +00:00
} if pull_requests
2014-11-07 15:45:35 +00:00
end
2014-11-17 15:54:13 +00:00
if @options[:issues]
# Generate issues:
if issues
issues.sort! { |x, y|
if x.labels.any? && y.labels.any?
x.labels[0].name <=> y.labels[0].name
2014-11-10 14:13:34 +00:00
else
2014-11-17 15:54:13 +00:00
if x.labels.any?
1
2014-11-10 14:13:34 +00:00
else
2014-11-17 15:54:13 +00:00
if y.labels.any?
-1
else
0
end
2014-11-10 14:13:34 +00:00
end
end
2014-11-17 15:54:13 +00:00
}.reverse!
end
issues.each { |dict|
is_bug = false
is_enhancement = false
dict.labels.each { |label|
if label.name == 'bug'
is_bug = true
end
if label.name == 'enhancement'
is_enhancement = true
end
}
intro = 'Closed issue'
if is_bug
intro = 'Fixed bug'
end
2014-11-17 15:54:13 +00:00
if is_enhancement
intro = 'Implemented enhancement'
end
2014-11-07 15:45:35 +00:00
2014-12-03 14:31:43 +00:00
enc_string = @generator.encapsulate_string dict[:title]
merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
2014-11-17 15:54:13 +00:00
log += "- #{merge}"
}
end
log
end
2014-11-10 14:13:34 +00:00
2015-02-17 19:18:52 +00:00
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
2015-02-17 17:45:11 +00:00
if tag_name.nil?
return nil
end
2014-11-07 15:45:35 +00:00
2015-02-17 19:18:52 +00:00
if tag_times_hash[tag_name['name']]
2015-02-17 17:45:11 +00:00
return @tag_times_hash[tag_name['name']]
2014-11-17 15:54:13 +00:00
end
2014-11-06 13:51:15 +00:00
2015-02-17 17:45:11 +00:00
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
2014-11-17 15:54:13 +00:00
time_string = github_git_data_commits_get['committer']['date']
2015-02-17 17:45:11 +00:00
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
2014-11-06 13:51:15 +00:00
end
2014-11-17 15:54:13 +00:00
def get_all_issues
2014-11-19 10:43:55 +00:00
2014-12-12 14:55:26 +00:00
if @options[:verbose]
2014-12-15 13:34:20 +00:00
print "Fetching closed issues...\r"
2014-12-12 14:55:26 +00:00
end
2014-11-17 15:54:13 +00:00
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
2014-11-06 13:51:15 +00:00
2014-11-17 15:54:13 +00:00
issues = []
2014-12-15 13:24:46 +00:00
page_i = 0
2015-02-13 13:17:46 +00:00
count_pages = response.count_pages
2014-11-17 15:54:13 +00:00
response.each_page do |page|
2014-12-15 13:24:46 +00:00
page_i += PER_PAGE_NUMBER
2015-02-13 13:17:46 +00:00
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
2014-11-17 15:54:13 +00:00
issues.concat(page)
end
2014-12-15 13:24:46 +00:00
2015-02-13 13:28:01 +00:00
print " \r"
2014-11-17 14:53:47 +00:00
2014-11-17 15:54:13 +00:00
if @options[:verbose]
2015-02-13 13:28:01 +00:00
puts "Received issues: #{issues.count}"
2014-11-17 15:54:13 +00:00
end
2014-11-17 14:53:47 +00:00
2015-02-13 13:28:01 +00:00
# remove pull request from issues:
issues.select! { |x|
x.pull_request == nil
}
2014-11-17 15:54:13 +00:00
filtered_issues = issues.select { |issue|
#compare is there any labels from @options[:labels] array
(issue.labels.map { |label| label.name } & @options[:labels]).any?
}
2014-11-17 14:53:47 +00:00
2015-02-17 20:39:37 +00:00
2014-11-17 15:54:13 +00:00
if @options[:add_issues_wo_labels]
issues_wo_labels = issues.select {
# add issues without any labels
|issue| !issue.labels.map { |label| label.name }.any?
2014-11-17 15:54:13 +00:00
}
filtered_issues.concat(issues_wo_labels)
end
2014-11-17 14:53:47 +00:00
2015-02-17 20:39:37 +00:00
if @options[:verbose]
puts "Filtered issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count}"
end
filtered_issues
end
def fetch_event_for_issues(filtered_issues)
2014-11-17 15:54:13 +00:00
if @options[:verbose]
2015-02-17 20:39:37 +00:00
print "Fetching events for issues: 0/#{filtered_issues.count}\r"
2015-02-17 19:16:58 +00:00
end
# Async fetching events:
threads = []
2015-02-17 20:39:37 +00:00
i = 0
filtered_issues.each { |issue|
threads << Thread.new {
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
2015-02-17 19:16:58 +00:00
issue[:events] = obj.body
2015-02-17 20:39:37 +00:00
print "Fetching events for issues: #{i+1}/#{filtered_issues.count}\r"
i +=1
2015-02-17 19:16:58 +00:00
}
}
2015-02-17 20:39:37 +00:00
threads.each { |thr| thr.join }
2015-02-17 19:16:58 +00:00
if @options[:verbose]
puts "Fetching events for issues: Done!"
2014-11-17 15:54:13 +00:00
end
2014-11-07 15:45:35 +00:00
end
end
2014-11-17 15:54:13 +00:00
if __FILE__ == $0
2014-11-18 13:20:57 +00:00
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
2014-11-17 15:54:13 +00:00
end
2014-11-06 13:51:15 +00:00
end