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

Merge branch 'master' into travis-update

Browse Source 
Conflicts:
	Gemfile
This commit is contained in:
Petr Korolev 2014-12-02 18:03:55 +02:00
commit ff52291d2a
9 changed files with 528 additions and 393 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
CHANGELOG.md
View File

@ -1,12 +1,42 @@
# Changelog # Changelog
## [1.2.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
#### 22/11/14
- *Merged pull-request:* Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
## [1.2.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
#### 19/11/14
- *Merged pull-request:* Add filter for pull-requests labels. (option --filter-pull-requests) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Test Pull-Request [\#26](https://github.com/skywinder/Github-Changelog-Generator/pull/26) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Add ability to insert authors of pull-requests (--[no-]author option) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
## [1.1.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4)
#### 18/11/14
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Implement ability to retrieve GitHub token from ENV 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) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
## [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) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) - *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) - *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) ## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
#### 10/11/14 #### 10/11/14
@ -18,13 +48,13 @@
## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) ## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
#### 10/11/14 #### 10/11/14
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) - *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) ## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
#### 07/11/14 #### 07/11/14
- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) - *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) - *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4) - *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
@ -34,9 +64,9 @@
## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) ## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
#### 07/11/14 #### 07/11/14
- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) - *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) - *Merged pull-request:* Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) ## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
#### 06/11/14 #### 06/11/14

4
Gemfile
View File

@ -1,5 +1,3 @@
source 'https://rubygems.org' source 'https://rubygems.org'
gem 'github_api' gem 'github_api'
gem 'httparty' gem 'colorize'
gem 'rake'

7
Gemfile.lock
View File

@ -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

74
README.md
View File

