Compare commits

...

117 Commits

Author SHA1 Message Date
Petr Korolev
bf88bc0a0e Update gemspec to version 1.2.0 2014-11-19 15:48:32 +02:00
Petr Korolev
3b145bd7ed Merge branch 'filter-pull-requests' 2014-11-19 15:47:28 +02:00
Petr Korolev
97311bc5a0 add parse option --filter-pull-requests 2014-11-19 15:45:24 +02:00
Petr Korolev
bdc4657e2c add filter option 2014-11-19 15:04:10 +02:00
Petr Korolev
0c8a96aef8 update readme 2014-11-19 14:33:38 +02:00
Petr Korolev
c9462a6c9b Merge branch 'new-features' 2014-11-19 14:30:59 +02:00
Petr Korolev
0a43c25f8f Code refactoring 2014-11-19 14:30:18 +02:00
Petr Korolev
c58ec0dcbb Merge branch 'new-features' 2014-11-19 13:55:13 +02:00
Petr Korolev
7aa9b6ca47 Add ability to insert authors of pull-requests (--[no-]author option) 2014-11-19 13:53:36 +02:00
Petr Korolev
865a364dff pretty print for input options 2014-11-19 12:51:23 +02:00
Petr Korolev
062f3fd3f2 code cleanup 2014-11-19 12:43:55 +02:00
Petr Korolev
a4e9390283 Merge branch 'new-features' 2014-11-19 12:43:43 +02:00
Petr Korolev
09f5ac5d37 Don't receive issues in case of --no-isses flag specied 2014-11-19 12:42:23 +02:00
Petr Korolev
aed5c37559 Update changelog for version 1.1.4 2014-11-18 15:50:21 +02:00
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
459b0ec7ec Update to version 1.0.1 2014-11-10 13:36:15 +02:00
Petr Korolev
ea1c5c1f6d gem checks 2014-11-10 13:35:20 +02:00
Petr Korolev
86512d3606 impement revert option 2014-11-10 13:27:14 +02:00
Petr Korolev
b908b07e0a implement bump file 2014-11-10 13:11:35 +02:00
Petr Korolev
737774a164 implement find spec logic 2014-11-10 10:08:32 +02:00
Petr Korolev
62d9b7f4a6 rename 2014-11-10 09:21:02 +02:00
Petr Korolev
e75e358ef8 add bump script 2014-11-10 09:10:39 +02:00
Petr Korolev
3ac83e9ea7 Merge branch 'new-features' 2014-11-10 09:02:35 +02:00
Petr Korolev
70d3f63e89 fix for # 10 2014-11-10 09:02:11 +02:00
Petr Korolev
2db69dd27c small fix 2014-11-07 18:37:10 +02:00
Petr Korolev
5a7589f8ca update changelog 2014-11-07 18:35:59 +02:00
Petr Korolev
1adcd9918c update readme 2014-11-07 18:32:28 +02:00
Petr Korolev
afea098355 Bump major verion 2014-11-07 18:29:42 +02:00
Petr Korolev
d3c3b7850f Merge branch 'new-features' 2014-11-07 18:28:29 +02:00
Petr Korolev
502ae431b7 fix typo! 2014-11-07 18:24:02 +02:00
Petr Korolev
5882762800 tst cm 2014-11-07 18:14:56 +02:00
Petr Korolev
606fab4289 update Text for issues. (depends of what label placed) 2014-11-07 18:14:26 +02:00
Petr Korolev
3d25d1135f Merge branch 'new-features' 2014-11-07 18:00:08 +02:00
Petr Korolev
acd2daada3 Remove delimeter and fix parser. This final commit should close #6 enchantment! Yay! 2014-11-07 17:57:32 +02:00
Petr Korolev
381ffeb261 add support for issues 2014-11-07 17:47:42 +02:00
Petr Korolev
f9e6a076bc implement "issues" parsing + check for merged requests 2014-11-07 17:05:01 +02:00
Petr Korolev
8457b764bf update readme and bump gem 2014-11-07 13:52:23 +02:00
Petr Korolev
4237b751a0 clean gitignore file 2014-11-07 13:21:54 +02:00
Petr Korolev
3a78f97d61 add changelog file 2014-11-07 13:20:19 +02:00
Petr Korolev
24c5f66c65 Merge branch 'new-features' 2014-11-07 13:14:48 +02:00
Petr Korolev
9c4b68f779 Fix parsing bug 2014-11-07 12:53:24 +02:00
Petr Korolev
65e978f4a8 update readme 2014-11-07 12:00:01 +02:00
Petr Korolev
6b4333f98a Merge branch 'new-features' 2014-11-07 11:45:40 +02:00
Petr Korolev
675601880d Add changelog generation for last tag 2014-11-07 11:45:01 +02:00
Petr Korolev
e2aac3cb2c Merge branch 'new-features' 2014-11-07 11:29:36 +02:00
Petr Korolev
20095c571d add option for output file, update readme 2014-11-07 11:25:09 +02:00
Petr Korolev
db1c125e7e update gem 2014-11-06 20:05:36 +02:00
Petr Korolev
a335594bcc caps name 2014-11-06 20:03:12 +02:00
Petr Korolev
5e64e5a226 add copyright to the end 2014-11-06 20:01:19 +02:00
Petr Korolev
0a69f76191 update readme 2014-11-06 19:48:59 +02:00
Petr Korolev
959d406ef0 update readme 2014-11-06 19:47:15 +02:00
Petr Korolev
cf4386a3a3 update readme 2014-11-06 19:45:56 +02:00
Petr Korolev
daf391dd1a add contributing chapter to readme 2014-11-06 19:33:44 +02:00
Petr Korolev
26d4717b7d add gem badge 2014-11-06 19:30:51 +02:00
Petr Korolev
e331525e21 readme fix 2014-11-06 19:26:11 +02:00
Petr Korolev
b32969e72c fix 2014-11-06 19:25:15 +02:00
Petr Korolev
b8d13a6331 Update readme 2014-11-06 19:14:35 +02:00
Petr Korolev
66bebc1398 make it executable + man fix 2014-11-06 18:59:06 +02:00
Petr Korolev
e26bb09e24 add exec 2014-11-06 17:07:13 +02:00
Petr Korolev
5c233863b8 fix warrnings 2014-11-06 16:57:51 +02:00
Petr Korolev
598c92a448 remove rakefile 2014-11-06 16:50:47 +02:00
Petr Korolev
8d09f5db43 add dependecies 2014-11-06 16:50:17 +02:00
Petr Korolev
ba47048f25 add license 2014-11-06 16:35:53 +02:00
Petr Korolev
da5681c83d add gemspec 2014-11-06 16:19:11 +02:00
Petr Korolev
58534f44a7 rename, move to proper folders, separate files 2014-11-06 16:11:45 +02:00
Petr Korolev
07e45692b0 update 2014-11-06 15:53:38 +02:00
Petr Korolev
778dbc3a07 add file 2014-11-06 15:51:15 +02:00
Petr Korolev
896406e5d7 rename 2014-11-06 15:50:32 +02:00
Petr Korolev
497c4cc57d update readme 2014-11-06 15:47:56 +02:00
Petr Korolev
d55ec9ed81 Create README.md 2014-11-06 15:39:10 +02:00
12 changed files with 909 additions and 264 deletions

