Compare commits

...

33 Commits
0.1.0 ... 1.1.0

Author SHA1 Message Date
Petr Korolev
7e2826e3b8 Update to version 1.1.0 2014-11-10 14:45:39 +02:00
Petr Korolev
c55881bdfa Merge branch 'new-features' 2014-11-10 14:45:15 +02:00
Petr Korolev
f6f9facc71 add changelog in lib to gitignore 2014-11-10 14:44:19 +02:00
Petr Korolev
807bacd95a formatting 2014-11-10 14:41:36 +02:00
Petr Korolev
936b191566 Fix bug with wrong credentials in 1.0.1 (fixed #12) 2014-11-10 14:40:10 +02:00
Petr Korolev
a33b52d6d0 typo fix 2014-11-10 14:39:31 +02:00
Petr Korolev
337c9a7d59 add option that close #11 2014-11-10 14:36:27 +02:00
Petr Korolev
8247fd8520 Merge branch 'new-features' 2014-11-10 14:15:53 +02:00
Petr Korolev
223cd2640c Merge remote-tracking branch 'origin/new-features' into new-features
Conflicts:
	lib/github_changelog_generator.rb

	Fix #9
2014-11-10 14:15:14 +02:00
Petr Korolev
459b0ec7ec Update to version 1.0.1 2014-11-10 13:36:15 +02:00
Petr Korolev
ea1c5c1f6d gem checks 2014-11-10 13:35:20 +02:00
Petr Korolev
86512d3606 impement revert option 2014-11-10 13:27:14 +02:00
Petr Korolev
b908b07e0a implement bump file 2014-11-10 13:11:35 +02:00
Petr Korolev
737774a164 implement find spec logic 2014-11-10 10:08:32 +02:00
Petr Korolev
62d9b7f4a6 rename 2014-11-10 09:21:02 +02:00
Petr Korolev
e75e358ef8 add bump script 2014-11-10 09:10:39 +02:00
Petr Korolev
3ac83e9ea7 Merge branch 'new-features' 2014-11-10 09:02:35 +02:00
Petr Korolev
70d3f63e89 fix for # 10 2014-11-10 09:02:11 +02:00
Petr Korolev
2db69dd27c small fix 2014-11-07 18:37:10 +02:00
Petr Korolev
5a7589f8ca update changelog 2014-11-07 18:35:59 +02:00
Petr Korolev
1adcd9918c update readme 2014-11-07 18:32:28 +02:00
Petr Korolev
afea098355 Bump major verion 2014-11-07 18:29:42 +02:00
Petr Korolev
d3c3b7850f Merge branch 'new-features' 2014-11-07 18:28:29 +02:00
Petr Korolev
502ae431b7 fix typo! 2014-11-07 18:24:02 +02:00
Petr Korolev
5882762800 tst cm 2014-11-07 18:14:56 +02:00
Petr Korolev
606fab4289 update Text for issues. (depends of what label placed) 2014-11-07 18:14:26 +02:00
Petr Korolev
3d25d1135f Merge branch 'new-features' 2014-11-07 18:00:08 +02:00
Petr Korolev
acd2daada3 Remove delimeter and fix parser. This final commit should close #6 enchantment! Yay! 2014-11-07 17:57:32 +02:00
Petr Korolev
381ffeb261 add support for issues 2014-11-07 17:47:42 +02:00
Petr Korolev
f9e6a076bc implement "issues" parsing + check for merged requests 2014-11-07 17:05:01 +02:00
Petr Korolev
8457b764bf update readme and bump gem 2014-11-07 13:52:23 +02:00
Petr Korolev
4237b751a0 clean gitignore file 2014-11-07 13:21:54 +02:00
Petr Korolev
3a78f97d61 add changelog file 2014-11-07 13:20:19 +02:00
7 changed files with 421 additions and 61 deletions

3
.gitignore vendored
View File

@@ -1,2 +1 @@
constants.rb /lib/CHANGELOG.md
*.md

27
CHANGELOG.md Normal file
View File

@@ -0,0 +1,27 @@
# Changelog
## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
#### 07/11/14
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7)
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
- *Implemented enhancement:* Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
#### 07/11/14
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2)
- Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1)
## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
#### 06/11/14
## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
#### 06/11/14
**This file was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

