Compare commits

...

49 Commits
1.0.1 ... 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
Petr Korolev
7b44c4aa78 Update to version 1.1.2 2014-11-12 11:06:21 +02:00
Petr Korolev
95bdd60c34 Merge branch 'new-features' 2014-11-12 11:06:01 +02:00
Petr Korolev
1357b3980d Fix bug with auto-detect project name, when there is dot signs in project name
add fix for username also
2014-11-12 11:05:03 +02:00
Petr Korolev
b30587ce14 update 2014-11-11 18:07:52 +02:00
Petr Korolev
18e0f937ea typo in readme 2014-11-11 11:07:59 +02:00
Petr Korolev
1af8e18f9f update 2014-11-11 11:00:34 +02:00
Petr Korolev
a458a1e378 update readme 2014-11-11 10:58:56 +02:00
Petr Korolev
bc3af7fa93 update changelog 2014-11-10 17:06:40 +02:00
Petr Korolev
6682ffe452 Update to version 1.1.1 2014-11-10 17:04:02 +02:00
Petr Korolev
dbc7b3e567 update changelog 2014-11-10 17:02:01 +02:00
Petr Korolev
a96f74208c Merge branch 'new-features' 2014-11-10 17:01:57 +02:00
Petr Korolev
cdc009b4ad Remove duplicates of issues and pull-requests with same number 2014-11-10 17:00:48 +02:00
Petr Korolev
0046f344a9 Merge branch 'new-features' 2014-11-10 16:18:39 +02:00
Petr Korolev
1b792bc67b update changelog 2014-11-10 16:17:56 +02:00
Petr Korolev
f0716771b5 Sort issues by tags 2014-11-10 16:17:43 +02:00
Petr Korolev
50dd7b2ed6 update changelog 2014-11-10 16:03:01 +02:00
Petr Korolev
3797b3ac31 Merge branch 'new-features' 2014-11-10 15:38:48 +02:00
Petr Korolev
f08685b015 Add ability to add ot exclude issues wothout any labels 2014-11-10 15:37:43 +02:00
Petr Korolev
fc96007741 update changelog 2014-11-10 15:12:42 +02:00
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
2db69dd27c small fix 2014-11-07 18:37:10 +02:00
11 changed files with 518 additions and 360 deletions

1
.gitignore vendored
View File

@@ -0,0 +1 @@
/lib/CHANGELOG.md

View File

@@ -1,22 +1,56 @@
# 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)
#### 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:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
#### 10/11/14
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
- *Fixed bug:* Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
- *Fixed bug:* Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
#### 10/11/14
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8)
## [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
- 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)
- 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)
- *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) - *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
- *Implemented enhancement:* Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
## [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
- 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)
- 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)
## [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
@@ -24,4 +58,4 @@
#### 06/11/14 #### 06/11/14
**This file was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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

