Compare commits

...

187 Commits

Author SHA1 Message Date
Petr Korolev
7aed6aa528 Merge branch 'release/1.10.1' 2016-01-06 09:14:45 +02:00
Petr Korolev
9ddc676a44 Update gemspec to version 1.10.1 2016-01-06 09:14:41 +02:00
Olle Jonsson
1b9a251c6b linting 2016-01-06 09:14:09 +02:00
Olle Jonsson
88ec105c7d Parser: avoid Ruby exit
- made the method take three arguments
- specs all note these three
2016-01-06 09:14:08 +02:00
Petr Korolev
3a784b16d6 Merge pull request #315 from skywinder/feature/repair-recognizing-user-and-project
Parser: avoid Ruby exit, to make Rake tasks work
2016-01-06 09:13:32 +02:00
Olle Jonsson
0cc7065efc linting 2016-01-05 21:59:39 +01:00
Olle Jonsson
53df784ec3 Parser: avoid Ruby exit
- made the method take three arguments
- specs all note these three
2016-01-05 21:58:13 +01:00
Petr Korolev
d81cb5fcb7 Merge branch 'develop' 2016-01-05 16:50:27 +02:00
Petr Korolev
8c8c7c4d3c bundle update 2016-01-05 16:50:16 +02:00
Petr Korolev
34b8fc7217 Merge branch 'hotfix/update-changelog' 2016-01-05 16:45:33 +02:00
Petr Korolev
6d02c509cd Merge branch 'hotfix/update-changelog' into develop 2016-01-05 16:45:33 +02:00
Petr Korolev
ac1c70978d Update changelog for version 1.10.0 2016-01-05 16:45:31 +02:00
Petr Korolev
670ced30e3 Merge branch 'release/1.10.0' 2016-01-05 16:44:48 +02:00
Petr Korolev
b0b4b1cf0a Merge branch 'release/1.10.0' into develop 2016-01-05 16:44:48 +02:00
Petr Korolev
af97beeb60 Update gemspec to version 1.10.0 2016-01-05 16:44:45 +02:00
Petr Korolev
384b080ad0 Merge pull request #305 from SteveGilvarry/Add_Release_Branch
Fixes #280 Add release-branch option to filter the Pull Requests
2016-01-05 16:43:43 +02:00
Steve Gilvarry
0e4c775ce4 Revert changes made for trying to use github_options
Reverting other changes made that I missed.
2016-01-05 21:31:38 +11:00
Steve Gilvarry
c6eac743b6 Merge pull request #1 from skywinder/SteveGilvarry-Add_Release_Branch
Steve gilvarry add release branch
2016-01-05 21:04:31 +11:00
Petr Korolev
033c7e8d79 Merge branch 'develop' 2016-01-05 12:01:40 +02:00
Petr Korolev
bffe7cd9ff issue 20 in test repo didn't appear in change log. 2016-01-05 11:28:44 +02:00
Petr Korolev
9832dce93c works! 2016-01-05 11:18:04 +02:00
Petr Korolev
d2fa9d3565 Merge branch 'develop' into SteveGilvarry-Add_Release_Branch 2016-01-05 11:07:44 +02:00
Petr Korolev
8f7af37d1e update changelog 2016-01-05 11:04:18 +02:00
Steve Gilvarry
12bc3550e1 Fix Trailing Whitespace error
Rubocop was stopping this from building on Travis.
2016-01-03 07:11:49 +11:00
Steve Gilvarry
5d5a48e00e Remove debug code 2016-01-03 07:06:25 +11:00
Steve Gilvarry
35b581240f Reinstate User and Repo options
Trying to use github options to hold repo and user didn’t seem to work
for all commands. Reverting those changes
2016-01-03 07:02:19 +11:00
Steve Gilvarry
01a0c05a02 Merge remote-tracking branch 'skywinder/master' into Add_Release_Branch 2016-01-02 21:23:37 +11:00
Petr Korolev
90ea75c471 Merge branch 'master' into develop 2015-11-22 11:03:09 +02:00
Petr Korolev
46aaa5f205 Merge pull request #306 from SteveGilvarry/patch-1
Update bundler
2015-11-22 11:02:23 +02:00
Petr Korolev
95d32abbcb Move from legacy code 2015-11-22 10:55:24 +02:00
Petr Korolev
47c0332b55 Merge branch 'master' into develop 2015-11-22 10:48:55 +02:00
Steve Gilvarry
c63b2e1fb9 Update bundler
Standard Bundler in Travis is old and causes build issues, well that is the theory. This will update bundler.

https://github.com/travis-ci/travis-ci/issues/3531
2015-11-20 23:13:31 +11:00
Steve Gilvarry
29fd202ed0 Clean up user and project from all api calls 2015-11-20 22:17:10 +11:00
Steve Gilvarry
fc1fb2eb9a Merge remote-tracking branch 'skywinder/master' into Add_Release_Branch 2015-11-20 22:12:14 +11:00
Steve Gilvarry
afbb47ecf3 Remove repeated user and repo params
Used the github_options setting to add user and repo values
2015-11-20 22:12:06 +11:00
Steve Gilvarry
1d1965e7fb Swap unless nil? to if 2015-11-19 20:14:04 +11:00
Steve Gilvarry
06a8fe8169 Add release-branch option to filter the Pull Requests by those applied on a partcular release branch 2015-11-18 16:56:27 +11:00
Olle Jonsson
138abfe676 Merge pull request #303 from SteveGilvarry/Missing_options_param
Add options to def self.user_and_project_from_git to fix parser.rb:19…
2015-11-11 22:47:01 +01:00
Steve Gilvarry
3fdf0c64df Add options to def self.user_and_project_from_git to fix parser.rb:193 wrong number of arguments (1 for 0) 2015-11-12 07:55:54 +11:00
Petr Korolev
645f96ace6 Merge pull request #298 from olleolleolle/refactor/reader-positive-boolean
[refactor] Reader: positive Boolean; unused #map
2015-10-23 16:49:36 +03:00
Petr Korolev
dfdeb0e633 Merge pull request #299 from olleolleolle/fix/reader-doc-comment
[refactor] Fix docblock datatype, use #map
2015-10-23 16:48:49 +03:00
Petr Korolev
8d44b16e73 Merge pull request #300 from olleolleolle/fix/ignore-coverage-files
Git ignore coverage/
2015-10-23 16:44:57 +03:00
Olle Jonsson
a6e6363cdd Git ignore coverage/ 2015-10-23 08:19:56 +02:00
Olle Jonsson
dd0d82ab91 [refactor] Fix YARD datatype, use #map 2015-10-23 07:44:20 +02:00
Olle Jonsson
8a87be8f4e Reader: use positive Boolean, drop unused #map 2015-10-23 07:32:52 +02:00
Petr Korolev
8f78bb0cc6 Merge pull request #296 from olleolleolle/feature/introduce-parsererror-class
Introduce ParserError exception class
2015-10-22 15:25:54 +03:00
Petr Korolev
b1d2b7d828 Merge pull request #297 from olleolleolle/feature/linting-parser-setup
Rubocop: less complex methods in parser.rb
2015-10-22 15:24:47 +03:00
Olle Jonsson
3fb75c825f Lint: rename to avoid getter naming
- fixed Rake task, too
2015-10-22 00:09:25 +02:00
Olle Jonsson
d227464c33 Rubocop: less complex methods
- Changed one thing: failed return value on printing the banner when
    no user or project was found.