@@ -19,17 +19,22 @@ In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* chan
### Params: ### Params:
See `github_changelog_generator --help` for detailed usage. See `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator --user username --project project_name [options] Usage: changelog_generator --user username --project project_name [options]
-u, --user [USER] Username of the owner of target GitHub repo (required) -u, --user [USER] Username of the owner of target GitHub repo (required)
-p, --project [PROJECT] Name of project on GitHub (required) -p, --project [PROJECT] Name of project on GitHub (required)
-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 it on https://github.com/settings/applications
-h, --help Displays Help -h, --help Displays Help
-v, --[no-]verbose Run verbosely -v, --[no-]verbose Run verbosely
-l, --last-changes Generate log between only last 2 tags --[no-]issues Include closed issues to changelog. Default is true
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y --[no-]pull-requests Include pull-requests to changelog. Default is true
-o, --output [FORMAT] Output file. Default is CHANGELOG.md -l, --last-changes Generate log between last 2 tags only
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
-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'a
## Examples: ## Examples:
Look at changelog in this project!
### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) ### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
Was generated by command: Was generated by command:

227
bump_gemfile.rb Executable file
View File

@@ -0,0 +1,227 @@
#!/usr/bin/env ruby
require 'optparse'
SPEC_TYPE = 'gemspec'
:major
:minor
:patch
@options = {:dry_run => false, :bump_number => :patch}
OptionParser.new { |opts|
opts.banner = 'Usage: bump.rb [options]'
opts.on('-d', '--dry-run', 'Dry run') do |v|
@options[:dry_run] = v
end
opts.on('-a', '--major', 'Bump major version') do |v|
@options[:bump_number] = :major
end
opts.on('-m', '--minor', 'Bump minor version') do |v|
@options[:bump_number] = :minor
end
opts.on('-p', '--patch', 'Bump patch version') do |v|
@options[:bump_number] = :patch
end
opts.on('-r', '--revert', 'Revert last bump') do |v|
@options[:revert] = v
end
}.parse!
p @options
def check_repo_is_clean_or_dry_run
value =%x[#{'git status --porcelain'}]
if value.empty?
puts 'Repo is clean -> continue'
else
if @options[:dry_run]
puts 'Repo not clean, "Dry run" enabled -> continue'
else
puts 'Repository not clean -> exit'
exit
end
end
end
def find_spec_file
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
arr = list_of_specs.split("\n")
spec_file = ''
case arr.count
when 0
puts "No #{SPEC_TYPE} files found. -> Exit."
exit
when 1
spec_file = arr[0]
else
puts 'Which spec should be used?'
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
input_index = Integer(gets.chomp)
spec_file = arr[input_index-1]
end
if spec_file == nil
puts "Can't find specified spec file -> exit"
exit
end
spec_file.sub('./', '')
end
def find_current_gem_file
list_of_specs = execute_line("find . -name '*.gem'")
arr = list_of_specs.split("\n")
spec_file = ''
case arr.count
when 0
puts "No #{SPEC_TYPE} files found. -> Exit."
exit
when 1
spec_file = arr[0]
else
puts 'Which spec should be used?'
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
input_index = Integer(gets.chomp)
spec_file = arr[input_index-1]
end
if spec_file == nil
puts "Can't find specified spec file -> exit"
exit
end
spec_file.sub('./', '')
end
def find_version_in_podspec(podspec)
readme = File.read(podspec)
#try to find version in format 1.22.333
re = /(\d+)\.(\d+)\.(\d+)/m
match_result = re.match(readme)
unless match_result
puts 'Not found any versions'
exit
end
puts "Found version #{match_result[0]}"
return match_result[0], match_result.captures
end
def bump_version(versions_array)
bumped_result = versions_array.dup
bumped_result.map! { |x| x.to_i }
case @options[:bump_number]
when :major
bumped_result[0] += 1
bumped_result[1] = 0
bumped_result[2] = 0
when :minor
bumped_result[1] += 1
bumped_result[2] = 0
when :patch
bumped_result[2] += 1
else
raise('unknown bump_number')
end
bumped_version = bumped_result.join('.')
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
bumped_version
end
def execute_line(line)
output = `#{line}`
check_exit_status(output)
output
end
def execute_line_if_not_dry_run(line)
if @options[:dry_run]
puts "Dry run: #{line}"
nil
else
puts line
value = %x[#{line}]
puts value
check_exit_status(value)
value
end
end
def check_exit_status(output)
if $?.exitstatus != 0
puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
exit
end
end
def run_bumping_script
check_repo_is_clean_or_dry_run
spec_file = find_spec_file
result, versions_array = find_version_in_podspec(spec_file)
bumped_version = bump_version(versions_array)
unless @options[:dry_run]
puts 'Are you sure? Press Y to continue:'
str = gets.chomp
if str != 'Y'
puts '-> exit'
exit
end
end
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" README.md")
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
execute_line_if_not_dry_run("git tag #{bumped_version}")
execute_line_if_not_dry_run('git push')
execute_line_if_not_dry_run('git push --tags')
execute_line_if_not_dry_run("gem build #{spec_file}")
gem = find_current_gem_file
execute_line_if_not_dry_run("gem push #{gem}")
# execute_line_if_not_dry_run("pod trunk push #{spec_file}")
end
def revert_last_bump
spec_file = find_spec_file
result, _ = find_version_in_podspec(spec_file)
puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
str = gets.chomp
if str != 'Y'
puts '-> exit'
exit
end
execute_line_if_not_dry_run("git tag -d #{result}")
execute_line_if_not_dry_run('git reset --hard HEAD~1')
execute_line_if_not_dry_run("git push --delete origin #{result}")
end
if __FILE__ == $0
if @options[:revert]
revert_last_bump
else
run_bumping_script
end
end

