Compare commits
51 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7e2826e3b8 | ||
|
|
c55881bdfa | ||
|
|
f6f9facc71 | ||
|
|
807bacd95a | ||
|
|
936b191566 | ||
|
|
a33b52d6d0 | ||
|
|
337c9a7d59 | ||
|
|
8247fd8520 | ||
|
|
223cd2640c | ||
|
|
459b0ec7ec | ||
|
|
ea1c5c1f6d | ||
|
|
86512d3606 | ||
|
|
b908b07e0a | ||
|
|
737774a164 | ||
|
|
62d9b7f4a6 | ||
|
|
e75e358ef8 | ||
|
|
3ac83e9ea7 | ||
|
|
70d3f63e89 | ||
|
|
2db69dd27c | ||
|
|
5a7589f8ca | ||
|
|
1adcd9918c | ||
|
|
afea098355 | ||
|
|
d3c3b7850f | ||
|
|
502ae431b7 | ||
|
|
5882762800 | ||
|
|
606fab4289 | ||
|
|
3d25d1135f | ||
|
|
acd2daada3 | ||
|
|
381ffeb261 | ||
|
|
f9e6a076bc | ||
|
|
8457b764bf | ||
|
|
4237b751a0 | ||
|
|
3a78f97d61 | ||
|
|
24c5f66c65 | ||
|
|
9c4b68f779 | ||
|
|
65e978f4a8 | ||
|
|
6b4333f98a | ||
|
|
675601880d | ||
|
|
e2aac3cb2c | ||
|
|
20095c571d | ||
|
|
db1c125e7e | ||
|
|
a335594bcc | ||
|
|
5e64e5a226 | ||
|
|
0a69f76191 | ||
|
|
959d406ef0 | ||
|
|
cf4386a3a3 | ||
|
|
daf391dd1a | ||
|
|
26d4717b7d | ||
|
|
e331525e21 | ||
|
|
b32969e72c | ||
|
|
b8d13a6331 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,2 +1 @@
|
||||
constants.rb
|
||||
*.md
|
||||
/lib/CHANGELOG.md
|
||||
|
||||
27
CHANGELOG.md
Normal file
27
CHANGELOG.md
Normal 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)*
|
||||
71
README.md
71
README.md
@@ -1,23 +1,68 @@
|
||||
Github Changelog Generator
|
||||
GitHub Changelog Generator
|
||||
==================
|
||||
|
||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||
|
||||
Changelog generation has never been so easy.
|
||||
|
||||
This script automatically generate change-log from your tags and merged pull-requests.
|
||||
|
||||
Usage: github_changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
|
||||
-u, --user [USER] your username on GitHub
|
||||
-p, --project [PROJECT] name of project on GitHub
|
||||
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
|
||||
-h, --help Displays Help
|
||||
-v, --[no-]verbose Run verbosely
|
||||
-l, --last-changes generate log between last 2 tags
|
||||
-f, --date-format [FORMAT] date format. default is %d/%m/%y
|
||||
## Installation:
|
||||
[sudo] gem install github_changelog_generator
|
||||
|
||||
### Example:
|
||||
`github_changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]`
|
||||
## Usage
|
||||
|
||||
In output you get `[your_project]_changelog.md` file with automatically generated changelogs.
|
||||
github_changelog_generator -u github-username -p github-project
|
||||
|
||||
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
|
||||
|
||||
### Params:
|
||||
See `github_changelog_generator --help` for detailed usage.
|
||||
|
||||
Usage: changelog_generator --user username --project project_name [options]
|
||||
-u, --user [USER] Username of the owner of target GitHub repo (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
|
||||
-h, --help Displays Help
|
||||
-v, --[no-]verbose Run verbosely
|
||||
--[no-]issues Include closed issues 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
|
||||
-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:
|
||||
Look at changelog in 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:
|
||||
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)**.
|
||||
|
||||
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': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden)
|
||||
|
||||
It's time to generate this token or wait for 1 hour before GitHub reset counter for your IP.
|
||||
|
||||
## License
|
||||
|
||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||
Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Create an issue to discuss about your idea
|
||||
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
5. Push to the branch (`git push origin my-new-feature`)
|
||||
6. Create a new Pull Request
|
||||
|
||||
**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!**
|
||||
|
||||
*Improvements more than welcome - they are kindly requested! :)*
|
||||
|
||||
227
bump_gemfile.rb
Executable file
227
bump_gemfile.rb
Executable 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
|
||||
@@ -1,9 +1,9 @@
|
||||
Gem::Specification.new do |s|
|
||||
s.name = "github_changelog_generator"
|
||||
s.version = "0.0.1"
|
||||
s.version = "1.1.0"
|
||||
s.default_executable = "github_changelog_generator"
|
||||
|
||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||
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}
|
||||
@@ -14,8 +14,7 @@ Gem::Specification.new do |s|
|
||||
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.6"])
|
||||
s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
|
||||
s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||
|
||||
s.executables = %w(github_changelog_generator)
|
||||
|
||||
@@ -8,7 +8,7 @@ require_relative 'github_changelog_generator/parser'
|
||||
|
||||
class ChangelogGenerator
|
||||
|
||||
attr_accessor :options, :all_tags
|
||||
attr_accessor :options, :all_tags, :github
|
||||
|
||||
def initialize()
|
||||
|
||||
@@ -20,6 +20,7 @@ class ChangelogGenerator
|
||||
end
|
||||
@all_tags = self.get_all_tags
|
||||
@pull_requests = self.get_all_closed_pull_requests
|
||||
@issues = self.get_all_issues
|
||||
|
||||
@tag_times_hash = {}
|
||||
end
|
||||
@@ -35,17 +36,14 @@ class ChangelogGenerator
|
||||
|
||||
|
||||
def get_all_closed_pull_requests
|
||||
|
||||
|
||||
issues = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
json = issues.body
|
||||
request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
pull_requests = request.body
|
||||
|
||||
if @options[:verbose]
|
||||
puts 'Receive all pull requests'
|
||||
end
|
||||
|
||||
json
|
||||
|
||||
pull_requests
|
||||
end
|
||||
|
||||
def compund_changelog
|
||||
@@ -62,7 +60,7 @@ class ChangelogGenerator
|
||||
tag1 = @options[:tag1]
|
||||
tag2 = @options[:tag2]
|
||||
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?(tag2)
|
||||
@@ -87,7 +85,9 @@ class ChangelogGenerator
|
||||
puts log
|
||||
end
|
||||
|
||||
output_filename = "#{@options[:project]}_changelog.md"
|
||||
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}"
|
||||
@@ -100,6 +100,8 @@ class ChangelogGenerator
|
||||
log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
|
||||
end
|
||||
|
||||
log += self.generate_log_before_tag(self.all_tags.last)
|
||||
|
||||
log
|
||||
end
|
||||
|
||||
@@ -107,19 +109,6 @@ class ChangelogGenerator
|
||||
@github.pull_requests.merged? @options[:user], @options[:project], number
|
||||
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
|
||||
|
||||
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
|
||||
@@ -128,9 +117,14 @@ class ChangelogGenerator
|
||||
puts "Receive tags for repo #{url}"
|
||||
end
|
||||
|
||||
response = HTTParty.get(url,
|
||||
:headers => {'Authorization' => 'token 8587bb22f6bf125454768a4a19dbcc774ea68d48',
|
||||
'User-Agent' => 'Changelog-Generator'})
|
||||
if @options[:token]
|
||||
response = HTTParty.get(url,
|
||||
:headers => {'Authorization' => "token #{@options[:token]}",
|
||||
'User-Agent' => 'Changelog-Generator'})
|
||||
else
|
||||
response = HTTParty.get(url,
|
||||
:headers => {'User-Agent' => 'Changelog-Generator'})
|
||||
end
|
||||
|
||||
json_parse = JSON.parse(response.body)
|
||||
|
||||
@@ -156,29 +150,121 @@ class ChangelogGenerator
|
||||
pull_requests = Array.new(@pull_requests)
|
||||
|
||||
pull_requests.delete_if { |req|
|
||||
t = Time.parse(req[:closed_at]).utc
|
||||
true_classor_false_class = t > since_tag_time
|
||||
classor_false_class = t < till_tag_time
|
||||
if req[:merged_at]
|
||||
t = Time.parse(req[:merged_at]).utc
|
||||
tag_is_later_since = t > since_tag_time
|
||||
tag_is_before_till = t <= till_tag_time
|
||||
|
||||
in_range = (tag_is_later_since) && (tag_is_before_till)
|
||||
!in_range
|
||||
else
|
||||
true
|
||||
end
|
||||
|
||||
in_range = (true_classor_false_class) && (classor_false_class)
|
||||
!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
|
||||
|
||||
def create_log(pull_requests, tag_name, tag_time)
|
||||
def generate_log_before_tag(tag)
|
||||
tag_time = self.get_time_of_tag(tag)
|
||||
tag_name = tag['name']
|
||||
|
||||
pull_requests = Array.new(@pull_requests)
|
||||
|
||||
pull_requests.delete_if { |req|
|
||||
if req[:merged_at]
|
||||
t = Time.parse(req[:merged_at]).utc
|
||||
t > tag_time
|
||||
else
|
||||
true
|
||||
end
|
||||
|
||||
}
|
||||
|
||||
issues = Array.new(@issues)
|
||||
|
||||
issues.delete_if { |issue|
|
||||
if issue[:closed_at]
|
||||
t = Time.parse(issue[:closed_at]).utc
|
||||
t > tag_time
|
||||
else
|
||||
true
|
||||
end
|
||||
}
|
||||
|
||||
self.create_log(pull_requests, issues, tag_name, tag_time)
|
||||
|
||||
end
|
||||
|
||||
def create_log(pull_requests, issues, tag_name, tag_time)
|
||||
|
||||
# Generate tag name and link
|
||||
trimmed_tag = tag_name.tr('v', '')
|
||||
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
||||
|
||||
#Generate date string:
|
||||
time_string = tag_time.strftime @options[:format]
|
||||
log += "#### #{time_string}\n"
|
||||
|
||||
pull_requests.each { |dict|
|
||||
merge = "#{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/pull/#{dict[:number]})\n\n"
|
||||
log += "- #{merge}"
|
||||
}
|
||||
if @options[:pulls]
|
||||
# Generate pull requests:
|
||||
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
|
||||
end
|
||||
|
||||
@@ -198,8 +284,23 @@ class ChangelogGenerator
|
||||
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
||||
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
|
||||
|
||||
if __FILE__ == $0
|
||||
ChangelogGenerator.new.compund_changelog
|
||||
changelog_generator = ChangelogGenerator.new
|
||||
changelog_generator.compund_changelog
|
||||
end
|
||||
@@ -3,17 +3,17 @@ require 'optparse'
|
||||
|
||||
class Parser
|
||||
def self.parse_options
|
||||
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y'}
|
||||
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|
|
||||
opts.banner = 'Usage: changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]'
|
||||
opts.on('-u', '--user [USER]', 'your username on GitHub') do |last|
|
||||
opts.banner = 'Usage: changelog_generator [options]'
|
||||
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
||||
options[:user] = last
|
||||
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
|
||||
end
|
||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this app 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|
|
||||
options[:token] = last
|
||||
end
|
||||
opts.on('-h', '--help', 'Displays Help') do
|
||||
@@ -23,12 +23,24 @@ class Parser
|
||||
opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
|
||||
options[:verbose] = v
|
||||
end
|
||||
opts.on('-l', '--last-changes', 'generate log between 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
|
||||
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
|
||||
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!
|
||||
@@ -39,6 +51,17 @@ class Parser
|
||||
exit
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user