2015-10-21 23:42:33 +02:00
Olle Jonsson
5a9928c18a Introduce ParserError exception class 2015-10-21 23:13:42 +02:00
Petr Korolev
2dda090e6b Merge pull request #295 from jjasghar/patch-1
Update README.md
2015-10-21 22:48:32 +03:00
JJ Asghar
38ddf055ae Update README.md
Typo.
2015-10-21 13:27:17 -05:00
Olle Jonsson
92ade3a625 Merge pull request #290 from olivierlacan/patch-1
keepachangelog.com is not copyrighted ;-)
2015-10-06 22:36:32 +02:00
Olivier Lacan
3d1789a2d1 keepachangelog.com is not copyrighted ;-)
I don't want to suggest that it's copyrighted in any way.
2015-10-06 16:24:58 -04:00
Petr Korolev
4f64cdb7d5 Merge branch 'master' into develop 2015-10-01 19:36:41 +03:00
Olle Jonsson
99ffa3692b Merge pull request #287 from jkeiser/base-option
Add base option to RakeTask
2015-10-01 00:42:00 +02:00
John Keiser
fdb89ea805 Add base option to RakeTask 2015-09-30 11:28:21 -07:00
Olle Jonsson
b7fff7b764 Merge pull request #285 from olleolleolle/feature/specs-simpler
ParserFile: support values with equals signs
2015-09-22 22:07:20 +02:00
Olle Jonsson
6d36d007ad ParserFile: support values with equals signs 2015-09-22 21:59:24 +02:00
Petr Korolev
9dea79fe40 Merge branch 'hotfix/update-changelog' into develop 2015-09-17 12:01:55 +03:00
Petr Korolev
693f5ee2ee Merge branch 'hotfix/update-changelog' 2015-09-17 12:01:54 +03:00
Petr Korolev
e6eb9f5bb6 gemfile lock update 2015-09-17 12:01:40 +03:00
Petr Korolev
916df554af Update changelog for version 1.9.0 2015-09-17 12:00:23 +03:00
Petr Korolev
d959639e2a Merge branch 'release/1.9.0' into develop 2015-09-17 11:59:34 +03:00
Petr Korolev
8f61c7fc7e Merge branch 'release/1.9.0' 2015-09-17 11:59:33 +03:00
Petr Korolev
d79e70b267 Update gemspec to version 1.9.0 2015-09-17 11:59:30 +03:00
Dlani Mendes
ba7c565374 Rspec and README 2015-09-17 11:59:02 +03:00
Petr Korolev
31b4294ed6 rubocop autofix 2015-09-17 11:59:02 +03:00
Petr Korolev
55a1c6933c add build status 2015-09-17 11:59:01 +03:00
Petr Korolev
125960a3a3 run bundle install --no-deploymeng 2015-09-17 11:59:01 +03:00
Petr Korolev
9feecf98b8 update travis 2015-09-17 11:59:01 +03:00
Petr Korolev
4b88f02f97 remove trailing spaces 2015-09-17 11:59:01 +03:00
Olle Jonsson
eccecd6875 Feature: exclude_tags using regular expression 2015-09-17 11:59:01 +03:00
Dlani Mendes
0862e54f42 Auto parse options from file .github_changelog_generator 2015-09-17 11:59:01 +03:00
Petr Korolev
1c578fec91 rm build status 2015-09-17 11:59:01 +03:00
Petr Korolev
29c33fec60 Merge pull request #278 from dlanileonardo/master
Auto parse options from file .github_changelog_generator
2015-09-17 11:58:29 +03:00
Dlani Mendes
6c71cf439a Rspec and README 2015-09-16 16:19:40 -03:00
Petr Korolev
2d7f6bf174 rubocop autofix 2015-09-16 14:50:21 +03:00
Petr Korolev
1e4a3db0a2 Merge pull request #281 from olleolleolle/feature/rake-specs
Feature: exclude_tags using regular expression
2015-09-16 12:14:19 +03:00
Petr Korolev
b0fc03f38c add build status 2015-09-16 10:58:24 +03:00
Petr Korolev
a2658f9af9 run bundle install --no-deploymeng 2015-09-16 10:22:07 +03:00
Petr Korolev
48a49a67ec update travis 2015-09-16 10:09:27 +03:00
Petr Korolev
93b69a511f remove trailing spaces 2015-09-16 09:28:43 +03:00
Olle Jonsson
ef97e7f950 Feature: exclude_tags using regular expression 2015-09-15 21:34:54 +02:00
Dlani Mendes
fbd8207ff4 Auto parse options from file .github_changelog_generator 2015-09-15 13:58:23 -03:00
Petr Korolev
ff4e5612af rm build status 2015-09-15 09:07:46 +03:00
Petr Korolev
6bace8a582 Merge branch 'hotfix/update-changelog' into develop 2015-09-15 09:06:55 +03:00
Petr Korolev
a6b0d0cb83 Merge branch 'hotfix/update-changelog' 2015-09-15 09:06:54 +03:00
Petr Korolev
91176e9174 Update changelog for version 1.8.5 2015-09-15 09:06:52 +03:00
Petr Korolev
494c8afff0 Merge branch 'release/1.8.5' into develop 2015-09-15 09:06:03 +03:00
Petr Korolev
d14694a6d6 Merge branch 'release/1.8.5' 2015-09-15 09:06:03 +03:00
Petr Korolev
aa64fa131c Update gemspec to version 1.8.5 2015-09-15 09:06:00 +03:00
Petr Korolev
fe0eab1c90 Merge pull request #279 from olleolleolle/feature/negative-options
Rake task: Be able to set false value in config
2015-09-15 09:04:25 +03:00
Olle Jonsson
14d7c29808 Rake task: Be able to set false value in config 2015-09-15 00:35:07 +02:00
Petr Korolev
1bf758480f Merge branch 'master' into develop 2015-09-01 09:16:55 +03:00
Petr Korolev
12ea21c00b Merge pull request #275 from skywinder/fix-274
This PRi will fix #274.
2015-09-01 09:16:34 +03:00
Petr Korolev
6411ba6b81 Merge branch 'hotfix/update-changelog' into develop 2015-09-01 09:14:28 +03:00
Petr Korolev
302eb9c66f Merge branch 'hotfix/update-changelog' 2015-09-01 09:14:27 +03:00
Petr Korolev
4bd88a3fcb Update changelog for version 1.8.4 2015-09-01 09:14:25 +03:00
Petr Korolev
61b026a60c Merge branch 'release/1.8.4' into develop 2015-09-01 09:13:40 +03:00
Petr Korolev
72f993fab5 Merge branch 'release/1.8.4' 2015-09-01 09:13:40 +03:00
Petr Korolev
0a7c4886ec Update gemspec to version 1.8.4 2015-09-01 09:13:37 +03:00
Petr Korolev
b902897a22 This commit will fix #274. 2015-09-01 09:13:27 +03:00
Petr Korolev
0df2687b93 This commit will fix #274. 2015-09-01 09:11:52 +03:00
Petr Korolev
60ddebbe1a Merge branch 'hotfix/update-changelog' 2015-08-31 15:42:22 +03:00
Petr Korolev
e91b8cc535 Merge branch 'hotfix/update-changelog' into develop 2015-08-31 15:42:22 +03:00
Petr Korolev
f718a82af1 Update changelog for version 1.8.3 2015-08-31 15:42:20 +03:00
Petr Korolev
606f193ff6 Merge branch 'release/1.8.3' into develop 2015-08-31 15:41:28 +03:00
Petr Korolev
5df78f22d1 Merge branch 'release/1.8.3' 2015-08-31 15:41:27 +03:00
Petr Korolev
b0f264a928 Update gemspec to version 1.8.3 2015-08-31 15:41:25 +03:00
Petr Korolev
ea4a604bcb update gitignore 2015-08-31 15:35:01 +03:00
Raphaël Pinson
1ec72afe32 Do not alter pull_requests while iterating on it
Deleting elements of an array while iterating on it
results in never seeing the last element.

    > a = [1,2,3]
     => [1, 2, 3]
    > a.each do |e|
    >   p a
    >   a.delete(e)
    > end
    [1, 2, 3]
    [2, 3]
     => [2]
2015-08-31 15:15:42 +03:00
Petr Korolev
127ffee93f Merge pull request #271 from raphink/dev/pr_delete
Do not alter pull_requests while iterating on it
2015-08-27 14:59:06 +03:00
Raphaël Pinson
6a732ceb99 Do not alter pull_requests while iterating on it
Deleting elements of an array while iterating on it
results in never seeing the last element.

    > a = [1,2,3]
     => [1, 2, 3]
    > a.each do |e|
    >   p a
    >   a.delete(e)
    > end
    [1, 2, 3]
    [2, 3]
     => [2]
