Compare commits

...

170 Commits
1.1.4 ... 1.2.8

Author SHA1 Message Date
Petr Korolev
54166a444a Merge branch 'release/1.2.8' 2015-02-18 00:48:42 +02:00
Petr Korolev
e50ab5318d Update gemspec to version 1.2.8 2015-02-18 00:48:41 +02:00
Petr Korolev
9d49b1488a Finaly fixed! Thanks, @runar ! :) Fix #37. 2015-02-18 00:48:21 +02:00
Petr Korolev
3a9eca4233 add todo reminder 2015-02-18 00:48:20 +02:00
Petr Korolev
04f1173616 Make it works async and fast! 2015-02-18 00:48:20 +02:00
Petr Korolev
0eacd9acda put in actual date right closed date 2015-02-18 00:48:20 +02:00
Petr Korolev
c3884b9a55 cm 2015-02-18 00:48:20 +02:00
Petr Korolev
2cd6ba620d Async fetch events 2015-02-18 00:48:20 +02:00
Petr Korolev
c73142e169 Revert "fix #37"
This reverts commit cf4692c7b0.
2015-02-18 00:48:20 +02:00
Petr Korolev
70543e854b update changelog 2015-02-18 00:48:20 +02:00
Petr Korolev
721357d65f changelog 2015-02-18 00:48:20 +02:00
Petr Korolev
4b59f3bd65 thread saety fix 2015-02-18 00:48:20 +02:00
Petr Korolev
7d526de165 add test changelog file 2015-02-18 00:48:20 +02:00
Petr Korolev
cf0a032fb6 refactoring 2015-02-18 00:48:20 +02:00
Petr Korolev
1bc2e64e28 Merge branch 'pretty-print' into develop
Conflicts:
	lib/github_changelog_generator.rb