3
.gitignore vendored
View File

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

61
CHANGELOG.md Normal file
View File

@@ -0,0 +1,61 @@
# Changelog
## [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)
- *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 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)
#### 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:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
- *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)
#### 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 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 changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

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

View File

@@ -2,6 +2,7 @@ GEM
remote: https://rubygems.org/
specs:
addressable (2.3.6)
colorize (0.7.3)
descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1)
faraday (0.9.0)
@@ -15,10 +16,6 @@ GEM
nokogiri (~> 1.6.3)
oauth2
hashie (3.3.1)
httparty (0.13.2)
json (~> 1.8)
multi_xml (>= 0.5.2)
json (1.8.1)
jwt (1.0.0)
mini_portile (0.6.1)
multi_json (1.10.1)
@@ -39,5 +36,5 @@ PLATFORMS
ruby
DEPENDENCIES
colorize
github_api
httparty

87
README.md Normal file
View File

@@ -0,0 +1,87 @@
GitHub Changelog Generator
==================
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](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.
## Installation:
[sudo] gem install github_changelog_generator
## Usage
**It's really simple**:
- `cd` to your Project folder with configured git and just type:
github_changelog_generator
- 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:
Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo
-p, --project [PROJECT] Name of project on GitHub
-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
-h, --help Displays Help
--[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
--[no-]author Add author of pull-request in the end. Default is true
-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'
-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_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
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'`
So, if you got error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
## 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!
*Bug reports, feature requests, patches, well-wishes are always welcome!*
## 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
## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

4
bin/github_changelog_generator Executable file
View File

@@ -0,0 +1,4 @@
#! /usr/bin/env ruby
require 'github_changelog_generator'
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog

227
bump_gemfile.rb Executable file
View File

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

View File

@@ -1,256 +0,0 @@
#!/usr/bin/env ruby
require 'optparse'
require 'github_api'
require 'json'
require 'httparty'
class ChangelogGenerator
attr_accessor :options, :all_tags
def initialize()
@options = self.parse_options
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
@tag_times_hash = {}
end
def parse_options
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y'}
parser = OptionParser.new { |opts|
opts.banner = 'Usage: changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options]'
opts.on('-u', '--user [USER]', 'your username on GitHub') do |last|
options[:user] = last
end
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|
options[:token] = last
end
opts.on('-h', '--help', 'Displays Help') do
puts opts
exit
end
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|
options[:last] = last
end
opts.on('-f', '--date-format [FORMAT]', 'date format. default is %d/%m/%y') do |last|
options[:format] = last
end
}
parser.parse!
#udefined case with 1 parameter:
if ARGV[0] && !ARGV[1]
puts parser.banner
exit
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
def print_json(json)
puts JSON.pretty_generate(json)
end
def exec_command(cmd)
exec_cmd = "cd #{$project_path} && #{cmd}"
%x[#{exec_cmd}]
end
def get_all_closed_pull_requests
issues = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
json = issues.body
if @options[:verbose]
puts 'Receive all pull requests'
end
json
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
puts "Can't find tag #{tag1} -> exit"
exit
end
else
log += self.generate_log_for_all_tags
end
if @options[:verbose]
puts log
end
output_filename = "#{@options[:project]}_changelog.md"
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
end
def is_megred(number)
@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"
if @options[:verbose]
puts "Receive tags for repo #{url}"
end
response = HTTParty.get(url,
:headers => {'Authorization' => 'token 8587bb22f6bf125454768a4a19dbcc774ea68d48',
'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|
t = Time.parse(req[:closed_at]).utc
true_classor_false_class = t > since_tag_time
classor_false_class = t < till_tag_time
in_range = (true_classor_false_class) && (classor_false_class)
!in_range
}
self.create_log(pull_requests, till_tag_name, till_tag_time)
end
def create_log(pull_requests, tag_name, tag_time)
trimmed_tag = tag_name.tr('v', '')
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
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}"
}
log
end
def get_time_of_tag(prev_tag)
if @tag_times_hash[prev_tag['name']]
return @tag_times_hash[prev_tag['name']]
end
if @options[:verbose]
puts "Get 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 __FILE__ == $0
ChangelogGenerator.new.compund_changelog
end

View File

@@ -0,0 +1,32 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'github_changelog_generator/version'
Gem::Specification.new do |spec|
spec.name = "github_changelog_generator"
spec.version = GitHubChangelogGenerator::VERSION
spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = '>= 1.9.3'
spec.authors = ["Petr Korolev"]
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
spec.date = `date +"%Y-%m-%d"`.strip!
spec.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
spec.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
spec.license = "MIT"
spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]
spec.add_development_dependency "bundler", "~> 1.7"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
end

390
lib/github_changelog_generator.rb Executable file
View File

@@ -0,0 +1,390 @@
#!/usr/bin/env ruby
require 'github_api'
require 'json'
require 'colorize'
require_relative 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/version'
module GitHubChangelogGenerator
class ChangelogGenerator
attr_accessor :options, :all_tags, :github
def initialize
@options = Parser.parse_options
github_token
if @github_token.nil?
@github = Github.new
else
@github = Github.new oauth_token: @github_token
end
@all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests
if @options[:issues]
@issues = self.get_all_issues
else
@issues = []
end
@tag_times_hash = {}
end
def print_json(json)
puts JSON.pretty_generate(json)
end
def exec_command(cmd)
exec_cmd = "cd #{$project_path} && #{cmd}"
%x[#{exec_cmd}]
end
def get_all_closed_pull_requests
if @options[:verbose]
puts 'Fetching pull requests..'
end
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
pull_requests = []
response.each_page do |page|
pull_requests.concat(page)
end
if @options[:verbose]
puts "Received all closed pull requests: #{pull_requests.count}"
end
unless @options[:pull_request_labels].nil?
if @options[:verbose]
puts 'Filter all pull requests by labels.'
end
filtered_pull_requests = pull_requests.select { |pull_request|
#We need issue to fetch labels
issue = @github.issues.get @options[:user], @options[:project], pull_request.number
#compare is there any labels from @options[:labels] array
select_no_label = !issue.labels.map { |label| label.name }.any?
if @options[:verbose]
puts "Filter request \##{issue.number}."
end
if @options[:pull_request_labels].any?
select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
else
select_by_label = false
end
select_by_label | select_no_label
}
if @options[:verbose]
puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
end
return filtered_pull_requests
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
puts "Can't find tag #{tag1} -> exit"
exit
end
else
log += self.generate_log_for_all_tags
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 = ''
@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
if @options[:verbose]
puts 'Fetching all tags..'
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)
newer_tag_time = self.get_time_of_tag(newer_tag)
newer_tag_name = newer_tag['name']
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)
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)
end
self.create_log(filtered_pull_requests, 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|
if req[hash_key]
t = Time.parse(req[hash_key]).utc
if older_tag_time.nil?
tag_is_older_of_older = false
else
tag_is_older_of_older = t > older_tag_time
end
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
}
end
def generate_log_before_tag(tag)
generate_log_between_tags(nil, tag)
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
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"
log += "- #{merge}"
}
else
pull_requests.each { |dict|
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
log += "- #{merge}"
}
end
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|
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]}](#{dict.html_url})\n\n"
log += "- #{merge}"
}
end
log
end
def get_time_of_tag(prev_tag)
if @tag_times_hash[prev_tag['name']]
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)
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
end
def get_all_issues
if @options[:verbose]
puts 'Fetching closed issues..'
end
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 "Received 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
if __FILE__ == $0
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
end
end

View File

@@ -0,0 +1,101 @@
#!/usr/bin/env ruby
require 'optparse'
require 'PP'
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)}
parser = OptionParser.new { |opts|
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|
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|
options[:token] = last
end
opts.on('-h', '--help', 'Displays Help') do
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('--[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|
options[:pull_request_labels] = list
end
opts.on('-v', '--version', 'Print version number') do |v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
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
exit
end
if !options[:user] && !options[:project]
remote = `git remote -vv`.split("\n")
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
if match && 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
end
if ARGV[1]
options[:tag1] = ARGV[0]
options[:tag2] = ARGV[1]
end
options
end
end
end

View File

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