2015-08-27 13:36:41 +02:00
Petr Korolev
0140986091 Merge branch 'hotfix/update-changelog' into develop 2015-08-26 17:06:17 +03:00
Petr Korolev
312fe3d45a Merge branch 'hotfix/update-changelog' 2015-08-26 17:06:17 +03:00
Petr Korolev
be2340ddcb http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/ 2015-08-26 17:06:07 +03:00
Petr Korolev
f29061e75a Update changelog for version 1.8.2 2015-08-26 17:02:49 +03:00
Petr Korolev
de531262c8 Merge branch 'release/1.8.2' into develop 2015-08-26 17:02:02 +03:00
Petr Korolev
35d520d251 Merge branch 'release/1.8.2' 2015-08-26 17:02:02 +03:00
Petr Korolev
1589df3959 Update gemspec to version 1.8.2 2015-08-26 17:02:00 +03:00
Petr Korolev
a0779a5811 This fix #270 2015-08-26 17:01:18 +03:00
Petr Korolev
c611e907e0 Merge branch 'hotfix/update-changelog' into develop 2015-08-25 17:33:34 +03:00
Petr Korolev
42c94c4dd2 Merge branch 'hotfix/update-changelog' 2015-08-25 17:33:33 +03:00
Petr Korolev
16f01dbda1 resolve 2015-08-25 17:33:22 +03:00
Petr Korolev
f285176e25 Update changelog for version 1.8.1 2015-08-25 17:32:45 +03:00
Petr Korolev
ca1ae124af Merge branch 'release/1.8.1' into develop 2015-08-25 17:31:57 +03:00
Petr Korolev
672c89dcc8 Merge branch 'release/1.8.1' 2015-08-25 17:31:56 +03:00
Petr Korolev
5a5de9ee4a Update gemspec to version 1.8.1 2015-08-25 17:31:54 +03:00
Petr Korolev
7e21aacecc simpify expressin & update change log 2015-08-25 17:31:05 +03:00
Petr Korolev
a9f50cd82e Update README.md 2015-08-25 17:31:05 +03:00
Petr Korolev
0b0a762a80 update change log 2015-08-25 17:31:05 +03:00
Raphaël Pinson
0fae7e0f9e Use since_tag as default for older_tag 2015-08-25 17:31:05 +03:00
Raphaël Pinson
953d2813fb Honor labels in PRs, fix #266 2015-08-25 17:31:04 +03:00
Petr Korolev
abd7175eef simpify expressin & update change log 2015-08-25 17:28:07 +03:00
Petr Korolev
8fab94702f Merge pull request #266 from raphink/dev/pr_labels
Honor labels for Pull Requests
2015-08-25 17:27:39 +03:00
Petr Korolev
ef332dd02b Update README.md 2015-08-25 16:56:52 +03:00
Petr Korolev
83ae430dd8 update change log 2015-08-25 16:08:58 +03:00
Petr Korolev
8c0974200c Merge pull request #267 from raphink/dev/older_tag
Use since_tag as default for older_tag
2015-08-25 16:08:06 +03:00
Petr Korolev
28e3ed2500 Merge branch 'develop' 2015-08-25 15:25:00 +03:00
Petr Korolev
1bf5644a72 Merge branch 'feature/fix-262' into develop 2015-08-25 15:15:41 +03:00
Petr Korolev
bc37d0277b update change log 2015-08-25 15:15:30 +03:00
Petr Korolev
c4846b7ef9 Merge branch 'develop' into feature/fix-262 2015-08-25 15:10:04 +03:00
Petr Korolev
d09dad30f4 update change log 2015-08-25 15:08:09 +03:00
Raphaël Pinson
31e98fbc41 Use since_tag as default for older_tag 2015-08-25 13:55:29 +02:00
Petr Korolev
82dd0b3cce This commit close #262 2015-08-25 14:27:40 +03:00
Petr Korolev
1ae86e3cb2 rename and convert string to sybol 2015-08-25 13:14:04 +03:00
Raphaël Pinson
b3eea83ae1 Honor labels in PRs, fix #266 2015-08-25 10:28:27 +02:00
Petr Korolev
7e4d546f60 Merge branch 'hotfix/update-changelog' into develop 2015-08-24 18:31:55 +03:00
Petr Korolev
be62b92fa9 Merge branch 'hotfix/update-changelog' 2015-08-24 18:31:53 +03:00
Petr Korolev
0b6d751388 Update changelog for version 1.8.0 2015-08-24 18:31:31 +03:00
Petr Korolev
410921f673 Merge branch 'release/1.8.0' into develop 2015-08-24 17:55:25 +03:00
Petr Korolev
8b49b5ac0c Merge branch 'release/1.8.0' 2015-08-24 17:55:25 +03:00
Petr Korolev
d7b5d77bbf Update gemspec to version 1.8.0 2015-08-24 17:55:23 +03:00
Petr Korolev
ddf2624bf9 Merge branch 'develop' 2015-08-24 17:53:06 +03:00
Petr Korolev
80b40d1b36 Merge branch 'feature/due-tag' into develop 2015-08-24 17:52:09 +03:00
Petr Korolev
e8e4628261 Merge branch 'master' into develop 2015-08-24 17:51:14 +03:00
Petr Korolev
4261c3494e Add due-tag option and tests 2015-08-24 17:29:07 +03:00
Petr Korolev
d138644925 add docs 2015-08-24 16:47:37 +03:00
Petr Korolev
0301dcb672 Merge pull request #264 from raphink/dev/release_url
Add release_url to rake task options
2015-08-24 16:01:42 +03:00
Raphaël Pinson
73d4415e14 Add release_url to rake task options 2015-08-24 14:55:57 +02:00
Petr Korolev
ed179ed7be Merge branch 'master' into develop 2015-08-24 14:54:53 +03:00
Petr Korolev
0930cfdd88 Update README.md 2015-08-24 14:54:41 +03:00
Petr Korolev
c140349a73 git push origin masterMerge branch 'raphink-dev/no_replace' 2015-08-24 14:43:39 +03:00
Petr Korolev
8c35215697 Merge branch 'dev/no_replace' of https://github.com/raphink/github-changelog-generator into raphink-dev/no_replace 2015-08-24 14:43:05 +03:00
Petr Korolev
840b6666e0 Merge pull request #263 from skywinder/revert-261-patch-1
Revert "Fixed Readme, I think"
2015-08-24 14:38:34 +03:00
Petr Korolev
7b7c6fc793 Revert "Fixed Readme, I think" 2015-08-24 14:28:22 +03:00
Petr Korolev
2357875c13 Merge pull request #261 from dpwspoon/patch-1
Fixed Readme, I think
2015-08-24 14:05:22 +03:00
David Witherspoon
cac840c57d Fixed Readme, I think
I don't know where a 16 digit token comes from.  But the 40 digit token works.  So I think this is a typo.
2015-08-21 09:31:01 -07:00
Raphaël Pinson
9acca33bc2 Test if @options[:base] is set 2015-08-12 16:35:47 +02:00
Petr Korolev
4aa9c61520 Merge pull request #259 from raphink/dev/release_url
Add release_url option
2015-08-09 17:08:52 +03:00
Petr Korolev
f49949147c Merge pull request #260 from raphink/dev/rake_task
Add a rake task
2015-08-09 17:06:32 +03:00
Raphaël Pinson
bfae7b9a45 Auto detect since tag from base file 2015-08-05 10:57:08 +02:00
Raphaël Pinson
4202b95076 Add --base option 2015-08-05 10:40:28 +02:00
Raphaël Pinson
4856a3c8e9 Add release_url option 2015-08-05 10:31:16 +02:00
Raphaël Pinson
5d9b44eac3 Add a rake task 2015-08-05 10:26:29 +02:00
Petr Korolev
295cfbc767 Merge pull request #257 from raphink/dev/since_tag
Add --since-tag, close
2015-08-04 18:42:03 +03:00
Raphaël Pinson
32f4df5742 Add --since-tag option
Fix #254
2015-08-04 16:15:33 +02:00
Raphaël Pinson
0190d417c2 Typo 2015-08-04 14:56:39 +02:00
Petr Korolev
b6efcfced8 Merge branch 'hotfix/update-changelog' into develop 2015-07-16 17:26:54 +03:00
Petr Korolev
b74b457ad0 Merge branch 'hotfix/update-changelog' 2015-07-16 17:26:52 +03:00
Petr Korolev
83cc36959a update 2015-07-16 17:25:32 +03:00
Petr Korolev
2dbf975c06 Update changelog for version 1.7.0 2015-07-16 17:23:52 +03:00
Petr Korolev
63e91d8e72 Merge branch 'release/1.7.0' into develop 2015-07-16 17:22:58 +03:00
Petr Korolev
d081130e3e Merge branch 'release/1.7.0' 2015-07-16 17:22:58 +03:00
Petr Korolev
016f5e690c Update gemspec to version 1.7.0 2015-07-16 17:22:56 +03:00
Petr Korolev
cb4533abf7 Merge branch 'hotfix/update-changelog' 2015-07-16 12:30:14 +03:00
26 changed files with 848 additions and 473 deletions

