Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9f9f237e96 | ||
|
|
3e1abf928d | ||
|
|
7ce486085b | ||
|
|
bf17d9e284 | ||
|
|
fadae1b714 | ||
|
|
a5cb604bc1 | ||
|
|
7f89aae72e | ||
|
|
b6ec9bd8be | ||
|
|
80de58779d | ||
|
|
07e0ec0cfb | ||
|
|
fab1e28e3e | ||
|
|
0ab44f79f7 | ||
|
|
269ab4e790 | ||
|
|
4fa903b5cd | ||
|
|
c018bf2db5 | ||
|
|
c830d6c1ef | ||
|
|
03bca478c8 | ||
|
|
91229c7472 | ||
|
|
7bd174126b | ||
|
|
4b716645e5 |
14
CHANGELOG.md
14
CHANGELOG.md
@@ -1,5 +1,19 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [1.1.3] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.3)
|
||||||
|
#### 18/11/14
|
||||||
|
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23)
|
||||||
|
|
||||||
|
- *Implemented enhancement:* Implement ability to retrieve GitHub token from some shell variable (to not put it to script directly) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
|
||||||
|
|
||||||
|
- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
||||||
|
|
||||||
|
## [1.1.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
|
||||||
|
#### 12/11/14
|
||||||
|
- *Merged pull-request:* Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18)
|
||||||
|
|
||||||
|
- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17)
|
||||||
|
|
||||||
## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
|
## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
|
||||||
#### 10/11/14
|
#### 10/11/14
|
||||||
- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
|
- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
|
||||||
|
|||||||
2
Gemfile
2
Gemfile
@@ -1,3 +1,3 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
gem 'github_api'
|
gem 'github_api'
|
||||||
gem 'httparty'
|
gem 'colorize'
|
||||||
@@ -2,6 +2,7 @@ GEM
|
|||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.6)
|
addressable (2.3.6)
|
||||||
|
colorize (0.7.3)
|
||||||
descendants_tracker (0.0.4)
|
descendants_tracker (0.0.4)
|
||||||
thread_safe (~> 0.3, >= 0.3.1)
|
thread_safe (~> 0.3, >= 0.3.1)
|
||||||
faraday (0.9.0)
|
faraday (0.9.0)
|
||||||
@@ -15,10 +16,6 @@ GEM
|
|||||||
nokogiri (~> 1.6.3)
|
nokogiri (~> 1.6.3)
|
||||||
oauth2
|
oauth2
|
||||||
hashie (3.3.1)
|
hashie (3.3.1)
|
||||||
httparty (0.13.2)
|
|
||||||
json (~> 1.8)
|
|
||||||
multi_xml (>= 0.5.2)
|
|
||||||
json (1.8.1)
|
|
||||||
jwt (1.0.0)
|
jwt (1.0.0)
|
||||||
mini_portile (0.6.1)
|
mini_portile (0.6.1)
|
||||||
multi_json (1.10.1)
|
multi_json (1.10.1)
|
||||||
@@ -39,5 +36,5 @@ PLATFORMS
|
|||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
|
colorize
|
||||||
github_api
|
github_api
|
||||||
httparty
|
|
||||||
|
|||||||
13
README.md
13
README.md
@@ -49,7 +49,16 @@ Type `github_changelog_generator --help` for detailed usage.
|
|||||||
|
|
||||||
|
|
||||||
## FAQ:
|
## FAQ:
|
||||||
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
|
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
|
||||||
|
|
||||||
|
**You can easily [generate it here](https://github.com/settings/applications)**.
|
||||||
|
|
||||||
|
And:
|
||||||
|
|
||||||
|
- Run with key `-t [your-16-digit-token]` that
|
||||||
|
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||||
|
|
||||||
|
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'`
|
||||||
|
|
||||||
So, if you got error like this:
|
So, if you got error like this:
|
||||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||||
@@ -58,7 +67,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
|
|||||||
|
|
||||||
## Am I missed some essential feature?
|
## Am I missed some essential feature?
|
||||||
|
|
||||||
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's get this generator better together!
|
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
#!/usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
|
|
||||||
require 'github_changelog_generator'
|
require 'github_changelog_generator'
|
||||||
|
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||||
ChangelogGenerator.new.compund_changelog
|
|
||||||
@@ -1,21 +1,32 @@
|
|||||||
Gem::Specification.new do |s|
|
# coding: utf-8
|
||||||
s.name = "github_changelog_generator"
|
|
||||||
s.version = "1.1.2"
|
|
||||||
s.default_executable = "github_changelog_generator"
|
|
||||||
|
|
||||||
s.required_ruby_version = '>= 1.9.3'
|
lib = File.expand_path('../lib', __FILE__)
|
||||||
s.authors = ["Petr Korolev"]
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||||
s.date = %q{2014-10-10}
|
require 'github_changelog_generator/version'
|
||||||
s.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
|
|
||||||
s.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
Gem::Specification.new do |spec|
|
||||||
s.files = ["lib/github_changelog_generator.rb", "lib/github_changelog_generator/parser.rb", "bin/github_changelog_generator"]
|
spec.name = "github_changelog_generator"
|
||||||
s.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
spec.version = GitHubChangelogGenerator::VERSION
|
||||||
s.require_paths = ["lib"]
|
spec.default_executable = "github_changelog_generator"
|
||||||
s.rubygems_version = %q{1.6.2}
|
|
||||||
s.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
|
spec.required_ruby_version = '>= 1.9.3'
|
||||||
s.license = "MIT"
|
spec.authors = ["Petr Korolev"]
|
||||||
s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
|
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||||
s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
spec.date = `date +"%Y-%m-%d"`.strip!
|
||||||
|
spec.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
|
||||||
|
spec.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
|
||||||
|
spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
||||||
|
spec.license = "MIT"
|
||||||
|
|
||||||
|
spec.files = `git ls-files -z`.split("\x0")
|
||||||
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||||
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||||
|
spec.require_paths = ["lib"]
|
||||||
|
|
||||||
|
spec.add_development_dependency "bundler", "~> 1.7"
|
||||||
|
spec.add_development_dependency "rake", "~> 10.0"
|
||||||
|
|
||||||
|
spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||||
|
spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
|
||||||
|
|
||||||
s.executables = %w(github_changelog_generator)
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,329 +2,376 @@
|
|||||||
|
|
||||||
require 'github_api'
|
require 'github_api'
|
||||||
require 'json'
|
require 'json'
|
||||||
require 'httparty'
|
require 'colorize'
|
||||||
require_relative 'github_changelog_generator/parser'
|
require_relative 'github_changelog_generator/parser'
|
||||||
|
require_relative 'github_changelog_generator/version'
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
class ChangelogGenerator
|
||||||
|
|
||||||
class ChangelogGenerator
|
attr_accessor :options, :all_tags, :github
|
||||||
|
|
||||||
attr_accessor :options, :all_tags, :github
|
def initialize
|
||||||
|
|
||||||
def initialize()
|
@options = Parser.parse_options
|
||||||
|
|
||||||
@options = Parser.parse_options
|
github_token
|
||||||
if @options[:token]
|
|
||||||
@github = Github.new oauth_token: @options[:token]
|
|
||||||
else
|
|
||||||
@github = Github.new
|
|
||||||
end
|
|
||||||
@all_tags = self.get_all_tags
|
|
||||||
@pull_requests = self.get_all_closed_pull_requests
|
|
||||||
@issues = self.get_all_issues
|
|
||||||
|
|
||||||
@tag_times_hash = {}
|
if @github_token.nil?
|
||||||
end
|
@github = Github.new
|
||||||
|
else
|
||||||
|
@github = Github.new oauth_token: @github_token
|
||||||
|
end
|
||||||
|
|
||||||
def print_json(json)
|
@all_tags = self.get_all_tags
|
||||||
puts JSON.pretty_generate(json)
|
@pull_requests = self.get_all_closed_pull_requests
|
||||||
end
|
@issues = self.get_all_issues
|
||||||
|
|
||||||
def exec_command(cmd)
|
@tag_times_hash = {}
|
||||||
exec_cmd = "cd #{$project_path} && #{cmd}"
|
|
||||||
%x[#{exec_cmd}]
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
def get_all_closed_pull_requests
|
|
||||||
request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
|
||||||
pull_requests = request.body
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Receive all pull requests'
|
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests
|
def print_json(json)
|
||||||
end
|
puts JSON.pretty_generate(json)
|
||||||
|
|
||||||
def compund_changelog
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Generating changelog:'
|
|
||||||
end
|
end
|
||||||
|
|
||||||
log = "# Changelog\n\n"
|
def exec_command(cmd)
|
||||||
|
exec_cmd = "cd #{$project_path} && #{cmd}"
|
||||||
|
%x[#{exec_cmd}]
|
||||||
|
end
|
||||||
|
|
||||||
if @options[:last]
|
|
||||||
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
|
||||||
elsif @options[:tag1] && @options[:tag2]
|
|
||||||
|
|
||||||
tag1 = @options[:tag1]
|
def get_all_closed_pull_requests
|
||||||
tag2 = @options[:tag2]
|
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||||
tags_strings = []
|
|
||||||
self.all_tags.each { |x| tags_strings.push(x['name']) }
|
|
||||||
|
|
||||||
if tags_strings.include?(tag1)
|
pull_requests = []
|
||||||
if tags_strings.include?(tag2)
|
response.each_page do |page|
|
||||||
hash = Hash[tags_strings.map.with_index.to_a]
|
pull_requests.concat(page)
|
||||||
index1 = hash[tag1]
|
end
|
||||||
index2 = hash[tag2]
|
|
||||||
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
|
if @options[:verbose]
|
||||||
|
puts "Receive all pull requests: #{pull_requests.count}"
|
||||||
|
end
|
||||||
|
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
def compund_changelog
|
||||||
|
if @options[:verbose]
|
||||||
|
puts 'Generating changelog:'
|
||||||
|
end
|
||||||
|
|
||||||
|
log = "# Changelog\n\n"
|
||||||
|
|
||||||
|
if @options[:last]
|
||||||
|
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
||||||
|
elsif @options[:tag1] && @options[:tag2]
|
||||||
|
|
||||||
|
tag1 = @options[:tag1]
|
||||||
|
tag2 = @options[:tag2]
|
||||||
|
tags_strings = []
|
||||||
|
self.all_tags.each { |x| tags_strings.push(x['name']) }
|
||||||
|
|
||||||
|
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
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag2} -> exit"
|
puts "Can't find tag #{tag1} -> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag1} -> exit"
|
log += self.generate_log_for_all_tags
|
||||||
exit
|
|
||||||
end
|
|
||||||
else
|
|
||||||
log += self.generate_log_for_all_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
log += "\n\n\\* *This changelog was 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! Generated log placed in #{output_filename}"
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
def generate_log_for_all_tags
|
|
||||||
log = ''
|
|
||||||
for index in 1 ... self.all_tags.size
|
|
||||||
log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
|
|
||||||
end
|
|
||||||
|
|
||||||
log += self.generate_log_before_tag(self.all_tags.last)
|
|
||||||
|
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
def is_megred(number)
|
|
||||||
@github.pull_requests.merged? @options[:user], @options[:project], number
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_all_tags
|
|
||||||
|
|
||||||
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Receive tags for repo #{url}"
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:token]
|
|
||||||
response = HTTParty.get(url,
|
|
||||||
:headers => {'Authorization' => "token #{@options[:token]}",
|
|
||||||
'User-Agent' => 'Changelog-Generator'})
|
|
||||||
else
|
|
||||||
response = HTTParty.get(url,
|
|
||||||
:headers => {'User-Agent' => 'Changelog-Generator'})
|
|
||||||
end
|
|
||||||
|
|
||||||
json_parse = JSON.parse(response.body)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Found #{json_parse.count} tags"
|
|
||||||
end
|
|
||||||
|
|
||||||
json_parse
|
|
||||||
end
|
|
||||||
|
|
||||||
def generate_log_between_tags(since_tag, till_tag)
|
|
||||||
since_tag_time = self.get_time_of_tag(since_tag)
|
|
||||||
till_tag_time = self.get_time_of_tag(till_tag)
|
|
||||||
|
|
||||||
# if we mix up tags order - lits fix it!
|
|
||||||
if since_tag_time > till_tag_time
|
|
||||||
since_tag, till_tag = till_tag, since_tag
|
|
||||||
since_tag_time, till_tag_time = till_tag_time, since_tag_time
|
|
||||||
end
|
|
||||||
|
|
||||||
till_tag_name = till_tag['name']
|
|
||||||
|
|
||||||
pull_requests = Array.new(@pull_requests)
|
|
||||||
|
|
||||||
pull_requests.delete_if { |req|
|
|
||||||
if req[:merged_at]
|
|
||||||
t = Time.parse(req[:merged_at]).utc
|
|
||||||
tag_is_later_since = t > since_tag_time
|
|
||||||
tag_is_before_till = t <= till_tag_time
|
|
||||||
|
|
||||||
in_range = (tag_is_later_since) && (tag_is_before_till)
|
|
||||||
!in_range
|
|
||||||
else
|
|
||||||
true
|
|
||||||
end
|
end
|
||||||
|
|
||||||
}
|
log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
|
|
||||||
issues = Array.new(@issues)
|
output_filename = "#{@options[:output]}"
|
||||||
|
File.open(output_filename, 'w') { |file| file.write(log) }
|
||||||
|
|
||||||
issues.delete_if { |issue|
|
puts "Done! Generated log placed in #{output_filename}"
|
||||||
if issue[:closed_at]
|
|
||||||
t = Time.parse(issue[:closed_at]).utc
|
|
||||||
tag_is_later_since = t > since_tag_time
|
|
||||||
tag_is_before_till = t <= till_tag_time
|
|
||||||
|
|
||||||
in_range = (tag_is_later_since) && (tag_is_before_till)
|
end
|
||||||
!in_range
|
|
||||||
else
|
def generate_log_for_all_tags
|
||||||
true
|
log = ''
|
||||||
|
@all_tags.each { |tag| self.get_time_of_tag(tag) }
|
||||||
|
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Sorting tags.."
|
||||||
end
|
end
|
||||||
|
|
||||||
}
|
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
|
||||||
|
|
||||||
self.create_log(pull_requests, issues, till_tag_name, till_tag_time)
|
if @options[:verbose]
|
||||||
|
puts "Generating log.."
|
||||||
end
|
|
||||||
|
|
||||||
def generate_log_before_tag(tag)
|
|
||||||
tag_time = self.get_time_of_tag(tag)
|
|
||||||
tag_name = tag['name']
|
|
||||||
|
|
||||||
pull_requests = Array.new(@pull_requests)
|
|
||||||
|
|
||||||
pull_requests.delete_if { |req|
|
|
||||||
if req[:merged_at]
|
|
||||||
t = Time.parse(req[:merged_at]).utc
|
|
||||||
t > tag_time
|
|
||||||
else
|
|
||||||
true
|
|
||||||
end
|
end
|
||||||
|
|
||||||
}
|
for index in 1 ... self.all_tags.size
|
||||||
|
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
||||||
issues = Array.new(@issues)
|
|
||||||
|
|
||||||
issues.delete_if { |issue|
|
|
||||||
if issue[:closed_at]
|
|
||||||
t = Time.parse(issue[:closed_at]).utc
|
|
||||||
t > tag_time
|
|
||||||
else
|
|
||||||
true
|
|
||||||
end
|
end
|
||||||
}
|
|
||||||
|
|
||||||
self.create_log(pull_requests, issues, tag_name, tag_time)
|
log += self.generate_log_before_tag(self.all_tags.last)
|
||||||
|
|
||||||
end
|
log
|
||||||
|
end
|
||||||
|
|
||||||
def create_log(pull_requests, issues, tag_name, tag_time)
|
def is_megred(number)
|
||||||
|
@github.pull_requests.merged? @options[:user], @options[:project], number
|
||||||
|
end
|
||||||
|
|
||||||
# Generate tag name and link
|
def get_all_tags
|
||||||
trimmed_tag = tag_name.tr('v', '')
|
|
||||||
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
|
||||||
|
|
||||||
#Generate date string:
|
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
|
||||||
time_string = tag_time.strftime @options[:format]
|
|
||||||
log += "#### #{time_string}\n"
|
|
||||||
|
|
||||||
if @options[:pulls]
|
if @options[:verbose]
|
||||||
# Generate pull requests:
|
|
||||||
if pull_requests
|
puts "Receive tags for repo #{url}"
|
||||||
pull_requests.each { |dict|
|
end
|
||||||
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
|
||||||
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
|
|
||||||
|
tags = []
|
||||||
|
response.each_page do |page|
|
||||||
|
tags.concat(page)
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Found #{tags.count} tags"
|
||||||
|
end
|
||||||
|
|
||||||
|
tags
|
||||||
|
end
|
||||||
|
|
||||||
|
def github_token
|
||||||
|
if @options[:token]
|
||||||
|
return @github_token ||= @options[:token]
|
||||||
|
end
|
||||||
|
|
||||||
|
env_var = 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
|
||||||
|
end
|
||||||
|
|
||||||
|
@github_token ||= env_var
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
|
older_tag_time = self.get_time_of_tag(older_tag)
|
||||||
|
newer_tag_time = self.get_time_of_tag(newer_tag)
|
||||||
|
|
||||||
|
# if we mix up tags order - lits fix it!
|
||||||
|
# if older_tag_time < newer_tag_time
|
||||||
|
# older_tag, newer_tag = newer_tag, older_tag
|
||||||
|
# older_tag_time, newer_tag_time = newer_tag_time, older_tag_time
|
||||||
|
# puts "Swap tags!"
|
||||||
|
# end
|
||||||
|
|
||||||
|
newer_tag_name = newer_tag['name']
|
||||||
|
|
||||||
|
pull_requests = Array.new(@pull_requests)
|
||||||
|
|
||||||
|
pull_requests.delete_if { |req|
|
||||||
|
if req[:merged_at]
|
||||||
|
t = Time.parse(req[:merged_at]).utc
|
||||||
|
tag_is_older_of_older = t > older_tag_time
|
||||||
|
tag_is_newer_than_new = t <= newer_tag_time
|
||||||
|
|
||||||
|
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
|
||||||
|
!tag_not_in_range
|
||||||
|
else
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
issues = Array.new(@issues)
|
||||||
|
|
||||||
|
issues.delete_if { |issue|
|
||||||
|
if issue[:closed_at]
|
||||||
|
t = Time.parse(issue[:closed_at]).utc
|
||||||
|
tag_is_later_since = t > older_tag_time
|
||||||
|
tag_is_before_till = t <= newer_tag_time
|
||||||
|
|
||||||
|
in_range = (tag_is_later_since) && (tag_is_before_till)
|
||||||
|
!in_range
|
||||||
|
else
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
self.create_log(pull_requests, issues, newer_tag_name, newer_tag_time)
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def generate_log_before_tag(tag)
|
||||||
|
tag_time = self.get_time_of_tag(tag)
|
||||||
|
tag_name = tag['name']
|
||||||
|
|
||||||
|
pull_requests = Array.new(@pull_requests)
|
||||||
|
|
||||||
|
pull_requests.delete_if { |req|
|
||||||
|
if req[:merged_at]
|
||||||
|
t = Time.parse(req[:merged_at]).utc
|
||||||
|
t > tag_time
|
||||||
|
else
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
issues = Array.new(@issues)
|
||||||
|
|
||||||
|
issues.delete_if { |issue|
|
||||||
|
if issue[:closed_at]
|
||||||
|
t = Time.parse(issue[:closed_at]).utc
|
||||||
|
t > tag_time
|
||||||
|
else
|
||||||
|
true
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
self.create_log(pull_requests, issues, tag_name, tag_time)
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_log(pull_requests, issues, tag_name, tag_time)
|
||||||
|
|
||||||
|
# Generate tag name and link
|
||||||
|
trimmed_tag = tag_name.tr('v', '')
|
||||||
|
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
||||||
|
|
||||||
|
#Generate date string:
|
||||||
|
time_string = tag_time.strftime @options[:format]
|
||||||
|
log += "#### #{time_string}\n"
|
||||||
|
|
||||||
|
if @options[:pulls]
|
||||||
|
# Generate pull requests:
|
||||||
|
if pull_requests
|
||||||
|
pull_requests.each { |dict|
|
||||||
|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
||||||
|
log += "- #{merge}"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
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
|
||||||
|
else
|
||||||
|
if x.labels.any?
|
||||||
|
1
|
||||||
|
else
|
||||||
|
if y.labels.any?
|
||||||
|
-1
|
||||||
|
else
|
||||||
|
0
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
}.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
|
||||||
|
|
||||||
|
if is_enhancement
|
||||||
|
intro = 'Implemented enhancement'
|
||||||
|
end
|
||||||
|
|
||||||
|
merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
||||||
log += "- #{merge}"
|
log += "- #{merge}"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:issues]
|
def get_time_of_tag(prev_tag)
|
||||||
# Generate issues:
|
|
||||||
if issues
|
if @tag_times_hash[prev_tag['name']]
|
||||||
issues.sort! { |x, y|
|
return @tag_times_hash[prev_tag['name']]
|
||||||
if x.labels.any? && y.labels.any?
|
|
||||||
x.labels[0].name <=> y.labels[0].name
|
|
||||||
else
|
|
||||||
if x.labels.any?
|
|
||||||
1
|
|
||||||
else
|
|
||||||
if y.labels.any?
|
|
||||||
-1
|
|
||||||
else
|
|
||||||
0
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
}.reverse!
|
|
||||||
end
|
end
|
||||||
issues.each { |dict|
|
|
||||||
is_bug = false
|
if @options[:verbose]
|
||||||
is_enhancement = false
|
puts "Getting time for tag #{prev_tag['name']}"
|
||||||
dict.labels.each { |label|
|
end
|
||||||
if label.name == 'bug'
|
|
||||||
is_bug = true
|
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
||||||
end
|
time_string = github_git_data_commits_get['committer']['date']
|
||||||
if label.name == 'enhancement'
|
Time.parse(time_string)
|
||||||
is_enhancement = true
|
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def get_all_issues
|
||||||
|
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
||||||
|
|
||||||
|
|
||||||
|
issues = []
|
||||||
|
response.each_page do |page|
|
||||||
|
issues.concat(page)
|
||||||
|
end
|
||||||
|
|
||||||
|
# remove pull request from issues:
|
||||||
|
issues.select! { |x|
|
||||||
|
x.pull_request == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Receive all closed issues: #{issues.count}"
|
||||||
|
end
|
||||||
|
|
||||||
|
filtered_issues = issues.select { |issue|
|
||||||
|
#compare is there any labels from @options[:labels] array
|
||||||
|
(issue.labels.map { |label| label.name } & @options[:labels]).any?
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:add_issues_wo_labels]
|
||||||
|
issues_wo_labels = issues.select {
|
||||||
|
# add issues without any labels
|
||||||
|
|issue| !issue.labels.map { |label| label.name }.any?
|
||||||
}
|
}
|
||||||
|
filtered_issues.concat(issues_wo_labels)
|
||||||
|
end
|
||||||
|
|
||||||
intro = 'Closed issue'
|
if @options[:verbose]
|
||||||
if is_bug
|
puts "Filter issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count} issues"
|
||||||
intro = 'Fixed bug'
|
end
|
||||||
end
|
|
||||||
|
|
||||||
if is_enhancement
|
filtered_issues
|
||||||
intro = 'Implemented enhancement'
|
|
||||||
end
|
|
||||||
|
|
||||||
merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
|
||||||
log += "- #{merge}"
|
|
||||||
}
|
|
||||||
end
|
end
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_time_of_tag(prev_tag)
|
|
||||||
|
|
||||||
if @tag_times_hash[prev_tag['name']]
|
|
||||||
return @tag_times_hash[prev_tag['name']]
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Get time for tag #{prev_tag['name']}"
|
|
||||||
end
|
|
||||||
|
|
||||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
|
||||||
time_string = github_git_data_commits_get['committer']['date']
|
|
||||||
Time.parse(time_string)
|
|
||||||
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_all_issues
|
|
||||||
all_issues = []
|
|
||||||
|
|
||||||
issues_req = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
|
||||||
|
|
||||||
filtered_issues = issues_req.body.select { |issues|
|
|
||||||
#compare is there any labels from @options[:labels] array
|
|
||||||
(issues.labels.map { |issue| issue.name } & @options[:labels]).any?
|
|
||||||
}
|
|
||||||
|
|
||||||
if @options[:add_issues_wo_labels]
|
|
||||||
issues_wo_labels = issues_req.body.select {
|
|
||||||
|issues| !issues.labels.map { |issue| issue.name }.any?
|
|
||||||
}
|
|
||||||
filtered_issues.concat(issues_wo_labels)
|
|
||||||
end
|
|
||||||
|
|
||||||
# remove pull request from issues:
|
|
||||||
filtered_issues.select! { |x|
|
|
||||||
x.pull_request == nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Receive all closed issues with labels #{@options[:labels]}: #{all_issues.count} issues"
|
|
||||||
end
|
|
||||||
|
|
||||||
filtered_issues
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
if __FILE__ == $0
|
||||||
|
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||||
|
end
|
||||||
|
|
||||||
if __FILE__ == $0
|
end
|
||||||
changelog_generator = ChangelogGenerator.new
|
|
||||||
changelog_generator.compund_changelog
|
|
||||||
end
|
|
||||||
@@ -1,81 +1,88 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
require 'optparse'
|
require 'optparse'
|
||||||
|
require_relative 'version'
|
||||||
|
|
||||||
class Parser
|
module GitHubChangelogGenerator
|
||||||
def self.parse_options
|
class Parser
|
||||||
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ' }
|
def self.parse_options
|
||||||
|
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* '}
|
||||||
|
|
||||||
parser = OptionParser.new { |opts|
|
parser = OptionParser.new { |opts|
|
||||||
opts.banner = 'Usage: changelog_generator [options]'
|
opts.banner = 'Usage: changelog_generator [options]'
|
||||||
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
||||||
options[:user] = last
|
options[:user] = last
|
||||||
end
|
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
|
options[:project] = last
|
||||||
end
|
end
|
||||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications') do |last|
|
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new') do |last|
|
||||||
options[:token] = last
|
options[:token] = last
|
||||||
end
|
end
|
||||||
opts.on('-h', '--help', 'Displays Help') do
|
opts.on('-h', '--help', 'Displays Help') do
|
||||||
puts opts
|
puts opts
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
||||||
|
options[:verbose] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
|
||||||
|
options[:issues] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
|
||||||
|
options[:add_issues_wo_labels] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
||||||
|
options[:pulls] = v
|
||||||
|
end
|
||||||
|
opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
|
||||||
|
options[:last] = last
|
||||||
|
end
|
||||||
|
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
||||||
|
options[:format] = last
|
||||||
|
end
|
||||||
|
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
||||||
|
options[:output] = last
|
||||||
|
end
|
||||||
|
opts.on('--labels x,y,z', Array, 'List of labels. Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
||||||
|
options[:labels] = list
|
||||||
|
end
|
||||||
|
opts.on('-v', '--version', 'Print version number') do |v|
|
||||||
|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
parser.parse!
|
||||||
|
|
||||||
|
#udefined case with 1 parameter:
|
||||||
|
if ARGV[0] && !ARGV[1]
|
||||||
|
puts parser.banner
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
opts.on('-v', '--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
|
||||||
options[:verbose] = v
|
|
||||||
end
|
|
||||||
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
|
|
||||||
options[:issues] = v
|
|
||||||
end
|
|
||||||
opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
|
|
||||||
options[:add_issues_wo_labels] = v
|
|
||||||
end
|
|
||||||
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
|
||||||
options[:pulls] = v
|
|
||||||
end
|
|
||||||
opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
|
|
||||||
options[:last] = last
|
|
||||||
end
|
|
||||||
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
|
||||||
options[:format] = last
|
|
||||||
end
|
|
||||||
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
|
||||||
options[:output] = last
|
|
||||||
end
|
|
||||||
opts.on('--labels x,y,z', Array, 'List of labels. Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
|
||||||
options[:labels] = list
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
parser.parse!
|
if !options[:user] && !options[:project]
|
||||||
|
remote = `git remote -vv`.split("\n")
|
||||||
|
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
|
||||||
|
|
||||||
#udefined case with 1 parameter:
|
if match && match[1] && match[2]
|
||||||
if ARGV[0] && !ARGV[1]
|
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
||||||
puts parser.banner
|
options[:user], options[:project] = match[1], match[2]
|
||||||
exit
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
if !options[:user] || !options[:project]
|
||||||
|
puts parser.banner
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
if ARGV[1]
|
||||||
|
options[:tag1] = ARGV[0]
|
||||||
|
options[:tag2] = ARGV[1]
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
if !options[:user] && !options[:project]
|
|
||||||
remote = `git remote -vv`.split("\n")
|
|
||||||
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
|
|
||||||
|
|
||||||
if match && match[1] && match[2]
|
|
||||||
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
|
||||||
options[:user], options[:project] = match[1], match[2]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
|
||||||
puts parser.banner
|
|
||||||
exit
|
|
||||||
end
|
|
||||||
|
|
||||||
if ARGV[1]
|
|
||||||
options[:tag1] = ARGV[0]
|
|
||||||
options[:tag2] = ARGV[1]
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
options
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
3
lib/github_changelog_generator/version.rb
Normal file
3
lib/github_changelog_generator/version.rb
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
VERSION = '1.1.4'
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user