2015-02-16 22:34:39 +02:00
Petr Korolev
4431f26457 Prettify output 2015-02-16 22:30:14 +02:00
Petr Korolev
1eee70bfe5 fixes 2015-02-13 15:28:01 +02:00
Petr Korolev
e6f12421ff Prettify output 2015-02-13 15:17:46 +02:00
Petr Korolev
f668aedafc prettify help message 2015-02-12 13:49:41 +02:00
Petr Korolev
ae92488d6d refactoring 2015-02-10 14:36:56 +02:00
Petr Korolev
cf4692c7b0 fix #37 2015-02-09 17:52:45 +02:00
Petr Korolev
69e3b17d8b Check for exception 2015-02-06 16:36:52 +02:00
Petr Korolev
82d8c72a4d Merge branch 'master' into develop 2015-02-06 15:36:53 +02:00
Petr Korolev
7af782d0b3 Merge branch 'develop' 2015-02-06 15:36:03 +02:00
Petr Korolev
192816924f update 2015-02-06 15:34:52 +02:00
Petr Korolev
b39c644509 rm 2015-02-06 15:34:52 +02:00
Petr Korolev
ed06743b93 add example 2015-02-06 15:34:52 +02:00
Petr Korolev
65059af038 cm 2015-02-02 19:19:11 +02:00
Petr Korolev
32e085965c update 2015-02-02 19:16:06 +02:00
Petr Korolev
260e3bd666 rm 2015-02-02 19:04:31 +02:00
Petr Korolev
b88179fecc add example 2015-02-02 18:55:07 +02:00
Petr Korolev
be46bb4202 Merge branch 'develop' 2015-02-02 17:10:28 +02:00
Petr Korolev
c06c0f0432 update readme 2015-02-02 17:09:30 +02:00
Petr Korolev
736abb3528 Merge branch 'hotfix/update-changelog' 2015-01-26 17:01:37 +02:00
Petr Korolev
91c34e7f98 Merge branch 'hotfix/update-changelog' into develop 2015-01-26 17:01:37 +02:00
Petr Korolev
52d1e83888 Update changelog for version 1.2.7 2015-01-26 17:01:35 +02:00
Petr Korolev
99d20bd8a9 Merge branch 'release/1.2.7' 2015-01-26 17:00:48 +02:00
Petr Korolev
9b4f0187df Merge branch 'release/1.2.7' into develop 2015-01-26 17:00:48 +02:00
Petr Korolev
f0e713d6ef Update gemspec to version 1.2.7 2015-01-26 17:00:45 +02:00
sue445
8dc50cf483 Add option: --compare-link 2015-01-26 17:00:36 +02:00
sue445
90c455ada4 regenerate CHANGELOG 2015-01-26 17:00:36 +02:00
sue445
088824aa05 Refactorings
* tweak indent
* rename variable name (tag_xxx -> newer_tag_xxx)
2015-01-26 17:00:36 +02:00
sue445
96977c8384 Add compare link between older version and newer version 2015-01-26 17:00:36 +02:00
Petr Korolev
1940974c4c Merge pull request #46 from sue445/feature/compare_link
Add compare link between older version and newer version
2015-01-26 16:58:34 +02:00
sue445
1fced7278e Add option: --compare-link 2015-01-26 21:30:27 +09:00
sue445
eb9bd59f26 regenerate CHANGELOG 2015-01-24 21:48:02 +09:00
sue445
41f43932e0 Refactorings
* tweak indent
* rename variable name (tag_xxx -> newer_tag_xxx)
2015-01-24 21:46:13 +09:00
sue445
4ba7bbcc90 Add compare link between older version and newer version 2015-01-24 21:44:12 +09:00
Petr Korolev
8505d340af Merge branch 'hotfix/update-changelog' into develop 2015-01-21 19:19:48 +01:00
Petr Korolev
f3c05bd01c Merge branch 'hotfix/update-changelog' 2015-01-21 19:19:48 +01:00
Petr Korolev
4bcf49175b Update changelog for version 1.2.6 2015-01-21 19:19:48 +01:00
Petr Korolev
6c28db6d4a Merge branch 'release/1.2.6' into develop 2015-01-21 19:19:24 +01:00
Petr Korolev
6f8aee6a4b Merge branch 'release/1.2.6' 2015-01-21 19:19:24 +01:00
Petr Korolev
3e3cc15592 Update gemspec to version 1.2.6 2015-01-21 19:19:23 +01:00
Petr Korolev
d5edb1f606 Update README.md 2015-01-21 19:19:18 +01:00
Petr Korolev
e6d0c3d791 Update README.md 2015-01-21 19:19:18 +01:00
sugamasao
c1d28d486f fix link tag format
Remove Extra Space.
2015-01-21 19:19:18 +01:00
Petr Korolev
fa713af816 Update README.md 2015-01-21 19:17:57 +01:00
Petr Korolev
17f7127de1 Update README.md 2015-01-21 19:14:31 +01:00
Petr Korolev
e1a264e2c9 Merge pull request #45 from sugamasao/fix/link-tag-format
fix link tag format
2015-01-21 19:13:13 +01:00
sugamasao
e4b79e75ca fix link tag format
Remove Extra Space.
2015-01-17 10:28:31 +09:00
Petr Korolev
c7a767451d Merge branch 'hotfix/update-changelog' into develop 2015-01-15 23:35:17 +01:00
Petr Korolev
01f44b8311 Merge branch 'hotfix/update-changelog' 2015-01-15 23:35:17 +01:00
Petr Korolev
c0015a2c22 Update changelog for version 1.2.5 2015-01-15 23:35:17 +01:00
Petr Korolev
49cb6589f7 Merge branch 'release/1.2.5' into develop 2015-01-15 23:34:48 +01:00
Petr Korolev
e139f839c9 Merge branch 'release/1.2.5' 2015-01-15 23:34:47 +01:00
Petr Korolev
a7a75a181e Update gemspec to version 1.2.5 2015-01-15 23:34:47 +01:00
Petr Korolev
6efa421816 Merge branch 'develop' 2015-01-15 23:30:00 +01:00
Petr Korolev
e8d59fe66a Merge branch 'master' into develop 2015-01-15 23:27:13 +01:00
Petr Korolev
6b5cf5ab2e Merge pull request #42 from glenlovett/enterprise_github
support enterprise github via command line options
2015-01-15 23:16:54 +01:00
Petr Korolev
de6763aa3a Merge pull request #43 from schwing/prettyprint
PrettyPrint class is included using lowercase 'pp'
2015-01-15 23:15:50 +01:00
John Schwinghammer
5f019482d2 PrettyPrint class is included using lowercase 'pp' 2015-01-14 13:56:44 -06:00
Petr Korolev
6da115c4b0 Fix #32 2014-12-22 15:51:45 +02:00
Petr Korolev
657ce0e838 add ability to disable milestones filtering 2014-12-22 15:41:20 +02:00
Petr Korolev
5304e4faf8 fix #22 2014-12-22 15:31:49 +02:00
Petr Korolev
e6bb728355 remove issues with other milstones 2014-12-22 15:14:01 +02:00
Petr Korolev
135c48a494 Merge branch 'glenlovett-enterprise_github' into develop 2014-12-22 14:27:40 +02:00
Lovett, Glen
6bad92e899 support enterprise github via command line options 2014-12-19 16:55:42 -05:00
Petr Korolev
ad4c20d8d8 Merge branch 'hotfix/update-changelog' 2014-12-16 17:53:18 +02:00
Petr Korolev
a5d9766aef Merge branch 'hotfix/update-changelog' into develop 2014-12-16 17:53:18 +02:00
Petr Korolev
a0cfaa66a2 Update changelog for version 1.2.4 2014-12-16 17:53:16 +02:00
Petr Korolev
d16f4f7cb5 Merge branch 'release/1.2.4' 2014-12-16 17:52:49 +02:00
Petr Korolev
1d6d6ab400 Merge branch 'release/1.2.4' into develop 2014-12-16 17:52:49 +02:00
Petr Korolev
5b07fc9614 Update gemspec to version 1.2.4 2014-12-16 17:52:47 +02:00
Petr Korolev
3437fbf278 fx 2014-12-16 17:43:24 +02:00
Petr Korolev
ba4db0e5f4 Merge branch 'hotfix/update-changelog' 2014-12-16 17:42:11 +02:00
Petr Korolev
abac1013f1 fx 2014-12-16 17:41:20 +02:00
Petr Korolev
28247edc7f Merge branch 'release/1.2.3' into develop 2014-12-16 17:25:12 +02:00
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
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
a5c4899360 add travis configs 2014-11-12 11:03:46 +02:00
12 changed files with 712 additions and 207 deletions

