Compare commits

..

20 Commits
1.1.2 ... 1.1.4

Author SHA1 Message Date
Petr Korolev
9f9f237e96 Update gemspec to version 1.1.4 2014-11-18 15:48:27 +02:00
Petr Korolev
3e1abf928d remove dependency 2014-11-18 15:48:00 +02:00
Petr Korolev
7ce486085b Update changelog for version 1.1.3 2014-11-18 15:28:06 +02:00
Petr Korolev
bf17d9e284 Update gemspec to version 1.1.3 2014-11-18 15:27:43 +02:00
Petr Korolev
fadae1b714 remove httpparty from gem 2014-11-18 15:20:57 +02:00
Petr Korolev
a5cb604bc1 fix 2014-11-18 10:21:35 +02:00
Petr Korolev
7f89aae72e update gemspec 2014-11-18 10:17:01 +02:00
Petr Korolev
b6ec9bd8be update gemspec file 2014-11-17 18:14:44 +02:00
Petr Korolev
80de58779d Merge branch 'new-features' 2014-11-17 17:54:25 +02:00
Petr Korolev
07e0ec0cfb Move version to separate file 2014-11-17 17:54:13 +02:00
Petr Korolev
fab1e28e3e Merge branch 'new-features' 2014-11-17 17:54:02 +02:00
Petr Korolev
0ab44f79f7 Sort tag by date, not by name 2014-11-17 17:43:37 +02:00
Petr Korolev
269ab4e790 Merge branch 'new-features' 2014-11-17 16:55:25 +02:00
Petr Korolev
4fa903b5cd fix for #20 2014-11-17 16:53:47 +02:00
Petr Korolev
c018bf2db5 Merge branch 'new-features' 2014-11-13 09:35:31 +02:00
Petr Korolev
c830d6c1ef update readme 2014-11-13 09:22:32 +02:00
Petr Korolev
03bca478c8 Add token support, resolved #19.
Use CHANGELOG_GITHUB_TOKEN variable to specify token in the shell.
2014-11-13 09:09:12 +02:00
Petr Korolev
91229c7472 cleanup 2014-11-12 17:23:16 +02:00
Petr Korolev
7bd174126b fix date in gems 2014-11-12 11:19:11 +02:00
Petr Korolev
4b716645e5 update changelog 2014-11-12 11:19:04 +02:00
9 changed files with 460 additions and 373 deletions

View File

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

View File

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

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

View File

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

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

View File

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

View File

