Compare commits

..

68 Commits
1.2.0 ... 1.2.3

Author SHA1 Message Date
Petr Korolev
fcc1c608a2 Merge branch 'release/1.2.3' 2014-12-16 17:25:12 +02:00
Petr Korolev
46ae40f250 Update gemspec to version 1.2.3 2014-12-16 17:25:11 +02:00
Petr Korolev
00f98b8ca6 fix #30 2014-12-15 17:02:38 +02:00
Petr Korolev
5da838efee Merge branch 'feature/rails-crash' into develop 2014-12-15 17:02:11 +02:00
Petr Korolev
73b789ab82 fix 2014-12-15 16:23:30 +02:00
Petr Korolev
b5778b14a0 Revert "add rubymine files to gitignore"
This reverts commit 4488ac8cc6.
2014-12-15 15:55:48 +02:00
Petr Korolev
e29ff3c3a9 fix crash when user in NULL 2014-12-15 15:54:11 +02:00
Petr Korolev
9646b49add Merge branch 'feature/verboose-addition' into develop 2014-12-15 15:53:36 +02:00
Petr Korolev
a44b0bdd25 fix pagination issue + verboose. back to 30 per-pages 2014-12-15 15:53:02 +02:00
Petr Korolev
433d46d85b fx 2014-12-15 15:34:20 +02:00
Petr Korolev
950e8916d9 Merge branch 'feature/increase-per-page' into develop 2014-12-15 15:33:28 +02:00
Petr Korolev
87c6e33335 add verboose for issues 2014-12-15 15:24:46 +02:00
Petr Korolev
4488ac8cc6 add rubymine files to gitignore 2014-12-15 15:22:30 +02:00
Petr Korolev
c697c6be4a Increase per-page number of request + improve verbose mode (related with #33) 2014-12-15 15:19:56 +02:00
Petr Korolev
69dd5eadc2 implement async fetching tags 2014-12-15 14:15:39 +02:00
Petr Korolev
4ea1058cd5 fix #33 2014-12-12 16:55:26 +02:00
Petr Korolev
fcd78e6bc4 add parsing feature, fix #38 2014-12-11 18:11:08 +02:00
Petr Korolev
e6c0d49200 Merge branch 'master' into develop 2014-12-11 17:15:31 +02:00
Petr Korolev
0f5db97474 Update changelog for version 1.2.2 2014-12-10 14:08:59 +02:00
Petr Korolev
0901b38577 Update gemspec to version 1.2.2 2014-12-10 14:08:59 +02:00
Petr Korolev
2a24f49a83 improve script 2014-12-10 14:08:59 +02:00
Petr Korolev
2ad014d5c7 fix trimming for issues 2014-12-10 14:08:59 +02:00
Petr Korolev
188ba7e073 create class and implement encapsulation. This fix #34 2014-12-10 14:08:59 +02:00
Petr Korolev
6f53fe0a1d optimize script 2014-12-10 14:08:59 +02:00
Petr Korolev
2c7853cf9f Merge branch 'hotfix/update-changelog' into develop 2014-12-10 12:19:32 +02:00
Petr Korolev
6830ea49f2 Update changelog for version 1.2.2 2014-12-10 12:19:31 +02:00
Petr Korolev
5be1a2afaf Merge branch 'release/1.2.2' into develop 2014-12-10 12:18:58 +02:00
Petr Korolev
7be5021685 Merge branch 'release/1.2.2' 2014-12-10 12:18:58 +02:00
Petr Korolev
c3373b2343 Update gemspec to version 1.2.2 2014-12-10 12:18:56 +02:00
Petr Korolev
9aa156a02b improve script 2014-12-10 12:18:45 +02:00
Petr Korolev
68a8d8d2c8 fix trimming for issues 2014-12-10 12:18:45 +02:00
Petr Korolev
057fb488d5 create class and implement encapsulation. This fix #34 2014-12-10 12:18:45 +02:00
Petr Korolev
f1d9c839c7 optimize script 2014-12-10 12:18:44 +02:00
Petr Korolev
97d048d62f Merge branch 'develop' 2014-12-03 11:52:17 +02:00
Petr Korolev
7972ec0977 update yml 2014-12-03 11:51:59 +02:00
Petr Korolev
f55598825d Merge branch 'master' into develop 2014-12-03 11:43:00 +02:00
Petr Korolev
a678b52fe4 fc 2014-12-03 11:42:52 +02:00
Petr Korolev
aac04726ba Merge branch 'develop' 2014-12-03 11:42:02 +02:00
Petr Korolev
0c65035cde update readme 2014-12-03 11:40:54 +02:00
Petr Korolev
e038c7e680 Merge branch 'travis-update' into develop 2014-12-03 11:37:39 +02:00
Petr Korolev
bcecb4eb81 Revert "remove dep rake"
This reverts commit 326a067ac5.
2014-12-03 11:31:51 +02:00
Petr Korolev
52123885a1 add rakefile 2014-12-03 11:30:26 +02:00
Petr Korolev
326a067ac5 remove dep rake 2014-12-03 11:27:05 +02:00
Petr Korolev
5dcbef87d1 put back gem updates 2014-12-03 11:19:31 +02:00
Petr Korolev
caf264360b remove before install 2014-12-03 11:18:13 +02:00
Petr Korolev
bc13632545 add rake to gemfile 2014-12-03 11:09:11 +02:00
Petr Korolev
67b438f46b update gem 2014-12-02 18:09:18 +02:00
Petr Korolev
ff52291d2a Merge branch 'master' into travis-update
Conflicts:
	Gemfile
2014-12-02 18:03:55 +02:00
Petr Korolev
b2df1cfdcd Merge pull request #36 from bitdeli-chef/master
Add a Bitdeli Badge to README
2014-12-01 18:39:34 +02:00
Bitdeli Chef
f037a839ce Add a Bitdeli badge to README 2014-12-01 16:48:39 +00:00
Petr Korolev
5295389fcc update 2014-11-24 21:38:06 +02:00
Petr Korolev
8e5b4ed191 update 2014-11-24 21:37:10 +02:00
Petr Korolev
80cc3fc625 update parser 2014-11-24 21:33:03 +02:00
Petr Korolev
f087699d07 update readme 2014-11-24 21:20:46 +02:00
Petr Korolev
540df2ef51 UPdate changelog 2014-11-22 23:30:24 +02:00
Petr Korolev
54d029d8ea update readme 2014-11-22 23:18:17 +02:00
Petr Korolev
bec4fdef0e Update gemspec to version 1.2.1 2014-11-22 22:56:23 +02:00
Petr Korolev
b5d5615244 update readme 2014-11-21 10:59:12 +02:00
Petr Korolev
766569c27a update README 2014-11-19 22:16:41 +02:00
Petr Korolev
51e3c2ee54 Merge branch 'new-features' 2014-11-19 17:29:07 +02:00
Petr Korolev
e1e5de555b Issues for last tag not in list 2014-11-19 17:28:49 +02:00
Petr Korolev
0e4474bb2d Merge branch 'new-features' 2014-11-19 17:26:23 +02:00
Petr Korolev
fa4ccb7e9c gix bug in logic 2014-11-19 16:23:54 +02:00
Petr Korolev
36fbe509fa Merge branch 'new-features' 2014-11-19 15:59:39 +02:00
Petr Korolev
4c5ca562cf Disable default --filter-pull-requests option. 2014-11-19 15:58:14 +02:00
Petr Korolev
27432c3328 Merge branch 'new-features' 2014-11-19 15:49:42 +02:00
Petr Korolev
4a27872695 Update changelog for version 1.2.0 2014-11-19 15:49:22 +02:00
Petr Korolev
a5c4899360 add travis configs 2014-11-12 11:03:46 +02:00
10 changed files with 227 additions and 107 deletions

15
.travis.yml Normal file
View File

@@ -0,0 +1,15 @@
language: ruby
before_install:
- gem update --system
- gem --version
rvm:
- 2.1.0
gemfile:
- Gemfile
notifications:
email:
recipients:
- sky4winder+githubchangeloggenerator@gmail.com
on_success: never # [always|never|change]
on_failure: change # [always|never|change]

View File

@@ -1,26 +1,46 @@
# Changelog
## [1.2.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
#### 10/12/14
- *Merged pull-request:* Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
## [1.2.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
#### 22/11/14
- *Merged pull-request:* Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
## [1.2.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
#### 19/11/14
- *Merged pull-request:* Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Test Pull-Request SHOULD NOT APPEAR IN LOG! [\#26](https://github.com/skywinder/Github-Changelog-Generator/pull/26) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
## [1.1.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4)
#### 18/11/14
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23)
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Implement ability to retrieve GitHub token from ENV variable (to not put it to script directly) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
- *Implemented enhancement:* Implement ability to retrieve GitHub token from ENV 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 project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17)
- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
## [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:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
#### 10/11/14
@@ -32,13 +52,13 @@
## [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)
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
#### 07/11/14
- *Merged pull-request:* 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) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* 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) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
@@ -48,9 +68,9 @@
## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
#### 07/11/14
- *Merged pull-request:* 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) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* 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) ([skywinder](https://github.com/skywinder))
## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
#### 06/11/14

View File

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

View File

@@ -2,7 +2,7 @@ GEM
remote: https://rubygems.org/
specs:
addressable (2.3.6)
colorize (0.7.3)
colorize (0.7.4)
descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1)
faraday (0.9.0)
@@ -15,13 +15,13 @@ GEM
multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.3)
oauth2
hashie (3.3.1)
jwt (1.0.0)
hashie (3.3.2)
jwt (1.2.0)
mini_portile (0.6.1)
multi_json (1.10.1)
multi_xml (0.5.5)
multipart-post (2.0.0)
nokogiri (1.6.4)
nokogiri (1.6.5)
mini_portile (~> 0.6.0)
oauth2 (1.0.0)
faraday (>= 0.8, < 0.10)
@@ -30,6 +30,7 @@ GEM
multi_xml (~> 0.5)
rack (~> 1.2)
rack (1.5.2)
rake (10.4.2)
thread_safe (0.3.4)
PLATFORMS
@@ -38,3 +39,4 @@ PLATFORMS
DEPENDENCIES
colorize
github_api
rake