1
.gitignore vendored
View File

@@ -0,0 +1 @@
coverage/

View File

@@ -1,6 +1,8 @@
sudo: false sudo: false
cache: bundler
language: ruby language: ruby
before_install:
- gem update --system
- gem install bundler
rvm: rvm:
- 2.1.0 - 2.1.0
script: script:

View File

@@ -1,7 +1,105 @@
# Change Log # Change Log
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16) ## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
**Implemented enhancements:**
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
**Merged pull requests:**
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
**Implemented enhancements:**
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
**Merged pull requests:**
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
**Fixed bugs:**
- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
**Merged pull requests:**
- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
**Closed issues:**
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
**Merged pull requests:**
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
**Implemented enhancements:**
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
**Merged pull requests:**
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
**Implemented enhancements:**
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
**Merged pull requests:**
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
**Implemented enhancements:**
- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
**Fixed bugs:** **Fixed bugs:**
@@ -9,7 +107,6 @@
- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250) - --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12) ## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
**Implemented enhancements:** **Implemented enhancements:**
@@ -21,33 +118,26 @@
- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249) - not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11) ## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
**Implemented enhancements:** **Implemented enhancements:**
- Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240) - Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54) - Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
**Fixed bugs:** **Fixed bugs:**
- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246) - --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245) - Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26) ## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
**Implemented enhancements:** **Implemented enhancements:**
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228) - Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214) - Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172) - Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53) - Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
**Merged pull requests:** **Merged pull requests:**
@@ -55,7 +145,6 @@
- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder)) - Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19) ## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
**Implemented enhancements:** **Implemented enhancements:**
@@ -65,28 +154,23 @@
**Fixed bugs:** **Fixed bugs:**
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237) - github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235) - Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69) - Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
**Merged pull requests:** **Merged pull requests:**
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder)) - Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder)) - Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur)) - Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07) ## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
**Implemented enhancements:** **Implemented enhancements:**
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212) - Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208) - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
**Closed issues:** **Closed issues:**
@@ -95,21 +179,13 @@
**Merged pull requests:** **Merged pull requests:**
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder)) - Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder)) - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder)) - Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn)) - Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal)) - Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal)) - Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21) ## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
**Merged pull requests:** **Merged pull requests:**
@@ -117,35 +193,30 @@
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder)) - Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18) ## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
**Merged pull requests:** **Fixed bugs:**
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder)) - Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06) ## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
**Implemented enhancements:** **Implemented enhancements:**
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63) - Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
**Merged pull requests:** **Fixed bugs:**
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder)) - Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05) ## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05) ## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04) ## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
**Fixed bugs:** **Fixed bugs:**
@@ -153,7 +224,6 @@
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60) - Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03) ## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
**Fixed bugs:** **Fixed bugs:**
@@ -161,7 +231,6 @@
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59) - --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03) ## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
**Closed issues:** **Closed issues:**
@@ -169,7 +238,6 @@
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58) - Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03) ## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
**Fixed bugs:** **Fixed bugs:**
@@ -177,21 +245,16 @@
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57) - generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27) ## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26) ## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
**Implemented enhancements:** **Implemented enhancements:**
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55) - Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52) - Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47) - Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31) - Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
**Fixed bugs:** **Fixed bugs:**
@@ -203,7 +266,6 @@
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder)) - Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17) ## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8)
**Closed issues:** **Closed issues:**
@@ -213,19 +275,16 @@
**Merged pull requests:** **Merged pull requests:**
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder)) - Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder)) - Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26) ## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
**Merged pull requests:** **Implemented enhancements:**
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445)) - 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) (2015-01-21) ## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
**Merged pull requests:** **Merged pull requests:**
@@ -233,41 +292,32 @@
- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao)) - 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) (2015-01-15) ## [1.2.5](https://github.com/skywinder/github-changelog-generator/tree/1.2.5) (2015-01-15)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5)
**Implemented enhancements:** **Implemented enhancements:**
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22) - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
**Fixed bugs:** **Fixed bugs:**
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32) - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
**Merged pull requests:**
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing)) - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16) ## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
**Fixed bugs:** **Fixed bugs:**
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41) - Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35) - 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) (2014-12-16) ## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
**Implemented enhancements:** **Implemented enhancements:**
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38) - Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33) - Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
**Fixed bugs:** **Fixed bugs:**
@@ -277,11 +327,9 @@
**Merged pull requests:** **Merged pull requests:**
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder)) - Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder)) - Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10) ## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
**Fixed bugs:** **Fixed bugs:**
@@ -293,7 +341,6 @@
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef)) - Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22) ## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
**Fixed bugs:** **Fixed bugs:**
@@ -303,23 +350,18 @@
**Merged pull requests:** **Merged pull requests:**
- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder)) - Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder)) - Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19) ## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
**Merged pull requests:** **Merged pull requests:**
- 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)) - 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))
- 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)) - 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))
- 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)) - 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) (2014-11-18) ## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
**Implemented enhancements:** **Implemented enhancements:**
@@ -331,29 +373,23 @@
- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder)) - Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12) ## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
**Merged pull requests:** **Merged pull requests:**
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder)) - Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder)) - 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) (2014-11-10) ## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
**Merged pull requests:** **Merged pull requests:**
- 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)) - 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))
- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder)) - Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
- 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)) - 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) (2014-11-10) ## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
**Implemented enhancements:** **Implemented enhancements:**
@@ -363,22 +399,19 @@
**Fixed bugs:** **Fixed bugs:**
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12) - Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9) - Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10) ## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07) ## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0)
**Implemented enhancements:** **Implemented enhancements:**
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6) - Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4) - Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
**Fixed bugs:** **Fixed bugs:**
@@ -386,28 +419,21 @@
**Merged pull requests:** **Merged pull requests:**
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder)) - Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07) ## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
**Merged pull requests:** **Merged pull requests:**
- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder)) - Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder)) - Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
- 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)) - 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) (2014-11-06) ## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2) [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06) ## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