@@ -2,22 +2,27 @@
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[:token]
@github = Github.new oauth_token: @options[:token] github_token
else
if @github_token.nil?
@github = Github.new @github = Github.new
else
@github = Github.new oauth_token: @github_token
end end
@all_tags = self.get_all_tags @all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests @pull_requests = self.get_all_closed_pull_requests
@issues = self.get_all_issues @issues = self.get_all_issues
@@ -36,11 +41,15 @@ class ChangelogGenerator
def get_all_closed_pull_requests def get_all_closed_pull_requests
request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed' response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
pull_requests = request.body
pull_requests = []
response.each_page do |page|
pull_requests.concat(page)
end
if @options[:verbose] if @options[:verbose]
puts 'Receive all pull requests' puts "Receive all pull requests: #{pull_requests.count}"
end end
pull_requests pull_requests
@@ -91,8 +100,21 @@ class ChangelogGenerator
def generate_log_for_all_tags def generate_log_for_all_tags
log = '' log = ''
@all_tags.each { |tag| self.get_time_of_tag(tag) }
if @options[:verbose]
puts "Sorting tags.."
end
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
if @options[:verbose]
puts "Generating log.."
end
for index in 1 ... self.all_tags.size for index in 1 ... self.all_tags.size
log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index]) log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
end end
log += self.generate_log_before_tag(self.all_tags.last) log += self.generate_log_before_tag(self.all_tags.last)
@@ -109,49 +131,64 @@ class ChangelogGenerator
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags" url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
if @options[:verbose] if @options[:verbose]
puts "Receive tags for repo #{url}" puts "Receive tags for repo #{url}"
end end
if @options[:token] response = @github.repos.tags @options[:user], @options[:project]
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) tags = []
response.each_page do |page|
tags.concat(page)
end
if @options[:verbose] if @options[:verbose]
puts "Found #{json_parse.count} tags" puts "Found #{tags.count} tags"
end end
json_parse tags
end end
def generate_log_between_tags(since_tag, till_tag) def github_token
since_tag_time = self.get_time_of_tag(since_tag) if @options[:token]
till_tag_time = self.get_time_of_tag(till_tag) 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 we mix up tags order - lits fix it!
if since_tag_time > till_tag_time # if older_tag_time < newer_tag_time
since_tag, till_tag = till_tag, since_tag # older_tag, newer_tag = newer_tag, older_tag
since_tag_time, till_tag_time = till_tag_time, since_tag_time # older_tag_time, newer_tag_time = newer_tag_time, older_tag_time
end # puts "Swap tags!"
# end
till_tag_name = till_tag['name'] newer_tag_name = newer_tag['name']
pull_requests = Array.new(@pull_requests) pull_requests = Array.new(@pull_requests)
pull_requests.delete_if { |req| pull_requests.delete_if { |req|
if req[:merged_at] if req[:merged_at]
t = Time.parse(req[:merged_at]).utc t = Time.parse(req[:merged_at]).utc
tag_is_later_since = t > since_tag_time tag_is_older_of_older = t > older_tag_time
tag_is_before_till = t <= till_tag_time tag_is_newer_than_new = t <= newer_tag_time
in_range = (tag_is_later_since) && (tag_is_before_till) tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
!in_range !tag_not_in_range
else else
true true
end end
@@ -163,8 +200,8 @@ class ChangelogGenerator
issues.delete_if { |issue| issues.delete_if { |issue|
if issue[:closed_at] if issue[:closed_at]
t = Time.parse(issue[:closed_at]).utc t = Time.parse(issue[:closed_at]).utc
tag_is_later_since = t > since_tag_time tag_is_later_since = t > older_tag_time
tag_is_before_till = t <= till_tag_time tag_is_before_till = t <= newer_tag_time
in_range = (tag_is_later_since) && (tag_is_before_till) in_range = (tag_is_later_since) && (tag_is_before_till)
!in_range !in_range
@@ -174,7 +211,7 @@ class ChangelogGenerator
} }
self.create_log(pull_requests, issues, till_tag_name, till_tag_time) self.create_log(pull_requests, issues, newer_tag_name, newer_tag_time)
end end
@@ -283,7 +320,7 @@ class ChangelogGenerator
end end
if @options[:verbose] if @options[:verbose]
puts "Get time for tag #{prev_tag['name']}" puts "Getting time for tag #{prev_tag['name']}"
end end
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha'] github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
@@ -293,29 +330,38 @@ class ChangelogGenerator
end end
def get_all_issues def get_all_issues
all_issues = [] response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
issues_req = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
filtered_issues = issues_req.body.select { |issues| issues = []
#compare is there any labels from @options[:labels] array response.each_page do |page|
(issues.labels.map { |issue| issue.name } & @options[:labels]).any? issues.concat(page)
}
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 end
# remove pull request from issues: # remove pull request from issues:
filtered_issues.select! { |x| issues.select! { |x|
x.pull_request == nil x.pull_request == nil
} }
if @options[:verbose] if @options[:verbose]
puts "Receive all closed issues with labels #{@options[:labels]}: #{all_issues.count} issues" 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
if @options[:verbose]
puts "Filter issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count} issues"
end end
filtered_issues filtered_issues
@@ -325,6 +371,7 @@ class ChangelogGenerator
end end
if __FILE__ == $0 if __FILE__ == $0
changelog_generator = ChangelogGenerator.new GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
changelog_generator.compund_changelog end
end end

View File

@@ -1,6 +1,8 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
require 'optparse' require 'optparse'
require_relative 'version'
module GitHubChangelogGenerator
class Parser class Parser
def self.parse_options 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:* '} 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:* '}
@@ -13,14 +15,14 @@ class Parser
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 exit
end end
opts.on('-v', '--[no-]verbose', 'Run verbosely. Default is true') do |v| opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
options[:verbose] = v options[:verbose] = v
end end
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v| opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
@@ -44,6 +46,10 @@ class Parser
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| 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 options[:labels] = list
end end
opts.on('-v', '--version', 'Print version number') do |v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit
end
} }
parser.parse! parser.parse!
@@ -79,3 +85,4 @@ class Parser
options options
end end
end end
end

View File

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