View File

@@ -2,28 +2,31 @@ GitHub Changelog Generator
==================
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)
Changelog generation has never been so easy.
This script automatically generate change-log from your tags and merged pull-requests.
## Installation:
You're almost done!
[sudo] gem install github_changelog_generator
## Usage
**It's really simple**:
- `cd` to your Project folder with configured git and just type:
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder just run:
github_changelog_generator
- from anywhere:
- or from anywhere:
github_changelog_generator -u github-username -p github-project
As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
## Params:
### Params:
Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator [options]
@@ -42,22 +45,16 @@ Type `github_changelog_generator --help` for detailed usage.
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
-v, --version Print version number
## Examples:
- 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:
### GitHub token
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 script with token
**You can easily [generate it here](https://github.com/settings/applications)**.
And:
- Run with key `-t [your-16-digit-token]` that
- Run with key `-t [your-16-digit-token]`
- 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"'`
@@ -67,6 +64,19 @@ So, if you got error like this:
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## Examples:
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
- [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
## Projects using this library
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
## Am I missed some essential feature?
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
@@ -85,3 +95,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

9
Rakefile Normal file
View File

@@ -0,0 +1,9 @@
require "rake/testtask"
task :default => [:test]
Rake::TestTask.new do |t|
t.verbose = true
t.libs.push("demo", "test")
t.pattern = "test/**/*_test.rb"
end

View File

@@ -3,7 +3,10 @@
require 'github_api'
require 'json'
require 'colorize'
require 'benchmark'
require_relative 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/generator'
require_relative 'github_changelog_generator/version'
module GitHubChangelogGenerator
@@ -11,18 +14,29 @@ module GitHubChangelogGenerator
attr_accessor :options, :all_tags, :github
PER_PAGE_NUMBER = 30
def initialize
@options = Parser.parse_options
if options[:verbose]
puts 'Input options:'
pp options
puts ''
end
github_token
if @github_token.nil?
@github = Github.new
@github = Github.new per_page: PER_PAGE_NUMBER
else
@github = Github.new oauth_token: @github_token
@github = Github.new oauth_token: @github_token,
per_page: PER_PAGE_NUMBER
end
@generator = Generator.new(@options)
@all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests
if @options[:issues]
@@ -39,7 +53,7 @@ module GitHubChangelogGenerator
end
def exec_command(cmd)
exec_cmd = "cd #{$project_path} && #{cmd}"
exec_cmd = "cd #{$project_path} and #{cmd}"
%x[#{exec_cmd}]
end
@@ -47,18 +61,23 @@ module GitHubChangelogGenerator
def get_all_closed_pull_requests
if @options[:verbose]
puts 'Fetching pull requests..'
print "Fetching pull requests...\r"
end
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
pull_requests = []
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching pull requests... #{page_i}\r"
pull_requests.concat(page)
end
print "\r"
if @options[:verbose]
puts "Received all closed pull requests: #{pull_requests.count}"
puts "Received closed pull requests: #{pull_requests.count}"
end
unless @options[:pull_request_labels].nil?
@@ -91,6 +110,7 @@ module GitHubChangelogGenerator
end
return filtered_pull_requests
end
pull_requests
end
@@ -103,8 +123,7 @@ module GitHubChangelogGenerator
if @options[:last]
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
elsif @options[:tag1] && @options[:tag2]
elsif @options[:tag1] and @options[:tag2]
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
@@ -133,14 +152,19 @@ module GitHubChangelogGenerator
output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
puts "Done! Generated log placed in #{output_filename}"
puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"
end
def generate_log_for_all_tags
log = ''
@all_tags.each { |tag| self.get_time_of_tag(tag) }
# Async fetching tags:
threads = []
@all_tags.each { |tag|
threads << Thread.new { self.get_time_of_tag(tag) }
}
threads.each { |thr| thr.join }
if @options[:verbose]
puts "Sorting tags.."
@@ -152,11 +176,11 @@ module GitHubChangelogGenerator
puts "Generating log.."
end
for index in 1 ... self.all_tags.size
(1 ... self.all_tags.size).each { |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)
log += generate_log_between_tags(nil, self.all_tags.last)
log
end
@@ -168,16 +192,19 @@ module GitHubChangelogGenerator
def get_all_tags
if @options[:verbose]
puts 'Fetching all tags..'
print "Fetching tags...\r"
end
response = @github.repos.tags @options[:user], @options[:project]
tags = []
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching tags... #{page_i}\r"
tags.concat(page)
end
print "\r"
if @options[:verbose]
puts "Found #{tags.count} tags"
end
@@ -209,48 +236,48 @@ module GitHubChangelogGenerator
if older_tag.nil?
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
issues = delete_by_time(@issues, :closed_at, newer_tag_time)
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time)
else
older_tag_time = self.get_time_of_tag(older_tag)
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
end
self.create_log(filtered_pull_requests, issues, newer_tag_name, newer_tag_time)
self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time)
end
def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
array_new = Array.new(array)
array_new.delete_if { |req|
array.select { |req|
if req[hash_key]
t = Time.parse(req[hash_key]).utc
if older_tag_time.nil?
tag_is_older_of_older = false
tag_in_range_old = true
else
tag_is_older_of_older = t > older_tag_time
tag_in_range_old = t > older_tag_time
end
tag_is_newer_than_new = t <= newer_tag_time
tag_in_range_new = t <= newer_tag_time
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
!tag_not_in_range
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range
else
true
false
end
}
end
def generate_log_before_tag(tag)
generate_log_between_tags(nil, tag)
end
# @param [Array] pull_requests
# @param [Array] issues
# @param [String] tag_name
# @param [String] tag_time
# @return [String]
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"
log = "## [#{tag_name}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
#Generate date string:
time_string = tag_time.strftime @options[:format]
@@ -258,20 +285,11 @@ module GitHubChangelogGenerator
if @options[:pulls]
# Generate pull requests:
if pull_requests
if @options[:author]
pull_requests.each { |dict|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url}) ([#{dict.user.login}](#{dict.user.html_url}))\n\n"
pull_requests.each { |pull_request|
merge = @generator.get_string_for_pull_request(pull_request)
log += "- #{merge}"
}
else
pull_requests.each { |dict|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
log += "- #{merge}"
}
end
end
} if pull_requests
end
if @options[:issues]
@@ -314,7 +332,9 @@ module GitHubChangelogGenerator
intro = 'Implemented enhancement'
end
merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
enc_string = @generator.encapsulate_string dict[:title]
merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
log += "- #{merge}"
}
end
@@ -327,10 +347,6 @@ module GitHubChangelogGenerator
return @tag_times_hash[prev_tag['name']]
end
if @options[:verbose]
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)
@@ -340,17 +356,21 @@ module GitHubChangelogGenerator
def get_all_issues
if @options[:verbose]
puts 'Fetching closed issues..'
print "Fetching closed issues...\r"
end
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
issues = []
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching closed issues... #{page_i}\r"
issues.concat(page)
end
print "\r"
# remove pull request from issues:
issues.select! { |x|
x.pull_request == nil
@@ -360,6 +380,11 @@ module GitHubChangelogGenerator
puts "Received closed issues: #{issues.count}"
end
if @options[:verbose]
puts "Filtering issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}"
end
filtered_issues = issues.select { |issue|
#compare is there any labels from @options[:labels] array
(issue.labels.map { |label| label.name } & @options[:labels]).any?
@@ -374,7 +399,7 @@ module GitHubChangelogGenerator
end
if @options[:verbose]
puts "Filter issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count} issues"
puts "Filtered issues: #{filtered_issues.count}"
end
filtered_issues

View File

@@ -0,0 +1,38 @@
module GitHubChangelogGenerator
class Generator
def initialize(options = nil)
@options = options
end
def get_string_for_pull_request(pull_request)
encapsulated_title = self.encapsulate_string pull_request[:title]
merge = "#{@options[:merge_prefix]}#{encapsulated_title} [\\##{pull_request[:number]}](#{pull_request.html_url})"
if @options[:author]
if !pull_request.user.nil?
merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
else
merge += " ({Null user})\n\n"
end
else
merge += "\n\n"
end
merge
end
def encapsulate_string(string)
string.gsub! '\\', '\\\\'
encpas_chars = %w(> * _ \( \) [ ])
encpas_chars.each{ |char|
string.gsub! char, "\\#{char}"
}
string
end
end
end

View File

@@ -6,7 +6,7 @@ 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:* ', :author => true, :pull_request_labels => %w(bug enhancement)}
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:* ', :author => true, :pull_request_labels => nil}
parser = OptionParser.new { |opts|
opts.banner = 'Usage: changelog_generator [options]'
@@ -16,12 +16,14 @@ module GitHubChangelogGenerator
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 here: https://github.com/settings/tokens/new') do |last|
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
options[:token] = last
end
opts.on('-h', '--help', 'Displays Help') do
puts opts
exit
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('--[no-]verbose', 'Run verbosely. Default is true') do |v|
options[:verbose] = v
@@ -35,47 +37,42 @@ module GitHubChangelogGenerator
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('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
options[:last] = author
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, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
options[:labels] = list
end
opts.on('--filter-pull-requests x,y,z', Array, 'Pull requests with that labels will be included to changelog. pull requests w\o labels will be included anyway. Default is \'bug,enhancement\'') do |list|
opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
options[:pull_request_labels] = list
end
opts.on('-v', '--version', 'Print version number') do |v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit
end
opts.on('-h', '--help', 'Displays Help') do
puts opts
exit
end
}
parser.parse!
if options[:verbose]
puts 'Input options:'
pp options
puts ''
end
#udefined case with 1 parameter:
if ARGV[0] && !ARGV[1]
puts parser.banner
# this match should parse https://github.com/skywinder/Github-Changelog-Generator and skywinder/Github-Changelog-Generator to user and name
match = /(?:.+github\.com\/)?(.+)\/(.+)/.match(ARGV[0])
if match[2].nil?
exit
else
options[:user] = match[1]
options[:project]= match[2]
end
end
if !options[:user] && !options[:project]
remote = `git remote -vv`.split("\n")
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git)?.*/.match(remote[0])
if match && match[1] && match[2]
puts "Detected user:#{match[1]}, project:#{match[2]}"
@@ -92,7 +89,6 @@ module GitHubChangelogGenerator
if ARGV[1]
options[:tag1] = ARGV[0]
options[:tag2] = ARGV[1]
end
options

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator
VERSION = '1.2.0'
VERSION = '1.2.3'
end