@@ -1,62 +1,59 @@
PATH PATH
remote: . remote: .
specs: specs:
github_changelog_generator (1.6.2) github_changelog_generator (1.10.0)
colorize (~> 0.7) colorize (~> 0.7)
github_api (~> 0.12) github_api (~> 0.12)
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
addressable (2.3.8) addressable (2.4.0)
ast (2.0.0) ast (2.2.0)
astrolabe (1.3.1) astrolabe (1.3.1)
parser (~> 2.2) parser (~> 2.2)
codeclimate-test-reporter (0.4.7) codeclimate-test-reporter (0.4.8)
simplecov (>= 0.7.1, < 1.0.0) simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.7) colorize (0.7.7)
coveralls (0.8.2) coveralls (0.8.10)
json (~> 1.8) json (~> 1.8)
rest-client (>= 1.6.8, < 2) rest-client (>= 1.6.8, < 2)
simplecov (~> 0.10.0) simplecov (~> 0.11.0)
term-ansicolor (~> 1.3) term-ansicolor (~> 1.3)
thor (~> 0.19.1) thor (~> 0.19.1)
tins (~> 1.6.0)
descendants_tracker (0.0.4) descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1) thread_safe (~> 0.3, >= 0.3.1)
diff-lcs (1.2.5) diff-lcs (1.2.5)
docile (1.1.5) docile (1.1.5)
domain_name (0.5.24) domain_name (0.5.25)
unf (>= 0.0.5, < 1.0.0) unf (>= 0.0.5, < 1.0.0)
faraday (0.9.1) faraday (0.9.2)
multipart-post (>= 1.2, < 3) multipart-post (>= 1.2, < 3)
github_api (0.12.3) github_api (0.13.1)
addressable (~> 2.3) addressable (~> 2.4.0)
descendants_tracker (~> 0.0.4) descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10) faraday (~> 0.8, < 0.10)
hashie (>= 3.3) hashie (>= 3.4)
multi_json (>= 1.7.5, < 2.0) multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.3)
oauth2 oauth2
hashie (3.4.2) hashie (3.4.3)
http-cookie (1.0.2) http-cookie (1.0.2)
domain_name (~> 0.5) domain_name (~> 0.5)
json (1.8.3) json (1.8.3)
jwt (1.5.1) jwt (1.5.2)
mime-types (2.6.1) mime-types (2.99)
mini_portile (0.6.2)
multi_json (1.11.2) multi_json (1.11.2)
multi_xml (0.5.5) multi_xml (0.5.5)
multipart-post (2.0.0) multipart-post (2.0.0)
netrc (0.10.3) netrc (0.11.0)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
oauth2 (1.0.0) oauth2 (1.0.0)
faraday (>= 0.8, < 0.10) faraday (>= 0.8, < 0.10)
jwt (~> 1.0) jwt (~> 1.0)
multi_json (~> 1.3) multi_json (~> 1.3)
multi_xml (~> 0.5) multi_xml (~> 0.5)
rack (~> 1.2) rack (~> 1.2)
parser (2.2.2.6) parser (2.2.3.0)
ast (>= 1.1, < 3.0) ast (>= 1.1, < 3.0)
powerpack (0.1.1) powerpack (0.1.1)
rack (1.6.4) rack (1.6.4)
@@ -66,27 +63,28 @@ GEM
http-cookie (>= 1.0.2, < 2.0) http-cookie (>= 1.0.2, < 2.0)
mime-types (>= 1.16, < 3.0) mime-types (>= 1.16, < 3.0)
netrc (~> 0.7) netrc (~> 0.7)
rspec (3.3.0) rspec (3.4.0)
rspec-core (~> 3.3.0) rspec-core (~> 3.4.0)
rspec-expectations (~> 3.3.0) rspec-expectations (~> 3.4.0)
rspec-mocks (~> 3.3.0) rspec-mocks (~> 3.4.0)
rspec-core (3.3.2) rspec-core (3.4.1)
rspec-support (~> 3.3.0) rspec-support (~> 3.4.0)
rspec-expectations (3.3.1) rspec-expectations (3.4.0)
diff-lcs (>= 1.2.0, < 2.0) diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.3.0) rspec-support (~> 3.4.0)
rspec-mocks (3.3.2) rspec-mocks (3.4.0)
diff-lcs (>= 1.2.0, < 2.0) diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.3.0) rspec-support (~> 3.4.0)
rspec-support (3.3.0) rspec-support (3.4.1)
rubocop (0.32.1) rubocop (0.35.1)
astrolabe (~> 1.3) astrolabe (~> 1.3)
parser (>= 2.2.2.5, < 3.0) parser (>= 2.2.3.0, < 3.0)
powerpack (~> 0.1) powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0) rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.4) ruby-progressbar (~> 1.7)
tins (<= 1.6.0)
ruby-progressbar (1.7.5) ruby-progressbar (1.7.5)
simplecov (0.10.0) simplecov (0.11.1)
docile (~> 1.1.0) docile (~> 1.1.0)
json (~> 1.8) json (~> 1.8)
simplecov-html (~> 0.10.0) simplecov-html (~> 0.10.0)
@@ -95,7 +93,7 @@ GEM
tins (~> 1.0) tins (~> 1.0)
thor (0.19.1) thor (0.19.1)
thread_safe (0.3.5) thread_safe (0.3.5)
tins (1.5.4) tins (1.6.0)
unf (0.1.4) unf (0.1.4)
unf_ext unf_ext
unf_ext (0.0.7.1) unf_ext (0.0.7.1)
@@ -112,3 +110,6 @@ DEPENDENCIES
rspec (~> 3.2) rspec (~> 3.2)
rubocop (~> 0.31) rubocop (~> 0.31)
simplecov (~> 0.10) simplecov (~> 0.10)
BUNDLED WITH
1.10.6

420
README.md
View File

@@ -1,194 +1,228 @@
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator) [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator) [![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator) [![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator) [![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator) [![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator) [![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg) GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
================== ==================
- [Installation](#installation) - [Installation](#installation)
- [Output example](#output-example) - [Output example](#output-example)
- [Usage](#usage) - [Usage](#usage)
- [Params](#params) - [Params](#params)
- [GitHub token](#github-token) - [GitHub token](#github-token)
- [Features and advantages of this project](#features-and-advantages-of-this-project) - [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives) - [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library) - [Projects using this library](#projects-using-this-library)
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature) - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [License](#license)
### Changelog generation has never been so easy: ### Changelog generation has never been so easy:
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker. **Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada: Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
>### *Whats the point of a change log?* >### *Whats the point of a change log?*
To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
### *Why should I care?* ### *Why should I care?*
Because software tools are for people. If you dont care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours. Because software tools are for people. If you dont care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)* > :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com/)*
## Installation ## Installation
[sudo] gem install github_changelog_generator [sudo] gem install github_changelog_generator
## Output example ## Output example
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project - 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: - [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 github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
- In general it looks like this: - In general it looks like this:
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15) > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
> >
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5) > [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
> >
> **Implemented enhancements:** > **Implemented enhancements:**
> >
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22) > - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
> >
> **Fixed bugs:** > **Fixed bugs:**
> >
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32) > - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
> >
> **Merged pull requests:** > **Merged pull requests:**
> >
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing)) > - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
> >
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett)) > - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## Usage ## Usage
**It's really simple**: **It's really simple**:
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run: - If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
github_changelog_generator github_changelog_generator
- or from anywhere: - or from anywhere:
- `github_changelog_generator -u github_username -p github_project` - `github_changelog_generator -u github_username -p github_project`
- `github_changelog_generator github_username/github_project` - `github_changelog_generator github_username/github_project`
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
### Params ### Params
Type `github_changelog_generator --help` for details. Type `github_changelog_generator --help` for details.
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples) More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
### GitHub token ### Params File
You can put Params in a .github_changelog_generator file in Project Root to override default params:
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
Example:
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**. ```
unreleased=false
And: future-release=5.0.0
since-tag=1.0.0
- Run with key `-t [your-16-digit-token]` ```
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
### GitHub token
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
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' And:
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP. - Run with key `-t [your-40-digit-token]`
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
##Features and advantages of this project
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem: i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory: export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
- Flexible format **customisation**:
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: So, if you got error like this:
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date: >! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
- 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 :pushpin:
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors: It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
- **Distinguish** issues **according labels**. :mag_right:
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows: ## Migrating from a manual changelog
- Bug fixes (by label `bug` in issue) :beetle:
- Enhancements (by label `enhancement` in issue) :star2: Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
- Issues (closed issues `w/o any labels`) :non-potable_water: but you most likely wouldn't like to have to open issues and PRs for all past features listed in your historic changelog.
- You can manually set which labels should be included/excluded. :wrench: That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*look `github_changelog_generator --help` for details)* If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
### Rake task
###Alternatives
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements. You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
*If you know other projects - feel free to edit this Wiki page!* ```ruby
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
config.since_tag = '0.1.14'
### Projects using this library config.future_release = '0.2.0'
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) end
```
All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
##Features and advantages of this project
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory:
- Flexible format **customisation**:
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
- 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 :pushpin:
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
- **Distinguish** issues **according labels**. :mag_right:
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
- Bug fixes (by label `bug` in issue) :beetle:
- Enhancements (by label `enhancement` in issue) :star2:
- Issues (closed issues `w/o any labels`) :non-potable_water:
- You can manually set which labels should be included/excluded. :wrench:
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*look `github_changelog_generator --help` for details)*
###Alternatives
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
*If you know other projects - feel free to edit this Wiki page!*
### Projects using this library
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it. If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.* *If you are using `github_changelog_generator` for generation change log in your project or know another 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 missing some essential feature? ## Am I missing some essential feature?
- **Nothing is impossible!** - **Nothing is impossible!**
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! - 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* :heavy_exclamation_mark: - *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
## FAQ ## FAQ
- ***I already use GitHub Releases. Why do I need this?*** - ***I already use GitHub Releases. Why do I need this?***
GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations: GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)* *BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
I'm not try to compare quality of auto-generated and manually generated logs.. but: I'm not try to compare quality of auto-generated and manually generated logs.. but:
The auto generated Changelog really helps even if you manually fill Releases notes! The auto generated Changelog really helps even if you manually fill Releases notes!
For example: For example:
When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`. When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
- it's not so quite easy to find it in manually filled Releases notes. - it's not so quite easy to find it in manually filled Releases notes.
- this file can also help you to build your Release note and not miss features in manually-filled list. - this file can also help you to build your Release note and not miss features in manually-filled list.
In the end: In the end:
I think, that GitHub Releases is more for end-users. I think, that GitHub Releases is more for end-users.
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes. But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner. And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
- ***I received a warning: GitHub API rate limit exceed, what does this mean?*** - ***I received a warning: GitHub API rate limit exceed, what does this mean?***
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests. GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
If you're seeing this warning: If you're seeing this warning:
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour. 1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000` 2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
## Contributing ## Contributing
1. Create an issue to discuss about your idea 1. Create an issue to discuss about your idea
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork) 2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
3. Create your feature branch (`git checkout -b my-new-feature`) 3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`) 4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`) 5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request 6. Create a new Pull Request
7. Profit! :white_check_mark: 7. Profit! :white_check_mark:
## License *To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT). ## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