@ -8,57 +8,77 @@ Changelog generation has never been so easy.
This script automatically generate change-log from your tags and merged pull-requests. This script automatically generate change-log from your tags and merged pull-requests.
## Installation: ## Installation:
You're almost done!
[sudo] gem install github_changelog_generator [sudo] gem install github_changelog_generator
## Usage ## Usage
**It's really simple**: **It's really simple**:
- `cd` to your Project folder with configured git and just type: - If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder just run:
github_changelog_generator github_changelog_generator
- from anywhere: - or from anywhere:
github_changelog_generator -u github-username -p github-project github_changelog_generator -u github-username -p github-project
As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog. As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
## Params: ### Params:
Type `github_changelog_generator --help` for detailed usage. Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator [options] Usage: changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo -u, --user [USER] Username of the owner of target GitHub repo
-p, --project [PROJECT] Name of project on GitHub -p, --project [PROJECT] Name of project on GitHub
-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 -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
-h, --help Displays Help -h, --help Displays Help
-v, --[no-]verbose Run verbosely. Default is true --[no-]verbose Run verbosely. Default is true
--[no-]issues Include closed issues to changelog. Default is true --[no-]issues Include closed issues to changelog. Default is true
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
--[no-]pull-requests Include pull-requests to changelog. Default is true --[no-]pull-requests Include pull-requests to changelog. Default is true
-l, --last-changes Generate log between last 2 tags only -l, --last-changes Generate log between last 2 tags only
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y --[no-]author Add author of pull-request in the end. Default is true
-o, --output [NAME] Output file. Default is CHANGELOG.md -f, --date-format [FORMAT] Date format. Default is %d/%m/%y
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement' -o, --output [NAME] Output file. Default is CHANGELOG.md
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
## Examples: -v, --version Print version number
- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
## FAQ: ### GitHub token
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]`
- 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'
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP. It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## Examples:
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
## Projects using this library
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
## 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!*
@ -74,3 +94,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
## License ## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT). Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

5
bin/github_changelog_generator
View File

@ -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

47
github_changelog_generator.gemspec
View File

@ -1,21 +1,32 @@
Gem::Specification.new do |s| # coding: utf-8
s.name = "github_changelog_generator"
s.version = "1.1.1"
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

580
lib/github_changelog_generator.rb
View File

@ -2,329 +2,391 @@
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 if options[:verbose]
if @options[:token] puts 'Input options:'
@github = Github.new oauth_token: @options[:token] pp options
else puts ''
@github = Github.new end
end
@all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests
@issues = self.get_all_issues
@tag_times_hash = {} github_token
end
def print_json(json) if @github_token.nil?
puts JSON.pretty_generate(json) @github = Github.new
end else
@github = Github.new oauth_token: @github_token
end
def exec_command(cmd) @all_tags = self.get_all_tags
exec_cmd = "cd #{$project_path} && #{cmd}" @pull_requests = self.get_all_closed_pull_requests
%x[#{exec_cmd}] if @options[:issues]
end @issues = self.get_all_issues
else
@issues = []
end
@tag_times_hash = {}
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} and #{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]
tags_strings = []
self.all_tags.each { |x| tags_strings.push(x['name']) }
if tags_strings.include?(tag1) if @options[:verbose]
if tags_strings.include?(tag2) puts 'Fetching pull requests..'
hash = Hash[tags_strings.map.with_index.to_a] end
index1 = hash[tag1]
index2 = hash[tag2] response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
pull_requests = []
response.each_page do |page|
pull_requests.concat(page)
end
if @options[:verbose]
puts "Received all closed pull requests: #{pull_requests.count}"
end
unless @options[:pull_request_labels].nil?
if @options[:verbose]
puts 'Filter all pull requests by labels.'
end
filtered_pull_requests = pull_requests.select { |pull_request|
#We need issue to fetch labels
issue = @github.issues.get @options[:user], @options[:project], pull_request.number
#compare is there any labels from @options[:labels] array
select_no_label = !issue.labels.map { |label| label.name }.any?
if @options[:verbose]
puts "Filter request \##{issue.number}."
end
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
select_by_label | select_no_label
}
if @options[:verbose]
puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
end
return filtered_pull_requests
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] and @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 end
else
log += self.generate_log_for_all_tags 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 end
log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*" def generate_log_for_all_tags
log = ''
@all_tags.each { |tag| self.get_time_of_tag(tag) }
output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
puts "Done! Generated log placed in #{output_filename}" if @options[:verbose]
puts "Sorting tags.."
end
end @all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
def generate_log_for_all_tags if @options[:verbose]
log = '' puts "Generating log.."
for index in 1 ... self.all_tags.size end
log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
for index in 1 ... self.all_tags.size
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
end
log += self.generate_log_before_tag(self.all_tags.last)
log
end end
log += self.generate_log_before_tag(self.all_tags.last) def is_megred(number)
@github.pull_requests.merged? @options[:user], @options[:project], number
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 end
if @options[:token] def get_all_tags
response = HTTParty.get(url,
:headers => {'Authorization' => "token #{@options[:token]}", if @options[:verbose]
'User-Agent' => 'Changelog-Generator'}) puts 'Fetching all tags..'
else end
response = HTTParty.get(url,
:headers => {'User-Agent' => 'Changelog-Generator'}) 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 end
json_parse = JSON.parse(response.body) 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
if @options[:verbose]
puts "Found #{json_parse.count} tags"
end end
json_parse
end
def generate_log_between_tags(since_tag, till_tag) def generate_log_between_tags(older_tag, newer_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! newer_tag_time = self.get_time_of_tag(newer_tag)
if since_tag_time > till_tag_time newer_tag_name = newer_tag['name']
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'] if older_tag.nil?
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
pull_requests = Array.new(@pull_requests) issues = delete_by_time(@issues, :closed_at, newer_tag_time)
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 else
true older_tag_time = self.get_time_of_tag(older_tag)
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
end end
} self.create_log(filtered_pull_requests, issues, newer_tag_name, newer_tag_time)
issues = Array.new(@issues) end
issues.delete_if { |issue| def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
if issue[:closed_at] array.select { |req|
t = Time.parse(issue[:closed_at]).utc if req[hash_key]
tag_is_later_since = t > since_tag_time t = Time.parse(req[hash_key]).utc
tag_is_before_till = t <= till_tag_time
in_range = (tag_is_later_since) && (tag_is_before_till) if older_tag_time.nil?
!in_range tag_in_range_old = true
else else
true tag_in_range_old = t > older_tag_time
end
tag_in_range_new = t <= newer_tag_time
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range
else
false
end
}
end
def generate_log_before_tag(tag)
generate_log_between_tags(nil, tag)
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
if @options[:author]
pull_requests.each { |dict|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url}) ([#{dict.user.login}](#{dict.user.html_url}))\n\n"
log += "- #{merge}"
}
else
pull_requests.each { |dict|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
log += "- #{merge}"
}
end
end
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
}
self.create_log(pull_requests, issues, till_tag_name, till_tag_time) intro = 'Closed issue'
if is_bug
intro = 'Fixed bug'
end
end if is_enhancement
intro = 'Implemented enhancement'
end
def generate_log_before_tag(tag) merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
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}" 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 "Received 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 end
def get_time_of_tag(prev_tag) if __FILE__ == $0
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
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 end
if __FILE__ == $0
changelog_generator = ChangelogGenerator.new
changelog_generator.compund_changelog
end

151
lib/github_changelog_generator/parser.rb
View File

@ -1,81 +1,92 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
require 'optparse' require 'optparse'
require 'PP'
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:* ', :author => true, :pull_request_labels => nil}
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 per hour your GitHub token required. You can generate it 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('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
puts opts options[:format] = last
end
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
options[:output] = last
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('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
options[:last] = author
end
opts.on('--labels x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
options[:labels] = list
end
opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
options[:pull_request_labels] = list
end
opts.on('-v', '--version', 'Print version number') do |v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit
end
opts.on('-h', '--help', 'Displays Help') do
puts opts
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[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
View File

@ -0,0 +1,3 @@
module GitHubChangelogGenerator
VERSION = '1.2.1'
end