1
.gitignore vendored
View File

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

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,28 +1,96 @@
# 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)
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
#### 26/01/15
- *Merged pull-request:* Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
- *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)
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
#### 21/01/15
- *Merged pull-request:* fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
#### 15/01/15
- *Merged pull-request:* PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
- *Merged pull-request:* support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
- *Implemented enhancement:* Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
- *Fixed bug:* Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
#### 16/12/14
- *Merged pull-request:* Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
- *Fixed bug:* Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
#### 16/12/14
- *Implemented enhancement:* Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
- *Implemented enhancement:* Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
- *Fixed bug:* Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...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))
- *Fixed bug:* Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...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))
- *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)
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
#### 18/11/14
- *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)
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...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)
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...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)
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
#### 10/11/14
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
@@ -30,15 +98,17 @@
- *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)
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...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:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([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:* 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) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
@@ -46,15 +116,17 @@
- *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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...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)
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
#### 06/11/14
## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
#### 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

122
README.md
View File

@@ -2,72 +2,118 @@ 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.
**Fully automate changelog generation** - This script automatically generate change-log from your tags, issues and merged pull-requests from your project's **Github issue tracker**.
## Installation:
[sudo] gem install github_changelog_generator
## Usage
**It's really simple**:
## Output example:
- `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 it on https://github.com/settings/applications
-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:
- 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:
- 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
- In general it looks like this:
> ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10)
> #### 09/01/15
> - *Merged pull-request:* add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115)
> ([skywinder](https://github.com/skywinder))
>
> - *Merged pull-request:* Fix bad interaction with Git submodules.
> [\#112](https://github.com/skywinder/ActionSheetPicker-3.0/pull/112)
> ([JimDabell](https://github.com/JimDabell))
>
> - *Implemented enhancement:* Should have minimum/maximum date property exposed
> [\#97](https://github.com/skywinder/ActionSheetPicker-3.0/issues/97)
>
> ## [1.3.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.9)
> #### 11/12/14
> - *Closed issue:* Bad interaction with submodules [\#111](https://github.com/skywinder/ActionSheetPicker-3.0/issues/111)
>
> - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122)
###Features and advantages of this project as compared to other:
- Custom date format supported
- Automatically split issues by type:
- **Issues** (closed issues w/o any labels)
- **Merged pull-requests** (all merged pull-requests)
- **Bug-fixes** (by label `bug` in issue)
- **Enhancements** (by label `enhancement` in issue)
- Excluding "questions" from changelog (issues marked as `question` labels)
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
- Ability to exclude some issues from changelog (by labels)
## Usage:
**It's really simple**:
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
github_changelog_generator
- 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:
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
### GitHub token
## 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"'`
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.
## 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 changelog 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!
**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!*

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