View File

@@ -9,14 +9,14 @@ Gem::Specification.new do |spec|
spec.version = GitHubChangelogGenerator::VERSION spec.version = GitHubChangelogGenerator::VERSION
spec.default_executable = "github_changelog_generator" spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = ">= 1.9.3" spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev"] spec.authors = ["Petr Korolev"]
spec.email = "sky4winder+github_changelog_generator@gmail.com" spec.email = "sky4winder+github_changelog_generator@gmail.com"
spec.date = `date +"%Y-%m-%d"`.strip! spec.date = `date +"%Y-%m-%d"`.strip!
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests." spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker." spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator" spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
spec.license = "MIT" spec.license = "MIT"
spec.files = `git ls-files -z`.split("\x0") spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

View File

@@ -7,6 +7,7 @@
**Implemented enhancements:** **Implemented enhancements:**
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9) - Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
**Fixed bugs:** **Fixed bugs:**
@@ -21,6 +22,8 @@
**Merged pull requests:** **Merged pull requests:**
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder)) - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder)) - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))

View File

@@ -7,6 +7,7 @@ require "benchmark"
require_relative "github_changelog_generator/helper" require_relative "github_changelog_generator/helper"
require_relative "github_changelog_generator/parser" require_relative "github_changelog_generator/parser"
require_relative "github_changelog_generator/parser_file"
require_relative "github_changelog_generator/generator/generator" require_relative "github_changelog_generator/generator/generator"
require_relative "github_changelog_generator/version" require_relative "github_changelog_generator/version"
require_relative "github_changelog_generator/reader" require_relative "github_changelog_generator/reader"

View File

@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
@user = @options[:user] @user = @options[:user]
@project = @options[:project] @project = @options[:project]
@github_token = fetch_github_token @github_token = fetch_github_token
github_options = { per_page: PER_PAGE_NUMBER } @github_options = { per_page: PER_PAGE_NUMBER }
github_options[:oauth_token] = @github_token unless @github_token.nil? @github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil? @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil? @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
@github = check_github_response { Github.new github_options } @github = check_github_response { Github.new @github_options }
end end
# Returns GitHub token. First try to use variable, provided by --token option, # Returns GitHub token. First try to use variable, provided by --token option,
@@ -123,7 +123,16 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
def fetch_closed_pull_requests def fetch_closed_pull_requests
pull_requests = [] pull_requests = []
begin begin
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed" if @options[:release_branch].nil?
response = @github.pull_requests.list @options[:user],
@options[:project],
state: "closed"
else
response = @github.pull_requests.list @options[:user],
@options[:project],
state: "closed",
base: @options[:release_branch]
end
page_i = 0 page_i = 0
count_pages = response.count_pages count_pages = response.count_pages
response.each_page do |page| response.each_page do |page|
@@ -163,10 +172,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
issues_slice.each do |issue| issues_slice.each do |issue|
threads << Thread.new do threads << Thread.new do
begin begin
obj = @github.issues.events.list user: @options[:user], response = @github.issues.events.list user: @options[:user],
repo: @options[:project], repo: @options[:project],
issue_number: issue["number"] issue_number: issue["number"]
issue[:events] = obj.body issue[:events] = []
response.each_page do |page|
issue[:events].concat(page)
end
rescue rescue
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end end

View File

@@ -66,7 +66,7 @@ module GitHubChangelogGenerator
if @options[:issues] if @options[:issues]
# Generate issues: # Generate issues:
log += issues_to_log(issues) log += issues_to_log(issues, pull_requests)
end end
if @options[:pulls] if @options[:pulls]
@@ -77,13 +77,14 @@ module GitHubChangelogGenerator
log log
end end
# Generate ready-to-paste log from list of issues. # Generate ready-to-paste log from list of issues and pull requests.
# #
# @param [Array] issues # @param [Array] issues
# @param [Array] pull_requests
# @return [String] generated log for issues # @return [String] generated log for issues
def issues_to_log(issues) def issues_to_log(issues, pull_requests)
log = "" log = ""
bugs_a, enhancement_a, issues_a = parse_by_sections(issues) bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix]) log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
log += generate_sub_section(bugs_a, @options[:bug_prefix]) log += generate_sub_section(bugs_a, @options[:bug_prefix])
@@ -95,8 +96,9 @@ module GitHubChangelogGenerator
# (bugs, features, or just closed issues) by labels # (bugs, features, or just closed issues) by labels
# #
# @param [Array] issues # @param [Array] issues
# @param [Array] pull_requests
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues) # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
def parse_by_sections(issues) def parse_by_sections(issues, pull_requests)
issues_a = [] issues_a = []
enhancement_a = [] enhancement_a = []
bugs_a = [] bugs_a = []
@@ -117,6 +119,24 @@ module GitHubChangelogGenerator
end end
issues_a.push dict unless added issues_a.push dict unless added
end end
added_pull_requests = []
pull_requests.each do |dict|
dict.labels.each do |label|
if @options[:bug_labels].include? label.name
bugs_a.push dict
added_pull_requests.push dict
next
end
if @options[:enhancement_labels].include? label.name
enhancement_a.push dict
added_pull_requests.push dict
next
end
end
end
added_pull_requests.each { |p| pull_requests.delete(p) }
[bugs_a, enhancement_a, issues_a] [bugs_a, enhancement_a, issues_a]
end end
end end

View File

@@ -48,11 +48,11 @@ module GitHubChangelogGenerator
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit. # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
# @param [Hash] issue # @param [Hash] issue
def find_closed_date_by_commit(issue) def find_closed_date_by_commit(issue)
unless issue["events"].nil? unless issue[:events].nil?
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
compare_string = issue[:merged_at].nil? ? "closed" : "merged" compare_string = issue[:merged_at].nil? ? "closed" : "merged"
# reverse! - to find latest closed event. (event goes in date order) # reverse! - to find latest closed event. (event goes in date order)
issue["events"].reverse!.each do |event| issue[:events].reverse!.each do |event|
if event[:event].eql? compare_string if event[:event].eql? compare_string
set_date_from_event(event, issue) set_date_from_event(event, issue)
break break

View File

@@ -16,6 +16,8 @@ module GitHubChangelogGenerator
log += generate_log_for_all_tags log += generate_log_for_all_tags
end end
log += File.read(@options[:base]) if File.file?(@options[:base])
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*" log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
@log = log @log = log
end end
@@ -49,9 +51,8 @@ module GitHubChangelogGenerator
def generate_sub_section(issues, prefix) def generate_sub_section(issues, prefix)
log = "" log = ""
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
if issues.any? if issues.any?
log += "#{prefix}\n\n" unless options[:simple_list]
issues.each do |issue| issues.each do |issue|
merge_string = get_string_for_issue(issue) merge_string = get_string_for_issue(issue)
log += "- #{merge_string}\n" log += "- #{merge_string}\n"
@@ -76,10 +77,15 @@ module GitHubChangelogGenerator
time_string = newer_tag_time.strftime @options[:date_format] time_string = newer_tag_time.strftime @options[:date_format]
# Generate tag name and link # Generate tag name and link
if newer_tag_name.equal? @options[:unreleased_label] if @options[:release_url]
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n" release_url = format(@options[:release_url], newer_tag_link)
else else
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n" release_url = "#{project_url}/tree/#{newer_tag_link}"
end
if newer_tag_name.equal? @options[:unreleased_label]
log += "## [#{newer_tag_name}](#{release_url})\n\n"
else
log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
end end
if @options[:compare_link] && older_tag_link if @options[:compare_link] && older_tag_link
@@ -96,7 +102,7 @@ module GitHubChangelogGenerator
def generate_log_between_tags(older_tag, newer_tag) def generate_log_between_tags(older_tag, newer_tag)
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag) filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
older_tag_name = older_tag.nil? ? nil : older_tag["name"] older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty? if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
# do not generate empty unreleased section # do not generate empty unreleased section

