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
|
||||
|
||||
## [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)
|
||||
#### 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)
|
||||
|
||||
2
Gemfile
2
Gemfile
@@ -1,3 +1,3 @@
|
||||
source 'https://rubygems.org'
|
||||
gem 'github_api'
|
||||
gem 'httparty'
|
||||
gem 'colorize'
|
||||
@@ -2,6 +2,7 @@ GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.3.6)
|
||||
colorize (0.7.3)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
faraday (0.9.0)
|
||||
@@ -15,10 +16,6 @@ GEM
|
||||
nokogiri (~> 1.6.3)
|
||||
oauth2
|
||||
hashie (3.3.1)
|
||||
httparty (0.13.2)
|
||||
json (~> 1.8)
|
||||
multi_xml (>= 0.5.2)
|
||||
json (1.8.1)
|
||||
jwt (1.0.0)
|
||||
mini_portile (0.6.1)
|
||||
multi_json (1.10.1)
|
||||
@@ -39,5 +36,5 @@ PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
colorize
|
||||
github_api
|
||||
httparty
|
||||
|
||||
13
README.md
13
README.md
@@ -49,7 +49,16 @@ Type `github_changelog_generator --help` for detailed usage.
|
||||
|
||||
|
||||
## 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:
|
||||
>! /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?
|
||||
|
||||
**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!*
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
#! /usr/bin/env ruby
|
||||
|
||||
require 'github_changelog_generator'
|
||||
|
||||
ChangelogGenerator.new.compund_changelog
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||
@@ -1,21 +1,32 @@
|
||||
Gem::Specification.new do |s|
|
||||
s.name = "github_changelog_generator"
|
||||
s.version = "1.1.2"
|
||||
s.default_executable = "github_changelog_generator"
|
||||
# coding: utf-8
|
||||
|
||||
s.required_ruby_version = '>= 1.9.3'
|
||||
s.authors = ["Petr Korolev"]
|
||||
s.date = %q{2014-10-10}
|
||||
s.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
|
||||
s.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||
s.files = ["lib/github_changelog_generator.rb", "lib/github_changelog_generator/parser.rb", "bin/github_changelog_generator"]
|
||||
s.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
||||
s.require_paths = ["lib"]
|
||||
s.rubygems_version = %q{1.6.2}
|
||||
s.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
|
||||
s.license = "MIT"
|
||||
s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
|
||||
s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||
lib = File.expand_path('../lib', __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require 'github_changelog_generator/version'
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "github_changelog_generator"
|
||||
spec.version = GitHubChangelogGenerator::VERSION
|
||||
spec.default_executable = "github_changelog_generator"
|
||||
|
||||
spec.required_ruby_version = '>= 1.9.3'
|
||||
spec.authors = ["Petr Korolev"]
|
||||
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||
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
|
||||
|
||||
@@ -2,22 +2,27 @@
|
||||
|
||||
require 'github_api'
|
||||
require 'json'
|
||||
require 'httparty'
|
||||
require 'colorize'
|
||||
require_relative 'github_changelog_generator/parser'
|
||||
require_relative 'github_changelog_generator/version'
|
||||
|
||||
|
||||
module GitHubChangelogGenerator
|
||||
class ChangelogGenerator
|
||||
|
||||
attr_accessor :options, :all_tags, :github
|
||||
|
||||
def initialize()
|
||||
def initialize
|
||||
|
||||
@options = Parser.parse_options
|
||||
if @options[:token]
|
||||
@github = Github.new oauth_token: @options[:token]
|
||||
else
|
||||
|
||||
github_token
|
||||
|
||||
if @github_token.nil?
|
||||
@github = Github.new
|
||||
else
|
||||
@github = Github.new oauth_token: @github_token
|
||||
end
|
||||
|
||||
@all_tags = self.get_all_tags
|
||||
@pull_requests = self.get_all_closed_pull_requests
|
||||
@issues = self.get_all_issues
|
||||
@@ -36,11 +41,15 @@ class ChangelogGenerator
|
||||
|
||||
|
||||
def get_all_closed_pull_requests
|
||||
request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
pull_requests = request.body
|
||||
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
|
||||
pull_requests = []
|
||||
response.each_page do |page|
|
||||
pull_requests.concat(page)
|
||||
end
|
||||
|
||||
if @options[:verbose]
|
||||
puts 'Receive all pull requests'
|
||||
puts "Receive all pull requests: #{pull_requests.count}"
|
||||
end
|
||||
|
||||
pull_requests
|
||||
@@ -91,8 +100,21 @@ class ChangelogGenerator
|
||||
|
||||
def generate_log_for_all_tags
|
||||
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
|
||||
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
|
||||
|
||||
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"
|
||||
|
||||
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
|
||||
response = @github.repos.tags @options[:user], @options[:project]
|
||||
|
||||
json_parse = JSON.parse(response.body)
|
||||
tags = []
|
||||
response.each_page do |page|
|
||||
tags.concat(page)
|
||||
end
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Found #{json_parse.count} tags"
|
||||
puts "Found #{tags.count} tags"
|
||||
end
|
||||
|
||||
json_parse
|
||||
tags
|
||||
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)
|
||||
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 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
|
||||
# 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
|
||||
|
||||
till_tag_name = till_tag['name']
|
||||
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_later_since = t > since_tag_time
|
||||
tag_is_before_till = t <= till_tag_time
|
||||
tag_is_older_of_older = t > older_tag_time
|
||||
tag_is_newer_than_new = t <= newer_tag_time
|
||||
|
||||
in_range = (tag_is_later_since) && (tag_is_before_till)
|
||||
!in_range
|
||||
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
|
||||
!tag_not_in_range
|
||||
else
|
||||
true
|
||||
end
|
||||
@@ -163,8 +200,8 @@ class ChangelogGenerator
|
||||
issues.delete_if { |issue|
|
||||
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
|
||||
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
|
||||
@@ -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
|
||||
|
||||
@@ -283,7 +320,7 @@ class ChangelogGenerator
|
||||
end
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Get time for tag #{prev_tag['name']}"
|
||||
puts "Getting 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']
|
||||
@@ -293,29 +330,38 @@ class ChangelogGenerator
|
||||
end
|
||||
|
||||
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|
|
||||
#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)
|
||||
issues = []
|
||||
response.each_page do |page|
|
||||
issues.concat(page)
|
||||
end
|
||||
|
||||
# remove pull request from issues:
|
||||
filtered_issues.select! { |x|
|
||||
issues.select! { |x|
|
||||
x.pull_request == nil
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
filtered_issues
|
||||
@@ -325,6 +371,7 @@ class ChangelogGenerator
|
||||
end
|
||||
|
||||
if __FILE__ == $0
|
||||
changelog_generator = ChangelogGenerator.new
|
||||
changelog_generator.compund_changelog
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,6 +1,8 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'optparse'
|
||||
require_relative 'version'
|
||||
|
||||
module GitHubChangelogGenerator
|
||||
class Parser
|
||||
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:* '}
|
||||
@@ -13,14 +15,14 @@ class Parser
|
||||
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
|
||||
options[:project] = last
|
||||
end
|
||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests 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
|
||||
end
|
||||
opts.on('-h', '--help', 'Displays Help') do
|
||||
puts opts
|
||||
exit
|
||||
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
|
||||
end
|
||||
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|
|
||||
options[:labels] = list
|
||||
end
|
||||
opts.on('-v', '--version', 'Print version number') do |v|
|
||||
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||
exit
|
||||
end
|
||||
}
|
||||
|
||||
parser.parse!
|
||||
@@ -79,3 +85,4 @@ class Parser
|
||||
options
|
||||
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