133
lib/CHANGELOG.md Normal file
View File

@@ -0,0 +1,133 @@
# Changelog
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
#### 26/01/15
- *Merged pull-request:* Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
#### 21/01/15
- *Merged pull-request:* fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
#### 15/01/15
- *Merged pull-request:* PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
- *Merged pull-request:* support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
- *Implemented enhancement:* Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
- *Fixed bug:* Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
#### 16/12/14
- *Merged pull-request:* Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
- *Merged pull-request:* Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
- *Implemented enhancement:* Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
- *Fixed bug:* Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
#### 16/12/14
- *Implemented enhancement:* Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
- *Fixed bug:* Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...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))
- *Fixed bug:* Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...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))
- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
#### 18/11/14
- *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)
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...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) ([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) ([skywinder](https://github.com/skywinder))
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...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) ([skywinder](https://github.com/skywinder))
- *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) ([skywinder](https://github.com/skywinder))
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
#### 10/11/14
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
#### 07/11/14
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
- *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) ([skywinder](https://github.com/skywinder))
- *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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...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) ([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) ([skywinder](https://github.com/skywinder))
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...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

@@ -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,61 +14,157 @@ module GitHubChangelogGenerator
attr_accessor :options, :all_tags, :github
PER_PAGE_NUMBER = 30
def initialize
@options = Parser.parse_options
github_token
if @github_token.nil?
@github = Github.new
else
@github = Github.new oauth_token: @github_token
if options[:verbose]
puts 'Input options:'
pp options
puts ''
end
github_token
github_options = {per_page: PER_PAGE_NUMBER}
github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
@github = Github.new github_options
@generator = Generator.new(@options)
@all_tags = self.get_all_tags
@pull_requests = self.get_all_closed_pull_requests
@issues = self.get_all_issues
@pull_requests = self.get_filtered_pull_requests
if @options[:issues]
@issues = self.get_all_issues
fetch_event_for_issues(@issues)
detect_actual_closed_dates
else
@issues = []
end
@tag_times_hash = {}
end
def detect_actual_closed_dates
if @options[:verbose]
print "Fetching close commit date for issues...\r"
end
threads = []
@issues.each{|issue|
threads << Thread.new {
find_closed_date_by_commit(issue)
}
}
threads.each { |thr| thr.join }
if @options[:verbose]
puts 'Fetching close commit date for issues: Done!'
end
end
def find_closed_date_by_commit(issue)
unless issue['events'].nil?
# reverse! - to find latest closed event. (event goes in date order)
issue['events'].reverse!.each{|event|
if event[:event].eql? 'closed'
if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at]
else
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
issue[:actual_date] = commit[:author][:date]
end
break
end
}
end
#TODO: assert issues, that remain without 'actual_date' hash for some reason.
end
def print_json(json)
puts JSON.pretty_generate(json)
end
def exec_command(cmd)
exec_cmd = "cd #{$project_path} && #{cmd}"
exec_cmd = "cd #{$project_path} and #{cmd}"
%x[#{exec_cmd}]
end
def get_all_closed_pull_requests
if @options[:verbose]
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
count_pages = response.count_pages
print "Fetching pull requests... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
pull_requests.concat(page)
end
print " \r"
if @options[:verbose]
puts "Receive all pull requests: #{pull_requests.count}"
puts "Received pull requests: #{pull_requests.count}"
end
pull_requests
end
def get_filtered_pull_requests
pull_requests = self.get_all_closed_pull_requests
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|
#fetch this issue to get labels array
issue = @github.issues.get @options[:user], @options[:project], pull_request.number
#compare is there any labels from @options[:labels] array
issue_without_labels = !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 | issue_without_labels
}
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]
elsif @options[:tag1] and @options[:tag2]
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
@@ -94,14 +193,24 @@ 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) }
if @options[:verbose]
puts "Fetching tags dates.."
end
# Async fetching tags:
threads = []
@all_tags.each { |tag|
# explicit set @tag_times_hash to write data safety.
threads << Thread.new { self.get_time_of_tag(tag, @tag_times_hash) }
}
threads.each { |thr| thr.join }
if @options[:verbose]
puts "Sorting tags.."
@@ -113,11 +222,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
@@ -128,20 +237,21 @@ module GitHubChangelogGenerator
def get_all_tags
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
if @options[:verbose]
puts "Receive tags for repo #{url}"
print "Fetching tags...\r"
end
response = @github.repos.tags @options[:user], @options[:project]
tags = []
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
tags.concat(page)
end
print " \r"
if @options[:verbose]
puts "Found #{tags.count} tags"
end
@@ -167,103 +277,116 @@ module GitHubChangelogGenerator
def generate_log_between_tags(older_tag, newer_tag)
older_tag_time = self.get_time_of_tag(older_tag)
if newer_tag.nil?
puts "Can't find tag -> terminate"
exit 1
end
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)
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag)
filtered_issues = delete_by_time(@issues, :actual_date, newer_tag_time, older_tag)
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
older_tag_name = older_tag.nil? ? nil : older_tag['name']
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
!tag_not_in_range
else
true
end
if @options[:filter_issues_by_milestone]
#delete excess irrelevant issues (according milestones)
filtered_issues.select! { |issue|
if issue.milestone.nil?
true
else
#check, that this milestone in tag list:
milestone_is_tag = @all_tags.find { |tag|
tag.name == issue.milestone.title
}
milestone_is_tag.nil?
end
}
}
issues = Array.new(@issues)
#add missed issues (according milestones)
issues_to_add = @issues.select { |issue|
if issue.milestone.nil?
false
else
#check, that this milestone in tag list:
milestone_is_tag = @all_tags.find { |tag|
tag.name == issue.milestone.title
}
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
if milestone_is_tag.nil?
false
else
issue.milestone.title == newer_tag_name
end
end
}
in_range = (tag_is_later_since) && (tag_is_before_till)
!in_range
else
true
end
filtered_issues |= issues_to_add
end
}
self.create_log(pull_requests, issues, newer_tag_name, newer_tag_time)
self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time, older_tag_name)
end
def generate_log_before_tag(tag)
tag_time = self.get_time_of_tag(tag)
tag_name = tag['name']
def delete_by_time(array, hash_key, newer_tag_time, older_tag = nil)
pull_requests = Array.new(@pull_requests)
older_tag_time = self.get_time_of_tag(older_tag)
pull_requests.delete_if { |req|
if req[:merged_at]
t = Time.parse(req[:merged_at]).utc
t > tag_time
array.select { |req|
if req[hash_key]
t = Time.parse(req[hash_key]).utc
if older_tag_time.nil?
tag_in_range_old = true
else
tag_in_range_old = t > older_tag_time
end
tag_in_range_new = t <= newer_tag_time
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range
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
false
end
}
self.create_log(pull_requests, issues, tag_name, tag_time)
end
def create_log(pull_requests, issues, tag_name, tag_time)
# @param [Array] pull_requests
# @param [Array] issues
# @param [String] newer_tag_name
# @param [String] newer_tag_time
# @param [String] older_tag_name
# @return [String]
def create_log(pull_requests, issues, newer_tag_name, newer_tag_time, older_tag_name = nil)
github_site = options[:github_site] || 'https://github.com'
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
# 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 = "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name})\n"
if @options[:compare_link] && older_tag_name
# Generate compare link
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name})\n"
end
#Generate date string:
time_string = tag_time.strftime @options[:format]
time_string = newer_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
pull_requests.each { |pull_request|
merge = @generator.get_string_for_pull_request(pull_request)
log += "- #{merge}"
} if pull_requests
end
if @options[:issues]
@@ -306,52 +429,64 @@ 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
log
end
def get_time_of_tag(prev_tag)
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
if @tag_times_hash[prev_tag['name']]
return @tag_times_hash[prev_tag['name']]
if tag_name.nil?
return nil
end
if @options[:verbose]
puts "Getting time for tag #{prev_tag['name']}"
if tag_times_hash[tag_name['name']]
return @tag_times_hash[tag_name['name']]
end
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['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)
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
end
def get_all_issues
if @options[:verbose]
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
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
issues.concat(page)
end
print " \r"
if @options[:verbose]
puts "Received issues: #{issues.count}"
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
@@ -360,14 +495,39 @@ module GitHubChangelogGenerator
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"
puts "Filtered issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count}"
end
filtered_issues
end
def fetch_event_for_issues(filtered_issues)
if @options[:verbose]
print "Fetching events for issues: 0/#{filtered_issues.count}\r"
end
# Async fetching events:
threads = []
i = 0
filtered_issues.each { |issue|
threads << Thread.new {
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
issue[:events] = obj.body
print "Fetching events for issues: #{i+1}/#{filtered_issues.count}\r"
i +=1
}
}
threads.each { |thr| thr.join }
if @options[:verbose]
puts "Fetching events for issues: Done!"
end
end
end
if __FILE__ == $0

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 += " ({Null user})\n\n"
else
merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\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

@@ -1,11 +1,12 @@
#!/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:* '}
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, :filter_issues_by_milestone => true, :compare_link => true}
parser = OptionParser.new { |opts|
opts.banner = 'Usage: changelog_generator [options]'
@@ -15,54 +16,84 @@ 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
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|
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-wo-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('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
options[:filter_issues_by_milestone] = 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('--[no-]compare-link', 'Include compare link between older version and newer version. Default is true') do |v|
options[:compare_link] = v
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('--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('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
options[:github_site] = last
end
opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
options[:github_endpoint] = last
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!
#udefined case with 1 parameter:
if ARGV[0] && !ARGV[1]
puts parser.banner
exit
github_site = options[:github_site] ? options[:github_site] : 'github.com'
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
begin
param = match[2].nil?
rescue
puts "Can't detect user and name from first parameter: '#{ARGV[0]}' -> exit'"
exit
end
if param
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]}"
@@ -79,7 +110,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.1.4'
VERSION = '1.2.8'
end