View File

@@ -63,21 +63,21 @@ module GitHubChangelogGenerator
end end
# Method filter issues, that belong only specified tag range # Method filter issues, that belong only specified tag range
# @param [Array] array of issues to filter # @param [Array] issues issues to filter
# @param [Symbol] hash_key key of date value default is :actual_date # @param [Symbol] hash_key key of date value default is :actual_date
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
# @return [Array] filtered issues # @return [Array] filtered issues
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil) def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
# in case if not tags specified - return unchanged array # in case if not tags specified - return unchanged array
return array if older_tag.nil? && newer_tag.nil? return issues if older_tag.nil? && newer_tag.nil?
newer_tag_time = newer_tag && get_time_of_tag(newer_tag) newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
older_tag_time = older_tag && get_time_of_tag(older_tag) older_tag_time = older_tag && get_time_of_tag(older_tag)
array.select do |req| issues.select do |issue|
if req[hash_key] if issue[hash_key]
time = Time.parse(req[hash_key]).utc time = Time.parse(issue[hash_key]).utc
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time) tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
@@ -178,8 +178,10 @@ module GitHubChangelogGenerator
fetched_pr = closed_pull_requests.find do |fpr| fetched_pr = closed_pull_requests.find do |fpr|
fpr.number == pr.number fpr.number == pr.number
end end
pr[:merged_at] = fetched_pr[:merged_at] if fetched_pr
closed_pull_requests.delete(fetched_pr) pr[:merged_at] = fetched_pr[:merged_at]
closed_pull_requests.delete(fetched_pr)
end
end end
pull_requests.select! do |pr| pull_requests.select! do |pr|

View File

@@ -52,14 +52,69 @@ module GitHubChangelogGenerator
[newer_tag_link, newer_tag_name, newer_tag_time] [newer_tag_link, newer_tag_name, newer_tag_time]
end end
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
def detect_since_tag
@since_tag ||= @options[:since_tag]
if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
reader = GitHubChangelogGenerator::Reader.new
content = reader.read(@options[:base])
@since_tag = content[0]["version"] if content
end
@since_tag
end
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
# #
# @return [Array] # @return [Array]
def get_filtered_tags(all_tags) def get_filtered_tags(all_tags)
filtered_tags = filter_between_tags(all_tags) filtered_tags = filter_since_tag(all_tags)
filtered_tags = filter_between_tags(filtered_tags)
filter_excluded_tags(filtered_tags) filter_excluded_tags(filtered_tags)
end end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :since_tag option
def filter_since_tag(all_tags)
filtered_tags = all_tags
tag = detect_since_tag
if tag
if all_tags.map(&:name).include? tag
idx = all_tags.index { |t| t.name == tag }
if idx > 0
filtered_tags = all_tags[0..idx - 1]
else
filtered_tags = []
end
else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
end
end
filtered_tags
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :due_tag option
def filter_due_tag(all_tags)
filtered_tags = all_tags
tag = @options[:due_tag]
if tag
if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
idx = all_tags.index { |t| t.name == tag }
last_index = all_tags.count - 1
if idx > 0 && idx < last_index
filtered_tags = all_tags[idx + 1..last_index]
else
filtered_tags = []
end
else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
end
end
filtered_tags
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :between_tags option
def filter_between_tags(all_tags) def filter_between_tags(all_tags)
filtered_tags = all_tags filtered_tags = all_tags
if @options[:between_tags] if @options[:between_tags]
@@ -73,17 +128,48 @@ module GitHubChangelogGenerator
filtered_tags filtered_tags
end end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags option
def filter_excluded_tags(all_tags) def filter_excluded_tags(all_tags)
filtered_tags = all_tags return all_tags unless @options[:exclude_tags]
if @options[:exclude_tags]
@options[:exclude_tags].each do |tag| apply_exclude_tags(all_tags)
unless all_tags.map(&:name).include? tag end
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
end private
end
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name } def apply_exclude_tags(all_tags)
if @options[:exclude_tags].is_a?(Regexp)
filter_tags_with_regex(all_tags)
else
filter_exact_tags(all_tags)
end
end
def filter_tags_with_regex(all_tags)
warn_if_nonmatching_regex(all_tags)
all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
end
def filter_exact_tags(all_tags)
@options[:exclude_tags].each do |tag|
warn_if_tag_not_found(all_tags, tag)
end
all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
end
def warn_if_nonmatching_regex(all_tags)
unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
Helper.log.warn "Warning: unable to reject any tag, using regex "\
"#{@options[:exclude_tags].inspect} in --exclude-tags "\
"option."
end
end
def warn_if_tag_not_found(all_tags, tag)
unless all_tags.map(&:name).include? tag
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
end end
filtered_tags
end end
end end
end end

View File

@@ -7,30 +7,33 @@ module GitHubChangelogGenerator
class Parser class Parser
# parse options with optparse # parse options with optparse
def self.parse_options def self.parse_options
options = get_default_options options = default_options
ParserFile.new(options).parse!
parser = setup_parser(options) parser = setup_parser(options)
parser.parse! parser.parse!
if options[:user].nil? || options[:project].nil? user_and_project_from_git(options)
detect_user_and_project(options)
end
if !options[:user] || !options[:project] abort(parser.banner) unless options[:user] && options[:project]
puts parser.banner
exit
end
if options[:verbose] print_options(options)
Helper.log.info "Performing task with options:"
pp options
puts ""
end
options options
end end
# @param [Hash] options to display
def self.print_options(options)
if options[:verbose]
Helper.log.info "Performing task with options:"
options_to_display = options.clone
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
pp options_to_display
puts ""
end
end
# setup parsing options # setup parsing options
def self.setup_parser(options) def self.setup_parser(options)
parser = OptionParser.new do |opts| parser = OptionParser.new do |opts|
@@ -50,6 +53,9 @@ module GitHubChangelogGenerator
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last| opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
options[:output] = last options[:output] = last
end end
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
options[:base] = last
end
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v| opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
options[:bug_prefix] = v options[:bug_prefix] = v
end end
@@ -110,12 +116,21 @@ module GitHubChangelogGenerator
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list| opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
options[:between_tags] = list options[:between_tags] = list
end end
opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list| opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
options[:exclude_tags] = list options[:exclude_tags] = list
end end
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
options[:since_tag] = v
end
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
options[:due_tag] = v
end
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max| opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
options[:max_issues] = max options[:max_issues] = max
end end
opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
options[:release_url] = url
end
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last| opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
options[:github_site] = last options[:github_site] = last
end end
@@ -128,6 +143,9 @@ module GitHubChangelogGenerator
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release| opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
options[:future_release] = future_release options[:future_release] = future_release
end end
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
options[:release_branch] = release_branch
end
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v| opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
options[:verbose] = v options[:verbose] = v
end end
@@ -144,12 +162,13 @@ module GitHubChangelogGenerator
end end
# just get default options # just get default options
def self.get_default_options def self.default_options
options = { {
tag1: nil, tag1: nil,
tag2: nil, tag2: nil,
date_format: "%Y-%m-%d", date_format: "%Y-%m-%d",
output: "CHANGELOG.md", output: "CHANGELOG.md",
base: "HISTORY.md",
issues: true, issues: true,
add_issues_wo_labels: true, add_issues_wo_labels: true,
add_pr_wo_labels: true, add_pr_wo_labels: true,
@@ -172,21 +191,25 @@ module GitHubChangelogGenerator
enhancement_prefix: "**Implemented enhancements:**", enhancement_prefix: "**Implemented enhancements:**",
git_remote: "origin" git_remote: "origin"
} }
end
options def self.user_and_project_from_git(options)
if options[:user].nil? || options[:project].nil?
detect_user_and_project(options, ARGV[0], ARGV[1])
end
end end
# Detects user and project from git # Detects user and project from git
def self.detect_user_and_project(options) def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site]) options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
if !options[:user] || !options[:project] return if options[:user] && options[:project]
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:user] = "skywinder" if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:project] = "changelog_test" options[:user] = "skywinder"
else options[:project] = "changelog_test"
remote = `git config --get remote.#{options[:git_remote]}.url` else
options[:user], options[:project] = user_project_from_remote(remote) remote = `git config --get remote.#{options[:git_remote]}.url`
end options[:user], options[:project] = user_project_from_remote(remote)
end end
end end
@@ -194,7 +217,7 @@ module GitHubChangelogGenerator
# #
# @param [String] output of git remote command # @param [String] output of git remote command
# @return [Array] user and project # @return [Array] user and project
def self.user_project_from_option(arg0, arg1, github_site = nil) def self.user_project_from_option(arg0, arg1, github_site)
user = nil user = nil
project = nil project = nil
github_site ||= "github.com" github_site ||= "github.com"
@@ -207,10 +230,10 @@ module GitHubChangelogGenerator
param = match[2].nil? param = match[2].nil?
rescue rescue
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'" puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
exit return
end end
if param if param
exit return
else else
user = match[1] user = match[1]
project = match[2] project = match[2]
@@ -253,9 +276,4 @@ module GitHubChangelogGenerator
[user, project] [user, project]
end end
end end
if __FILE__ == $PROGRAM_NAME
remote = "invalid reference to project"
p user_project_from_option(ARGV[0], ARGV[1], remote)
end
end end