@@ -11,48 +11,65 @@ This script automatically generate change-log from your tags and merged pull-req
[sudo] gem install github_changelog_generator [sudo] gem install github_changelog_generator
## Usage ## Usage
**It's really simple**:
github_changelog_generator -u github-username -p github-project - `cd` to your Project folder with configured git and just type:
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory. github_changelog_generator
### Params: - from anywhere:
See `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator --user username --project project_name [options] github_changelog_generator -u github-username -p github-project
-u, --user [USER] Username of the owner of target GitHub repo (required)
-p, --project [PROJECT] Name of project on GitHub (required) As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
-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 ## Params:
-v, --[no-]verbose Run verbosely Type `github_changelog_generator --help` for detailed usage.
--[no-]issues Include closed issues to changelog. Default is true
--[no-]pull-requests Include pull-requests to changelog. Default is true Usage: changelog_generator [options]
-l, --last-changes Generate log between last 2 tags only -u, --user [USER] Username of the owner of target GitHub repo
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y -p, --project [PROJECT] Name of project on GitHub
-o, --output [NAME] Output file. Default is CHANGELOG.md -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
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'a -h, --help Displays Help
-v, --[no-]verbose Run verbosely. 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-]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'
## 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) - 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:
Was generated by command: github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
## 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': 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) >! /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 generate this token or wait for 1 hour before GitHub reset counter for your IP. It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## License ## Am I missed some essential feature?
Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT). **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!*
## Contributing ## Contributing
@@ -63,6 +80,6 @@ Github the Generator is released under the [MIT License](http://www.opensource.o
5. Push to the branch (`git push origin my-new-feature`) 5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request 6. Create a new Pull Request
**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!** ## License
*Improvements more than welcome - they are kindly requested! :)* Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

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

@@ -179,7 +179,7 @@ def run_bumping_script
bumped_version = bump_version(versions_array) bumped_version = bump_version(versions_array)
unless @options[:dry_run] unless @options[:dry_run]
puts 'Are you sure? Click Y to continue:' puts 'Are you sure? Press Y to continue:'
str = gets.chomp str = gets.chomp
if str != 'Y' if str != 'Y'
puts '-> exit' puts '-> exit'
@@ -196,7 +196,6 @@ def run_bumping_script
execute_line_if_not_dry_run("gem build #{spec_file}") execute_line_if_not_dry_run("gem build #{spec_file}")
gem = find_current_gem_file gem = find_current_gem_file
execute_line_if_not_dry_run("gem push #{gem}") execute_line_if_not_dry_run("gem push #{gem}")
# execute_line_if_not_dry_run("pod trunk push #{spec_file}") # execute_line_if_not_dry_run("pod trunk push #{spec_file}")
@@ -206,7 +205,7 @@ def revert_last_bump
spec_file = find_spec_file spec_file = find_spec_file
result, _ = find_version_in_podspec(spec_file) result, _ = find_version_in_podspec(spec_file)
puts "DELETE tag #{result} and HARD reset HEAD~1?\nClick Y to continue:" puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
str = gets.chomp str = gets.chomp
if str != 'Y' if str != 'Y'
puts '-> exit' puts '-> exit'

View File

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

View File

@@ -2,300 +2,376 @@
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 github_token
if @options[:token]
@github = Github.new oauth_token: @options[:token]
else
@github = Github.new
end
@all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests
@issues = self.get_all_issues
@tag_times_hash = {} if @github_token.nil?
end @github = Github.new
else
@github = Github.new oauth_token: @github_token
end
def print_json(json) @all_tags = self.get_all_tags
puts JSON.pretty_generate(json) @pull_requests = self.get_all_closed_pull_requests
end @issues = self.get_all_issues
def exec_command(cmd) @tag_times_hash = {}
exec_cmd = "cd #{$project_path} && #{cmd}"
%x[#{exec_cmd}]
end
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} && #{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] response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
tags_strings = []
self.all_tags.each { |x| tags_strings.push(x['name'])}
if tags_strings.include?(tag1) pull_requests = []
if tags_strings.include?(tag2) response.each_page do |page|
hash = Hash[tags_strings.map.with_index.to_a] pull_requests.concat(page)
index1 = hash[tag1] end
index2 = hash[tag2]
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2]) if @options[:verbose]
puts "Receive all pull requests: #{pull_requests.count}"
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] && @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
else
log += self.generate_log_for_all_tags
end
if @options[:verbose]
puts log
end
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
def generate_log_for_all_tags
log = ''
for index in 1 ... self.all_tags.size
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
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
response = HTTParty.get(url,
:headers => {'Authorization' => "token #{@options[:token]}",
'User-Agent' => 'Changelog-Generator'})
json_parse = JSON.parse(response.body)
if @options[:verbose]
puts "Found #{json_parse.count} tags"
end
json_parse
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)
# 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
till_tag_name = till_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
in_range = (tag_is_later_since) && (tag_is_before_till)
!in_range
else
true
end end
} log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
issues = Array.new(@issues) output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
issues.delete_if{ |issue| puts "Done! Generated log placed in #{output_filename}"
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 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"
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 end
if @options[:issues] def generate_log_for_all_tags
# Generate issues: log = ''
if issues @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], self.all_tags[index-1])
end
log += self.generate_log_before_tag(self.all_tags.last)
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
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
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 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
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_older_of_older = t > older_tag_time
tag_is_newer_than_new = t <= newer_tag_time
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
!tag_not_in_range
else
true
end
}
issues = Array.new(@issues)
issues.delete_if { |issue|
if issue[:closed_at]
t = Time.parse(issue[:closed_at]).utc
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
else
true
end
}
self.create_log(pull_requests, issues, newer_tag_name, newer_tag_time)
end
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"
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}"
}
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| issues.each { |dict|
is_bug = false is_bug = false
is_enhancement = false is_enhancement = false
dict.labels.each { |label| dict.labels.each { |label|
if label.name == 'bug' if label.name == 'bug'
is_bug = true is_bug = true
end end
if label.name == 'enhancement' if label.name == 'enhancement'
is_enhancement = true is_enhancement = true
end end
} }
intro = 'Closed issue' intro = 'Closed issue'
if is_bug if is_bug
intro = 'Fixed bug' intro = 'Fixed bug'
end end
if is_enhancement if is_enhancement
intro = 'Implemented enhancement' intro = 'Implemented enhancement'
end end
merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/issues/#{dict[:number]})\n\n" merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
log += "- #{merge}" log += "- #{merge}"
} }
end end
log
end end
log def get_time_of_tag(prev_tag)
end
def get_time_of_tag(prev_tag) if @tag_times_hash[prev_tag['name']]
return @tag_times_hash[prev_tag['name']]
end
if @tag_times_hash[prev_tag['name']] if @options[:verbose]
return @tag_times_hash[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']
time_string = github_git_data_commits_get['committer']['date']
Time.parse(time_string)
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
end end
if @options[:verbose] def get_all_issues
puts "Get time for tag #{prev_tag['name']}" 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 "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
end 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 = []
@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
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
end
if __FILE__ == $0
changelog_generator = ChangelogGenerator.new
changelog_generator.compund_changelog
end end

View File

@@ -1,67 +1,88 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
require 'optparse' require 'optparse'
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 } 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:* '}
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 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
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('-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
opts.on('-v', '--version', 'Print version number') do |v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
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') 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-]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]
puts parser.banner
exit
end
if ARGV[1]
options[:tag1] = ARGV[0]
options[:tag2] = ARGV[1]
end
options
end end
end end

View File

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