View File

@@ -1,6 +1,6 @@
Gem::Specification.new do |s| Gem::Specification.new do |s|
s.name = "github_changelog_generator" s.name = "github_changelog_generator"
s.version = "0.0.2" s.version = "1.1.0"
s.default_executable = "github_changelog_generator" s.default_executable = "github_changelog_generator"
s.required_ruby_version = '>= 1.9.3' s.required_ruby_version = '>= 1.9.3'

View File

@@ -8,7 +8,7 @@ require_relative 'github_changelog_generator/parser'
class ChangelogGenerator class ChangelogGenerator
attr_accessor :options, :all_tags attr_accessor :options, :all_tags, :github
def initialize() def initialize()
@@ -20,6 +20,7 @@ class ChangelogGenerator
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
@tag_times_hash = {} @tag_times_hash = {}
end end
@@ -35,17 +36,14 @@ 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'
pull_requests = request.body
issues = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
json = issues.body
if @options[:verbose] if @options[:verbose]
puts 'Receive all pull requests' puts 'Receive all pull requests'
end end
json pull_requests
end end
def compund_changelog def compund_changelog
@@ -62,7 +60,7 @@ class ChangelogGenerator
tag1 = @options[:tag1] tag1 = @options[:tag1]
tag2 = @options[:tag2] tag2 = @options[:tag2]
tags_strings = [] tags_strings = []
self.all_tags.each { |x| tags_strings.push(x['name'])} self.all_tags.each { |x| tags_strings.push(x['name']) }
if tags_strings.include?(tag1) if tags_strings.include?(tag1)
if tags_strings.include?(tag2) if tags_strings.include?(tag2)
@@ -87,7 +85,7 @@ class ChangelogGenerator
puts log puts log
end end
log += "\n\n*This file was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*" log += "\n\n* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
output_filename = "#{@options[:output]}" output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) } File.open(output_filename, 'w') { |file| file.write(log) }
@@ -111,19 +109,6 @@ class ChangelogGenerator
@github.pull_requests.merged? @options[:user], @options[:project], number @github.pull_requests.merged? @options[:user], @options[:project], number
end end
def get_all_merged_pull_requests
json = self.get_all_closed_pull_requests
puts 'Check if the requests is merged... (it can take a while)'
json.delete_if { |req|
merged = self.is_megred(req[:number])
if @options[:verbose]
puts "##{req[:number]} #{merged ? 'merged' : 'not merged'}"
end
!merged
}
end
def get_all_tags def get_all_tags
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags" url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
@@ -132,9 +117,14 @@ class ChangelogGenerator
puts "Receive tags for repo #{url}" puts "Receive tags for repo #{url}"
end end
response = HTTParty.get(url, if @options[:token]
:headers => {'Authorization' => 'token 8587bb22f6bf125454768a4a19dbcc774ea68d48', response = HTTParty.get(url,
'User-Agent' => 'Changelog-Generator'}) :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) json_parse = JSON.parse(response.body)
@@ -160,15 +150,37 @@ class ChangelogGenerator
pull_requests = Array.new(@pull_requests) pull_requests = Array.new(@pull_requests)
pull_requests.delete_if { |req| pull_requests.delete_if { |req|
t = Time.parse(req[:merged_at]).utc if req[:merged_at]
tag_is_later_since = t > since_tag_time t = Time.parse(req[:merged_at]).utc
tag_is_before_till = t <= till_tag_time 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
in_range = (tag_is_later_since) && (tag_is_before_till)
!in_range
} }
self.create_log(pull_requests, till_tag_name, till_tag_time) issues = Array.new(@issues)
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
in_range = (tag_is_later_since) && (tag_is_before_till)
!in_range
else
true
end
}
self.create_log(pull_requests, issues, till_tag_name, till_tag_time)
end end
def generate_log_before_tag(tag) def generate_log_before_tag(tag)
@@ -178,26 +190,81 @@ class ChangelogGenerator
pull_requests = Array.new(@pull_requests) pull_requests = Array.new(@pull_requests)
pull_requests.delete_if { |req| pull_requests.delete_if { |req|
t = Time.parse(req[:closed_at]).utc if req[:merged_at]
t > tag_time t = Time.parse(req[:merged_at]).utc
t > tag_time
else
true
end
} }
self.create_log(pull_requests, tag_name, tag_time) 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 end
def create_log(pull_requests, tag_name, tag_time) def create_log(pull_requests, issues, tag_name, tag_time)
# Generate tag name and link
trimmed_tag = tag_name.tr('v', '') trimmed_tag = tag_name.tr('v', '')
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n" log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
#Generate date string:
time_string = tag_time.strftime @options[:format] time_string = tag_time.strftime @options[:format]
log += "#### #{time_string}\n" log += "#### #{time_string}\n"
pull_requests.each { |dict| if @options[:pulls]
merge = "#{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/pull/#{dict[:number]})\n\n" # Generate pull requests:
log += "- #{merge}" if pull_requests
} pull_requests.each { |dict|
merge = "#{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/pull/#{dict[:number]})\n\n"
log += "- #{merge}"
}
end
end
if @options[:issues]
# Generate issues:
if issues
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]}](https://github.com/#{@options[:user]}/#{@options[:project]}/issues/#{dict[:number]})\n\n"
log += "- #{merge}"
}
end
end
log log
end end
@@ -217,8 +284,23 @@ class ChangelogGenerator
@tag_times_hash[prev_tag['name']] = Time.parse(time_string) @tag_times_hash[prev_tag['name']] = Time.parse(time_string)
end end
def get_all_issues
all_issues = []
@options[:labels].each { |label|
issues = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: label
all_issues = all_issues.concat(issues.body)
}
if @options[:verbose]
puts "Receive all closed issues with labels #{@options[:labels]}: #{all_issues.count} issues"
end
all_issues
end
end end
if __FILE__ == $0 if __FILE__ == $0
ChangelogGenerator.new.compund_changelog changelog_generator = ChangelogGenerator.new
changelog_generator.compund_changelog
end end

View File

@@ -3,14 +3,14 @@ require 'optparse'
class Parser class Parser
def self.parse_options def self.parse_options
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md'} options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true}
parser = OptionParser.new { |opts| parser = OptionParser.new { |opts|
opts.banner = 'Usage: changelog_generator --user username --project project_name [options]' opts.banner = 'Usage: changelog_generator [options]'
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo (required)') 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 (required)') 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 it on https://github.com/settings/applications') do |last|
@@ -23,15 +23,24 @@ class Parser
opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v| opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
options[:verbose] = v options[:verbose] = v
end end
opts.on('-l', '--last-changes', 'Generate log between only last 2 tags') do |last| opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
options[:issues] = 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 options[:last] = last
end end
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last| opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
options[:format] = last options[:format] = last
end end
opts.on('-o', '--output [FORMAT]', 'Output file. Default is CHANGELOG.md') do |last| opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
options[:output] = last options[:output] = last
end 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! parser.parse!
@@ -42,6 +51,17 @@ class Parser
exit exit
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] if !options[:user] || !options[:project]
puts parser.banner puts parser.banner
exit exit