View File

@@ -0,0 +1,39 @@
module GitHubChangelogGenerator
ParserError = Class.new(StandardError)
class ParserFile
def initialize(options)
@options = options
end
def parse!
return unless File.exist?(file)
File.readlines(file).each { |line| parse_line!(line) }
end
private
def file
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
end
def parse_line!(line)
key_sym, value = extract_pair(line)
value = true if value =~ (/^(true|t|yes|y|1)$/i)
value = false if value =~ (/^(false|f|no|n|0)$/i)
@options[key_sym] = value
rescue
raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
end
# Returns a the setting as a symbol and its string value sans newlines.
#
# @param line [String] unparsed line from config file
# @return [Array<Symbol, String>]
def extract_pair(line)
key, value = line.split("=", 2)
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end
end
end

View File

@@ -53,31 +53,28 @@ module GitHubChangelogGenerator
@heading_structures.each do |regexp| @heading_structures.each do |regexp|
matches = Regexp.new(regexp).match(heading) matches = Regexp.new(regexp).match(heading)
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil? if matches
captures.merge!(Hash[matches.names.zip(matches.captures)])
# Try Regular Expressions until you find one that delivers results break
break unless matches.nil? end
end end
captures captures
end end
# Parse the given ChangeLog data into a Hash # Parse the given ChangeLog data into a list of Hashes
# #
# @param [String] data File data from the ChangeLog.md # @param [String] data File data from the ChangeLog.md
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...] # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
def parse(data) def parse(data)
sections = data.split(/^## .+?$/) sections = data.split(/^## .+?$/)
headings = data.scan(/^## .+?$/) headings = data.scan(/^## .+?$/)
changelog = []
headings.each_with_index do |heading, index| headings.each_with_index.map do |heading, index|
captures = parse_heading(heading) section = parse_heading(heading)
captures["content"] = sections.at(index + 1) section["content"] = sections.at(index + 1)
changelog.push captures section
end end
changelog
end end
def read(file_path) def read(file_path)

View File

@@ -0,0 +1,67 @@
require "rake"
require "rake/tasklib"
require "github_changelog_generator"
module GitHubChangelogGenerator
class RakeTask < ::Rake::TaskLib
include ::Rake::DSL if defined?(::Rake::DSL)
OPTIONS = %w( user project token date_format output
bug_prefix enhancement_prefix issue_prefix
header merge_prefix issues
add_issues_wo_labels add_pr_wo_labels
pulls filter_issues_by_milestone author
unreleased_only unreleased unreleased_label
compare_link include_labels exclude_labels
bug_labels enhancement_labels
between_tags exclude_tags since_tag max_issues
github_site github_endpoint simple_list
future_release release_branch verbose release_url
base )
OPTIONS.each do |o|
attr_accessor o.to_sym
end
# Public: Initialise a new GitHubChangelogGenerator::RakeTask.
#
# Example
#
# GitHubChangelogGenerator::RakeTask.new
def initialize(*args, &task_block)
@name = args.shift || :changelog
define(args, &task_block)
end
def define(args, &task_block)
desc "Generate a Change log from GitHub"
task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
# clear any (auto-)pre-existing task
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
task @name do
# mimick parse_options
options = Parser.default_options
Parser.user_and_project_from_git(options)
OPTIONS.each do |o|
v = instance_variable_get("@#{o}")
options[o.to_sym] = v unless v.nil?
end
generator = Generator.new options
log = generator.compound_changelog
output_filename = "#{options[:output]}"
File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!"
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
end
end
end
end

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
VERSION = "1.6.2" VERSION = "1.10.1"
end end

View File

View File

@@ -0,0 +1,2 @@
unreleased_label: staging
unreleased: false

View File

@@ -0,0 +1,3 @@
unreleased_label=staging
unreleased=false
header==== Changelog ===

View File

@@ -31,91 +31,25 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
SimpleCov.start SimpleCov.start
require "github_changelog_generator" require "github_changelog_generator"
require "github_changelog_generator/task"
# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# The `.rspec` file also contains a few flags that are not defaults but that
# users commonly want.
#
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config| RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations| config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end end
# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks| config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true mocks.verify_partial_doubles = true
end end
# These two settings work together to allow you to limit a spec run
# to individual examples or groups you care about by tagging them with
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
# get run.
config.filter_run :focus config.filter_run :focus
config.run_all_when_everything_filtered = true config.run_all_when_everything_filtered = true
# Limits the available syntax to the non-monkey patched syntax that is
# recommended. For more details, see:
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
# - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
# config.disable_monkey_patching!
# This setting enables warnings. It's recommended, but in some cases may
# be too noisy due to issues in dependencies.
config.warnings = true config.warnings = true
# Many RSpec users commonly either run the entire suite or an individual config.default_formatter = "doc" if config.files_to_run.one?
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = "doc"
end
# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
# config.profile_examples = 10
# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random config.order = :random
# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed Kernel.srand config.seed
end end

View File

@@ -87,6 +87,86 @@ describe GitHubChangelogGenerator::Generator do
it { is_expected.to be_a Array } it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) } it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end end
context "with regex exclude_tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
end
context "with non-matching regex in exclude_tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end
describe "#filter_since_tag" do
context "with filled array" do
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
end
context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end
context "with empty array" do
subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
end
context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
end
end
end
describe "#filter_due_tag" do
context "with filled array" do
subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
end
context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
end
end
context "with empty array" do
subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
end
context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
end
end
end end
describe "#get_time_of_tag" do describe "#get_time_of_tag" do

View File

@@ -0,0 +1,41 @@
describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do
context "when no has file" do
let(:options) { {} }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parse.parse! }
it { is_expected.to be_nil }
end
context "when file is empty" do
let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it "does not change the options" do
expect { parse.parse! }.to_not change { options }
end
end
context "when file is incorrect" do
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
end
context "when override default values" do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it "changes the options" do
expect { parse.parse! }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(unreleased_label: "staging",
unreleased: false,
header: "=== Changelog ==="))
end
end
end
end

View File

@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
end end
describe ".user_project_from_option" do describe ".user_project_from_option" do
context "when option is invalid" do context "when option is invalid" do
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) } it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
end end
context "when option is valid" do context "when option is valid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) } subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
it { is_expected.to be_a(Array) } it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) } it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end end
context "when option nil" do context "when option nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) } subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
it { is_expected.to be_a(Array) } it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) } it { is_expected.to match_array([nil, nil]) }
end end