Compare commits

...

187 Commits

Author SHA1 Message Date
Petr Korolev
e864abd623 Merge branch 'release/1.4.0' 2015-05-07 17:14:30 +03:00
Petr Korolev
6710078766 Update gemspec to version 1.4.0 2015-05-07 17:14:25 +03:00
Petr Korolev
f0736e67a5 update readme 2015-05-07 17:14:15 +03:00
Petr Korolev
784bd50a8f Fix #232 2015-05-07 17:14:14 +03:00
Petr Korolev
a9eabfc38b update readme 2015-05-07 11:57:14 +03:00
Petr Korolev
8123b3e2fa Fix #232 2015-05-06 20:07:10 +03:00
Petr Korolev
2b148f2e69 Merge branch 'develop' 2015-04-22 12:28:43 +03:00
Petr Korolev
6a7dbeb450 Merge branch 'feature/fetcher' into develop 2015-04-22 12:28:10 +03:00
Petr Korolev
8aa5d524b7 Merge branch 'master' into develop 2015-04-22 12:27:47 +03:00
Petr Korolev
0a35113a88 rubocop fixes 2015-04-22 00:33:50 +03:00
Petr Korolev
79a84a14f4 add logger 2015-04-22 00:26:28 +03:00
Petr Korolev
6d8dbd16ad fix long lines (>80) 2015-04-22 00:00:57 +03:00
Petr Korolev
cf8df992c5 Merge branch 'develop' into feature/fetcher 2015-04-21 23:53:56 +03:00
Petr Korolev
b620ad0d1b add hound yml 2015-04-21 23:53:40 +03:00
Petr Korolev
b7980c8900 rubocop autofixes 2015-04-21 23:37:03 +03:00
Petr Korolev
e27fe24a76 refactoring 2015-04-21 23:32:52 +03:00
Petr Korolev
088c98d0bf move methods 2015-04-21 20:42:33 +03:00
Petr Korolev
9ab84ac181 Merge branch 'master' into feature/fetcher 2015-04-04 03:41:09 +03:00
Petr Korolev
f04d581dbc Merge branch 'develop' 2015-04-04 03:40:58 +03:00
Petr Korolev
911b91c0ab add docs. add fail statment 2015-04-04 03:40:48 +03:00
Petr Korolev
26e202d7f0 add documentation 2015-04-04 03:37:31 +03:00
Petr Korolev
c2e5118cc9 Merge branch 'develop' 2015-04-04 03:31:04 +03:00
Petr Korolev
b598bd5ba1 add docs. add fail statment 2015-04-04 03:30:35 +03:00
Petr Korolev
1673677df0 add docs. add fail statment 2015-04-04 03:27:05 +03:00
Petr Korolev
c44be45ce4 add doc fix bug with filtering in case of nil issues 2015-04-04 03:18:12 +03:00
Petr Korolev
177b7aa18f code cleanup. remove code duplication 2015-04-04 03:10:16 +03:00
Petr Korolev
e495b58682 Merge branch 'develop' into feature/fetcher
Conflicts:
	.rubocop_todo.yml
	lib/github_changelog_generator.rb
2015-04-04 02:31:44 +03:00
Petr Korolev
e82a75611c refactoring 2015-04-04 02:30:02 +03:00
Petr Korolev
38576e23e3 update changelog
set default debug repo
add documentation
2015-04-04 02:23:30 +03:00
Petr Korolev
79d228c7a0 cleanup 2015-04-04 00:25:14 +03:00
Petr Korolev
e1161f9d90 code cleanup. remove duplicate code 2015-04-04 00:22:40 +03:00
Petr Korolev
31c5ac4c55 Merge branch 'feature/custom-error' into develop 2015-04-04 00:11:38 +03:00
Petr Korolev
dae68ee3b5 rubocop fixes 2015-04-04 00:08:00 +03:00
Petr Korolev
2b656c83b6 add doc + fix raise 2015-04-03 19:13:50 +03:00
Petr Korolev
4e9ed5df28 add error class and documentation 2015-04-03 18:59:37 +03:00
Petr Korolev
47bba9d384 update rubocop 2015-04-03 18:41:39 +03:00
Petr Korolev
ce7f35777b Merge branch 'develop' into feature/fetcher
Conflicts:
	lib/github_changelog_generator.rb
2015-04-03 18:40:11 +03:00
Petr Korolev
115762af82 Merge branch 'master' into develop 2015-04-03 18:37:15 +03:00
Petr Korolev
a50ad5b5c9 Merge branch 'develop' 2015-04-02 12:07:35 +03:00
Petr Korolev
da60c73502 Go with souble quotes. (See https://github.com/skywinder/github-changelog-generator/pull/220#discussion_r27262657 ) 2015-04-02 12:05:26 +03:00
Petr Korolev
b5d073c0af Merge branch 'develop' into feature/fetcher 2015-04-01 14:17:14 +03:00
Petr Korolev
6fcd0c95ed update readme 2015-03-29 23:03:32 +03:00
Petr Korolev
5c66591d71 Merge branch 'develop' 2015-03-29 22:44:58 +03:00
Petr Korolev
77941049e6 Merge branch 'feature/codeclimate-test-reporter-intergration' into develop 2015-03-29 22:44:48 +03:00
Petr Korolev
ca334b430c Merge branch 'master' into develop 2015-03-29 22:42:52 +03:00
Petr Korolev
1498790a78 fix codeclimate token 2015-03-29 22:38:18 +03:00
Petr Korolev
55001f48c2 rubocop fix 2015-03-29 22:32:03 +03:00
Petr Korolev
643b266679 add codeclimate encrypted token 2015-03-29 22:31:24 +03:00
Petr Korolev
2590883c3a Add codeclimate-test-reporter integration 2015-03-29 21:47:39 +03:00
Petr Korolev
4b0642cc6d Merge branch 'feature/simplecov-intergration' into develop 2015-03-29 21:47:16 +03:00
Petr Korolev
f9a58ae079 use with coveralls together 2015-03-29 21:31:25 +03:00
Petr Korolev
731e9904f5 replace to simplecov 2015-03-29 21:22:03 +03:00
Petr Korolev
fff7402621 add gem 2015-03-29 21:18:56 +03:00
Petr Korolev
51755cbe34 update 2015-03-27 17:17:23 +02:00
Petr Korolev
d361baaec5 add documentation 2015-03-27 17:15:08 +02:00
Petr Korolev
ae0d1d16de Fix missed sub-section headers and add documentation 2015-03-27 17:06:09 +02:00
Petr Korolev
c8584a1749 add documentation 2015-03-27 16:48:13 +02:00
Petr Korolev
7c29f3ddd2 move @github to fetcher
Conflicts:
	lib/github_changelog_generator.rb
2015-03-27 16:29:47 +02:00
Petr Korolev
a2cf6810ad add fetcher class 2015-03-27 16:25:57 +02:00
Petr Korolev
629a08b890 Merge branch 'develop' 2015-03-27 16:11:02 +02:00
Petr Korolev
e0cf47e027 coveralls integration 2015-03-27 16:04:35 +02:00
Petr Korolev
4f9bb03265 add gem version to readme 2015-03-27 15:59:03 +02:00
Petr Korolev
46d6b72d45 Merge branch 'master' into develop 2015-03-27 15:55:54 +02:00
Petr Korolev
8b5ea42e0d update gem.lock 2015-03-27 15:54:30 +02:00
Petr Korolev
2456db0847 Merge branch 'hotfix/fix-travis' into develop 2015-03-27 15:54:04 +02:00
Petr Korolev
9010c93dea Merge branch 'hotfix/fix-travis'
Conflicts:
	Gemfile.lock
2015-03-27 15:53:55 +02:00
Petr Korolev
42c1152c8b update bundle 2015-03-27 15:08:47 +02:00
Petr Korolev
6f1fa05c86 remove exclide 2015-03-27 15:02:45 +02:00
Petr Korolev
19ee2c3968 Merge branch 'master' into develop 2015-03-27 11:12:34 +02:00
Petr Korolev
c51d3ef4d0 Revert "add coveralls to gemfile and add bin folder to git"
This reverts commit 6350cdf39c.

Conflicts:
	Gemfile
2015-03-27 04:02:06 +02:00
Petr Korolev
397126c645 Revert "add coveralls yml and add it to spec_helper"
This reverts commit 48c2f26645.
2015-03-27 04:01:23 +02:00
Petr Korolev
b2e3f6a2c5 Revert "move coveralls file to root"
This reverts commit 570c1c11e8.
2015-03-27 04:01:07 +02:00
Petr Korolev
eeb92f6ae6 Revert "add codeclimate"
This reverts commit 765d995b6d.
2015-03-27 03:59:53 +02:00
Petr Korolev
c564c9018b fix deprecated syntax 2015-03-27 03:54:41 +02:00
Petr Korolev
e7aa1a2042 fix rubocop yml 2015-03-27 03:52:49 +02:00
Petr Korolev
765d995b6d add codeclimate 2015-03-27 03:47:34 +02:00
Petr Korolev
420db358bc add code climate to gemfile 2015-03-27 03:43:53 +02:00
Petr Korolev
f7c7992a1d update rubocop file 2015-03-27 03:06:41 +02:00
Petr Korolev
591927ef6c Merge branch 'develop' 2015-03-27 03:00:28 +02:00
Petr Korolev
570c1c11e8 move coveralls file to root 2015-03-27 02:56:45 +02:00
Petr Korolev
8de0b330d0 Merge pull request #220 from tuexss/cleanup
Cleanup
2015-03-27 02:25:18 +02:00
Petr Korolev
48c2f26645 add coveralls yml and add it to spec_helper 2015-03-27 01:53:42 +02:00
tuexss
c5a01bb24f Merge branch 'cleanup' of https://github.com/tuexss/github-changelog-generator into cleanup 2015-03-27 00:46:37 +01:00
Petr Korolev
6350cdf39c add coveralls to gemfile and add bin folder to git 2015-03-27 01:29:49 +02:00
tuexss
d425ae1a9a Change option name from format to dateformat 2015-03-27 00:23:28 +01:00
tuexss
fb50acca57 Sort option defaults as listed 2015-03-27 00:21:42 +01:00
tuexss
3bd3dae016 Set default for simple-list 2015-03-27 00:18:09 +01:00
tuexss
fd2beef12a Set default for include labels 2015-03-27 00:16:35 +01:00
tuexss
c088349bc3 Cleanup for parser helpmessages 2015-03-27 00:14:50 +01:00
Petr Korolev
1494fcdd8f Add CodeClimate and Inch CI. Fix #219 2015-03-27 01:09:27 +02:00
tuexss
8fa85475eb Merge pull request #1 from skywinder/tuexss-cleanup
rubocop cleanup
2015-03-26 23:36:04 +01:00
Petr Korolev
8462f017b7 rubocop cleanup 2015-03-27 00:24:55 +02:00
tuexss
57ef59d76c Don't pass log as parameter 2015-03-26 23:09:31 +01:00
tuexss
808155ee3a Slim down newer_tag initialization 2015-03-26 23:03:49 +01:00
tuexss
d80a6803be Optimize feedback when no tags found 2015-03-26 22:30:13 +01:00
tuexss
93291dde7c Remove misspelled and unused method 2015-03-26 22:12:45 +01:00
tuexss
c67909959b Consistent print/put messages and style 2015-03-26 22:01:58 +01:00
tuexss
2c8ba4965b Fix method name typo 2015-03-26 21:47:17 +01:00
Petr Korolev
eb497471b9 move all ignoring warnings to rubocop_todo 2015-03-26 22:37:23 +02:00
Petr Korolev
9d43384198 Merge branch 'develop' 2015-03-26 19:09:40 +02:00
Petr Korolev
2e5aec751f add lineLength ingore 2015-03-26 19:09:01 +02:00
Petr Korolev
92735a2fc8 modify rubocop yml by rubocop --auto-gen-config 2015-03-26 19:06:25 +02:00
Petr Korolev
8af5c4c6b0 Merge branch 'master' into develop 2015-03-26 18:44:16 +02:00
Petr Korolev
0f7fd939bf Merge branch 'estahn-feature/parse-existing-changelog-file' 2015-03-26 18:41:39 +02:00
Petr Korolev
cc6ac05254 Merge branch 'feature/parse-existing-changelog-file' of https://github.com/estahn/github-changelog-generator into estahn-feature/parse-existing-changelog-file
Conflicts:
	Gemfile
	Gemfile.lock
	Rakefile
2015-03-26 18:41:24 +02:00
Petr Korolev
fb601cf552 Merge branch 'master' into develop 2015-03-26 16:34:25 +02:00
Petr Korolev
990b32cf71 Merge branch 'feature/add-rspec' 2015-03-26 16:34:18 +02:00
Petr Korolev
c5df1c22bb add identations (rubocop fix) 2015-03-26 16:27:49 +02:00
Enrico Stahn
6ef182a1fc Add RSpec and Rubocop 2015-03-26 15:57:24 +02:00
Enrico Stahn
34cd8f75f7 Configure travis to use bundler and new rake tasks 2015-03-26 15:55:44 +02:00
Petr Korolev
9e69a1c853 add rubocop and rspec to Gemfile 2015-03-26 15:54:28 +02:00
Petr Korolev
cca8e5d810 rubocop auto-fixes 2015-03-26 15:50:56 +02:00
Petr Korolev
a09b6affd4 add rubocop and rspec to Rakefile 2015-03-26 15:33:56 +02:00
Enrico Stahn
3ca25bfff0 Merge branch 'master' into feature/parse-existing-changelog-file 2015-03-27 00:07:30 +11:00
Petr Korolev
f48236e47b change default configs 2015-03-26 12:51:04 +02:00
Petr Korolev
a9baa37c64 add rspec init files 2015-03-26 12:51:04 +02:00
Petr Korolev
2576706e9f Merge branch 'develop' 2015-03-26 12:49:41 +02:00
Petr Korolev
5a2f10a47d Merge branch 'master' into develop
Conflicts:
	lib/github_changelog_generator.rb
2015-03-26 09:31:03 +02:00
Enrico Stahn
692a4f156b Add missing RSpec gem 2015-03-26 16:10:04 +11:00
Enrico Stahn
5fd3f51d78 Update Gemfile.lock with new Gems 2015-03-26 16:05:46 +11:00
Enrico Stahn
2cf62707d7 Configure travis to use bundler and new rake tasks 2015-03-26 16:01:07 +11:00
Enrico Stahn
ea89cec43a Add RSpec and Rubocop 2015-03-26 16:00:36 +11:00
Enrico Stahn
0a3ecbb81b Add RSpec and Rubocop 2015-03-26 16:00:08 +11:00
Enrico Stahn
61a6e19417 Add RSpec Tests for Reader class 2015-03-26 15:59:48 +11:00
Enrico Stahn
6af43b63e1 Include Reader class 2015-03-26 15:58:16 +11:00
Enrico Stahn
9f06a20741 Refactor Reader class to conform with Rubocop 2015-03-26 15:57:51 +11:00
Enrico Stahn
1eee5bffd8 Implement Reader class to parse ChangeLog.md 2015-03-26 00:40:24 +11:00
Petr Korolev
0d0a37b653 fix logic of rescue. 2015-03-24 16:51:51 +02:00
Petr Korolev
5f6756e8dd Add warrning in case of 0 tags in repo. Fix #208. Reformat + prettify output. 2015-03-24 16:51:51 +02:00
Shawn Neal
a1c7ffb765 Relatively require github_changelog_generator library
During development its possible for the gem installed version of github_changelog_generator lib to get required instead of the current development version of the library. This ensures that Ruby pulls in the correct version of the lib, specifically for development without breaking production builds.
2015-03-24 16:51:51 +02:00
Shawn Neal
1456ba8913 Improved --max-issues docs and messaging
- defaulted max issues to be unlimited in number allowing user to optionally limit issues returned
- added FAQ section on rate limiting and API rate limit exceeded warning
2015-03-24 16:51:51 +02:00
Shawn Neal
90f6436af6 Add --max-issues argument to limit requests
This addresses issue 71 by providing a configurable limit on the number of issues to retrieve. By default this limits the number of issues to 500 which should help users stay under the GitHub API limit and keep change logs from growing ridiculous in size for older repos.
2015-03-24 16:51:51 +02:00
Petr Korolev
8841583c02 Merge pull request #207 from sneal/use-relative-require
Relatively require github_changelog_generator library
2015-03-24 11:33:43 +02:00
Petr Korolev
d6cbfe3c38 Merge pull request #76 from sneal/issue-71-add-max-issues-arg
Add --max-issues argument to limit requests
2015-03-24 11:26:14 +02:00
Shawn Neal
5978f35cce Relatively require github_changelog_generator library
During development its possible for the gem installed version of github_changelog_generator lib to get required instead of the current development version of the library. This ensures that Ruby pulls in the correct version of the lib, specifically for development without breaking production builds.
2015-03-23 10:39:26 -07:00
Shawn Neal
856ad3a742 Improved --max-issues docs and messaging
- defaulted max issues to be unlimited in number allowing user to optionally limit issues returned
- added FAQ section on rate limiting and API rate limit exceeded warning
2015-03-23 08:13:44 -07:00
Petr Korolev
d43ef05287 Merge branch 'master' into develop 2015-03-23 10:09:58 +02:00
Shawn Neal
643f2f9eab Add --max-issues argument to limit requests
This addresses issue 71 by providing a configurable limit on the number of issues to retrieve. By default this limits the number of issues to 500 which should help users stay under the GitHub API limit and keep change logs from growing ridiculous in size for older repos.
2015-03-20 18:45:40 -07:00
Petr Korolev
c428666106 Merge pull request #75 from skywinder/feature/fix-rate-limit-crash
Add  fallback with warning message to prevent crash in case of exceed API Rate Limit (temporary workaround for #71)
2015-03-21 02:21:37 +02:00
Petr Korolev
6370ee2997 Merge branch 'hotfix/update-changelog' 2015-03-21 02:15:11 +02:00
Petr Korolev
9f57a505cc Merge branch 'hotfix/update-changelog' into develop 2015-03-21 02:14:53 +02:00
Petr Korolev
5566f6f7f9 Update changelog for version 1.3.11 2015-03-21 02:13:31 +02:00
Petr Korolev
6406168b15 Merge branch 'release/1.3.11' 2015-03-21 02:13:09 +02:00
Petr Korolev
77939c095c Merge branch 'release/1.3.11' into develop 2015-03-21 02:13:09 +02:00
Petr Korolev
7b38f0f56a Update gemspec to version 1.3.11 2015-03-21 02:13:09 +02:00
Petr Korolev
7704dc9ecd Add rescue fallback with warning message to prevent crash in case of exceed Rate Limit (temporary workaround for #71) 2015-03-21 02:12:58 +02:00
Petr Korolev
25ee41bc8c add github logo 2015-03-21 02:12:58 +02:00
Petr Korolev
219f4b9748 update readme 2015-03-21 02:12:58 +02:00
brb
de33edd3ce Update README.md 2015-03-21 02:12:58 +02:00
Petr Korolev
6db717a5ee add link to issue 2015-03-21 02:12:58 +02:00
Petr Korolev
5fb5832cf5 ad xkcd link 2015-03-21 02:12:58 +02:00
Eric Dill
a55b938ccf MNT: Fix travis badge 2015-03-21 02:12:58 +02:00
Petr Korolev
d1b3e09da3 add faq 2015-03-21 02:12:58 +02:00
Petr Korolev
4d094ba211 cm 2015-03-21 02:12:58 +02:00
Petr Korolev
3d7aa0b7c5 cm 2015-03-21 02:12:58 +02:00
Petr Korolev
ada6f13de5 upate 2015-03-21 02:12:58 +02:00
Petr Korolev
9479979fed update 2015-03-21 02:12:58 +02:00
Petr Korolev
30e9ab0ec3 update 2015-03-21 02:12:58 +02:00
Petr Korolev
8d5bdbcca7 update 2015-03-21 02:12:58 +02:00
Petr Korolev
a514224625 update 2015-03-21 02:12:58 +02:00
Petr Korolev
4162bc8659 update readme 2015-03-21 02:12:57 +02:00
Petr Korolev
729938b85d Add rescue fallback with warning message to prevent crash in case of exceed Rate Limit (temporary workaround for #71) 2015-03-21 02:06:59 +02:00
Petr Korolev
06d49a1e44 add github logo 2015-03-21 01:15:45 +02:00
Petr Korolev
30f429f632 Merge branch 'master' into develop 2015-03-21 00:20:04 +02:00
Petr Korolev
dbb385d049 update readme 2015-03-20 23:44:18 +02:00
Petr Korolev
abe19eedbe Merge pull request #74 from briantigerchow/patch-1
Update README.md
2015-03-20 23:34:42 +02:00
brb
32149b8a2c Update README.md 2015-03-20 14:28:48 -07:00
Petr Korolev
e5f6670a07 add link to issue 2015-03-20 18:42:22 +02:00
Petr Korolev
83e406ca5f ad xkcd link 2015-03-20 18:42:22 +02:00
Petr Korolev
8c7f1a7390 Merge pull request #73 from ericdill/fix-travis-badge
MNT: Fix travis badge
2015-03-20 16:09:56 +02:00
Eric Dill
f248e1c718 MNT: Fix travis badge 2015-03-20 09:56:54 -04:00
Petr Korolev
fdcf5ccf7e add faq 2015-03-20 13:05:00 +02:00
Petr Korolev
2b46ba2a11 cm 2015-03-18 16:06:27 +02:00
Petr Korolev
f6388903b7 cm 2015-03-18 16:04:42 +02:00
Petr Korolev
e51bceda05 upate 2015-03-18 15:59:44 +02:00
Petr Korolev
165e8d4e9f update 2015-03-18 15:57:34 +02:00
Petr Korolev
79f16947b7 update 2015-03-18 15:52:46 +02:00
Petr Korolev
432f12af70 update 2015-03-18 15:45:51 +02:00
Petr Korolev
a1b19044c2 update 2015-03-18 15:43:11 +02:00
Petr Korolev
70e8c287f5 update readme 2015-03-18 15:36:01 +02:00
Petr Korolev
78ca34ff7c Merge branch 'hotfix/update' into develop 2015-03-18 15:26:52 +02:00
Petr Korolev
2f3e754a6b Merge branch 'hotfix/update' 2015-03-18 15:26:51 +02:00
Petr Korolev
8c20913af4 update readme 2015-03-18 15:26:32 +02:00
Petr Korolev
f14b081126 Merge branch 'hotfix/update-changelog' into develop 2015-03-18 10:28:52 +02:00
Petr Korolev
315a92b7b3 Merge branch 'hotfix/update-changelog' 2015-03-18 10:28:52 +02:00
Petr Korolev
cca51aa19f Update changelog for version 1.3.10 2015-03-18 10:28:51 +02:00
Petr Korolev
56b1398081 Merge branch 'release/1.3.10' into develop 2015-03-18 10:27:30 +02:00
27 changed files with 13033 additions and 734 deletions

1
.coveralls.yml Normal file
View File

@@ -0,0 +1 @@
service_name: travis-ci

2
.hound.yml Normal file
View File

@@ -0,0 +1,2 @@
ruby:
config_file: .rubocop.yml

2
.rspec Normal file
View File

@@ -0,0 +1,2 @@
--color
--require spec_helper

8
.rubocop.yml Normal file
View File

@@ -0,0 +1,8 @@
inherit_from: .rubocop_todo.yml
Metrics/LineLength:
Enabled: false
#http://viget.com/extend/just-use-double-quoted-ruby-strings
Style/StringLiterals:
EnforcedStyle: double_quotes

81
.rubocop_todo.yml Normal file
View File

@@ -0,0 +1,81 @@
# This configuration was generated by `rubocop --auto-gen-config`
# on 2015-04-04 02:29:34 +0300 using RuboCop version 0.29.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.
# Offense count: 21
Metrics/AbcSize:
Max: 71
# Offense count: 2
Metrics/BlockNesting:
Max: 4
# Offense count: 2
# Configuration parameters: CountComments.
Metrics/ClassLength:
Max: 457
# Offense count: 6
Metrics/CyclomaticComplexity:
Max: 15
# Offense count: 28
# Configuration parameters: CountComments.
Metrics/MethodLength:
Max: 118
# Offense count: 5
Metrics/PerceivedComplexity:
Max: 18
# Offense count: 3
Style/AccessorMethodName:
Enabled: false
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
Style/AndOr:
Enabled: false
# Offense count: 27
# Cop supports --auto-correct.
Style/Blocks:
Enabled: false
# Offense count: 7
# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
Style/CaseIndentation:
Enabled: false
# Offense count: 4
Style/Documentation:
Enabled: false
# Offense count: 1
# Configuration parameters: AllowedVariables.
Style/GlobalVars:
Enabled: false
# Offense count: 6
# Configuration parameters: MinBodyLength.
Style/GuardClause:
Enabled: false
# Offense count: 17
# Configuration parameters: MaxLineLength.
Style/IfUnlessModifier:
Enabled: false
# Offense count: 2
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
Style/Next:
Enabled: false
# Offense count: 5
# Configuration parameters: MaxSlashes.
Style/RegexpLiteral:
Enabled: false

View File

@@ -1,15 +1,17 @@
sudo: false
cache: bundler
language: ruby
before_install:
- gem update --system
- gem --version
rvm:
- 2.1.0
gemfile:
- Gemfile
- 2.1.0
script:
- bundle exec rake
notifications:
email:
recipients:
- sky4winder+githubchangeloggenerator@gmail.com
on_success: never # [always|never|change]
on_failure: change # [always|never|change]
on_success: never
on_failure: change
addons:
code_climate:
repo_token:
secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=

View File

@@ -1,292 +1,336 @@
# Change Log
## [1.3.9](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.9) (2015-03-06)
## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
[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.11...HEAD)
**Implemented enhancements:**
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/Github-Changelog-Generator/issues/63)
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
**Merged pull requests:**
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
## [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)
## [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)
**Fixed bugs:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
**Fixed bugs:**
- --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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
**Closed issues:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
**Fixed bugs:**
- 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)
[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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
**Implemented enhancements:**
- 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)
- 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)
**Fixed bugs:**
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
- Add CodeClimate and Inch CI [\#219](https://github.com/skywinder/github-changelog-generator/issues/219)
**Merged pull requests:**
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
- 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))
- 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))
## [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)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
**Implemented enhancements:**
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
**Merged pull requests:**
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/github-changelog-generator/pull/61) ([skywinder](https://github.com/skywinder))
## [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)
## [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)
**Fixed bugs:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
**Fixed bugs:**
- --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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
**Closed issues:**
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
**Merged pull requests:**
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
**Fixed bugs:**
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
**Merged pull requests:**
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
- 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.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
## [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)
**Merged pull requests:**
- 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)
[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.8...1.3.0)
**Implemented enhancements:**
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
- 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)
- 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)
**Fixed bugs:**
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
- Pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/github-changelog-generator/issues/44)
**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))
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
## [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.7...1.2.8)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
**Closed issues:**
**Fixed bugs:**
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/github-changelog-generator/issues/37)
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
**Merged pull requests:**
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
## [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)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5)
**Implemented enhancements:**
- 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)
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
**Fixed bugs:**
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
**Merged pull requests:**
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
## [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.1...1.2.2)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
**Fixed bugs:**
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
**Merged pull requests:**
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
- 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.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
## [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)
**Fixed bugs:**
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
**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))
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
**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 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))
## [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.2.2...1.2.3)
**Implemented enhancements:**
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
**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 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
**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))
- 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))
## [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)
**Implemented enhancements:**
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
**Fixed bugs:**
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/github-changelog-generator/issues/30)
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
**Merged pull requests:**
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
## [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/0.1.0...1.0.0)
**Implemented enhancements:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
**Fixed bugs:**
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
**Merged pull requests:**
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
## [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/1.2.0...1.2.1)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
**Fixed bugs:**
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/github-changelog-generator/issues/20)
**Merged pull requests:**
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([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))
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([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))
- 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))
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
## [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/1.1.4...1.2.0)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
**Merged pull requests:**
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
- 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))
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
**Implemented enhancements:**
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/github-changelog-generator/issues/19)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
**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 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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
**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))
- 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))
## [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)
**Implemented enhancements:**
- Detect username and project form origin [\#11](https://github.com/skywinder/github-changelog-generator/issues/11)
**Fixed bugs:**
- 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)
## [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)
## [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)
**Implemented enhancements:**
- 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)
**Fixed bugs:**
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/github-changelog-generator/issues/5)
**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))
## [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)
**Merged pull requests:**
- 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 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)
[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)

18
Gemfile
View File

@@ -1,4 +1,14 @@
source 'https://rubygems.org'
gem 'github_api'
gem 'colorize'
gem 'rake'
source "https://rubygems.org"
gem "rake"
gem "github_api"
gem "colorize"
group :test do
gem "rspec"
gem "rubocop"
gem "coveralls", require: false
gem "simplecov", require: false
gem "codeclimate-test-reporter"
end

View File

@@ -1,13 +1,28 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.3.6)
colorize (0.7.4)
addressable (2.3.7)
ast (2.0.0)
astrolabe (1.3.0)
parser (>= 2.2.0.pre.3, < 3.0)
codeclimate-test-reporter (0.4.7)
simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.5)
coveralls (0.7.12)
multi_json (~> 1.10)
rest-client (>= 1.6.8, < 2)
simplecov (~> 0.9.1)
term-ansicolor (~> 1.3)
thor (~> 0.19.1)
descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1)
faraday (0.9.0)
diff-lcs (1.2.5)
docile (1.1.5)
domain_name (0.5.23)
unf (>= 0.0.5, < 1.0.0)
faraday (0.9.1)
multipart-post (>= 1.2, < 3)
github_api (0.12.2)
github_api (0.12.3)
addressable (~> 2.3)
descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10)
@@ -15,13 +30,17 @@ GEM
multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.3)
oauth2
hashie (3.3.2)
jwt (1.2.0)
mini_portile (0.6.1)
multi_json (1.10.1)
hashie (3.4.0)
http-cookie (1.0.2)
domain_name (~> 0.5)
jwt (1.4.1)
mime-types (2.4.3)
mini_portile (0.6.2)
multi_json (1.11.0)
multi_xml (0.5.5)
multipart-post (2.0.0)
nokogiri (1.6.5)
netrc (0.10.3)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
oauth2 (1.0.0)
faraday (>= 0.8, < 0.10)
@@ -29,14 +48,59 @@ GEM
multi_json (~> 1.3)
multi_xml (~> 0.5)
rack (~> 1.2)
rack (1.5.2)
parser (2.2.0.3)
ast (>= 1.1, < 3.0)
powerpack (0.1.0)
rack (1.6.0)
rainbow (2.0.0)
rake (10.4.2)
thread_safe (0.3.4)
rest-client (1.8.0)
http-cookie (>= 1.0.2, < 2.0)
mime-types (>= 1.16, < 3.0)
netrc (~> 0.7)
rspec (3.2.0)
rspec-core (~> 3.2.0)
rspec-expectations (~> 3.2.0)
rspec-mocks (~> 3.2.0)
rspec-core (3.2.2)
rspec-support (~> 3.2.0)
rspec-expectations (3.2.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.2.0)
rspec-mocks (3.2.1)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.2.0)
rspec-support (3.2.2)
rubocop (0.29.1)
astrolabe (~> 1.3)
parser (>= 2.2.0.1, < 3.0)
powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.4)
ruby-progressbar (1.7.5)
simplecov (0.9.2)
docile (~> 1.1.0)
multi_json (~> 1.0)
simplecov-html (~> 0.9.0)
simplecov-html (0.9.0)
term-ansicolor (1.3.0)
tins (~> 1.0)
thor (0.19.1)
thread_safe (0.3.5)
tins (1.3.5)
unf (0.1.4)
unf_ext
unf_ext (0.0.6)
PLATFORMS
ruby
DEPENDENCIES
codeclimate-test-reporter
colorize
coveralls
github_api
rake
rspec
rubocop
simplecov

108
README.md
View File

@@ -1,8 +1,11 @@
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)
[![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)
[![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)
[![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 Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
==================
- [Installation](#installation)
@@ -13,14 +16,23 @@ GitHub Changelog Generator
- [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library)
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature)
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing)
- [License](#license)
Changelog generation has never been so easy.
### 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**. This generator complies all [change log format guidelines](http://keepachangelog.com/).
**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:
>### *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.
### *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.
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
## Installation
@@ -57,7 +69,7 @@ Changelog generation has never been so easy.
## Usage
**It's really simple**:
- If your **git remote** `origin` refer 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
@@ -88,6 +100,7 @@ Type `github_changelog_generator --help` for detailed usage.
--[no-]compare-link Include compare link between older version and newer version. Default is true
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited.
--github-site [URL] The Enterprise Github site on which your project is hosted.
--github-api [URL] The enterprise endpoint to use for your Github API.
-v, --version Print version number
@@ -96,9 +109,9 @@ Type `github_changelog_generator --help` for detailed usage.
### GitHub token
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
**You can easily [generate it here](https://github.com/settings/applications)**.
**You can easily [generate it here](https://github.com/settings/tokens)**.
And:
@@ -115,23 +128,27 @@ So, if you got error like this:
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
##Features and advantages of this project
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
- Possible to generate **Unreleased** changes (closed issues that have not released yet)
- **GitHub Enterprise support** via command line options!
- Generate canonical, neat change log file, followed by [basic change log guidlines](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
- **Custom date format** supported
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
- Ability to **exclude specific issues** from change log (by labels)
- **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels)
- **Distinguish** bug fixes, enchantments, and closed issues **according labels**.
- Issues (closed issues w/o any labels)
- Merged pull-requests (all merged pull-requests)
- Bug-fixes (by label `bug` in issue)
- Enhancements (by label `enhancement` in issue)
- **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 no one was satisfy my requirements.
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!*
@@ -139,15 +156,51 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
### 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 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 missed 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!*
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
## FAQ
- ***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:
*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:
The auto generated Changelog really helps even if you manually fill Releases notes!
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`.
- 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.
In the end:
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.
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?***
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:
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`
## Contributing
@@ -157,6 +210,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:
## License

View File

@@ -1,9 +1,7 @@
require "rake/testtask"
require "rubocop/rake_task"
require "rspec/core/rake_task"
task :default => [:test]
RuboCop::RakeTask.new
RSpec::Core::RakeTask.new(:rspec)
Rake::TestTask.new do |t|
t.verbose = true
t.libs.push("demo", "test")
t.pattern = "test/**/*_test.rb"
end
task default: [:rubocop, :rspec]

View File

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

View File

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

View File

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

BIN
images/logo.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

View File

@@ -6,6 +6,8 @@
**Merged pull requests:**
- This PR SHOULD NOT appear in change log! [\#6](https://github.com/skywinder/changelog_test/pull/6) ([skywinder](https://github.com/skywinder))
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)

View File

@@ -1,58 +1,65 @@
#!/usr/bin/env ruby
require 'github_api'
require 'json'
require 'colorize'
require 'benchmark'
require "github_api"
require "json"
require "colorize"
require "benchmark"
require_relative 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/generator'
require_relative 'github_changelog_generator/version'
require_relative "github_changelog_generator/parser"
require_relative "github_changelog_generator/generator"
require_relative "github_changelog_generator/version"
require_relative "github_changelog_generator/reader"
require_relative "github_changelog_generator/fetcher"
module GitHubChangelogGenerator
class ChangelogGenerator
# Default error for ChangelogGenerator
class ChangelogGeneratorError < StandardError
end
# Main class and entry point for this script.
class ChangelogGenerator
attr_accessor :options, :all_tags, :github
PER_PAGE_NUMBER = 30
# Class, responsible for whole change log generation cycle
# @return initialised instance of ChangelogGenerator
def initialize
@options = Parser.parse_options
fetch_github_token
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
github_options = {per_page: PER_PAGE_NUMBER}
github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
@generator = Generator.new @options
@github = Github.new github_options
# @all_tags = get_filtered_tags
@all_tags = @fetcher.get_all_tags
@generator = Generator.new(@options)
@issues, @pull_requests = @fetcher.fetch_issues_and_pull_requests
@all_tags = self.get_all_tags
@issues, @pull_requests = self.fetch_issues_and_pull_requests
@pull_requests = @options[:pulls] ? get_filtered_pull_requests : []
if @options[:pulls]
@pull_requests = self.get_filtered_pull_requests
else
@pull_requests = []
end
if @options[:issues]
@issues = self.get_filtered_issues
else
@issues = []
end
@issues = @options[:issues] ? get_filtered_issues : []
fetch_event_for_issues_and_pr
detect_actual_closed_dates
@tag_times_hash = {}
end
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
#
# @return [Array]
def get_filtered_tags
all_tags = @fetcher.get_all_tags
filtered_tags = []
if @options[:between_tags]
@options[:between_tags].each do |tag|
unless all_tags.include? tag
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
end
end
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
end
filtered_tags
end
def detect_actual_closed_dates
if @options[:verbose]
print "Fetching closed dates for issues...\r"
end
@@ -70,28 +77,30 @@ module GitHubChangelogGenerator
find_closed_date_by_commit(pull_request)
}
}
threads.each { |thr| thr.join }
threads.each(&:join)
if @options[:verbose]
puts 'Fetching closed dates for issues: Done!'
puts "Fetching closed dates for issues: Done!"
end
end
# Fill :actual_date parameter of specified issue by closed date of the commit, it it was closed by commit.
# @param [Hash] issue
def find_closed_date_by_commit(issue)
unless issue['events'].nil?
#if it's PR -> then find "merged event", in case of usual issue -> fond closed date
compare_string = issue[:merged_at].nil? ? 'closed' : 'merged'
unless issue["events"].nil?
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
# reverse! - to find latest closed event. (event goes in date order)
issue['events'].reverse!.each { |event|
issue["events"].reverse!.each { |event|
if event[:event].eql? compare_string
if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at]
else
begin
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
commit = @fetcher.fetch_commit(event)
issue[:actual_date] = commit[:author][:date]
rescue
puts "Warning: can't fetch commit #{event[:commit_id]} probably it referenced from another repo."
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
issue[:actual_date] = issue[:closed_at]
end
end
@@ -99,70 +108,23 @@ module GitHubChangelogGenerator
end
}
end
#TODO: assert issues, that remain without 'actual_date' hash for some reason.
# TODO: assert issues, that remain without 'actual_date' hash for some reason.
end
def print_json(json)
puts JSON.pretty_generate(json)
end
def fetch_merged_at_pull_requests
if @options[:verbose]
print "Fetching merged dates...\r"
end
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
pull_requests = []
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
count_pages = response.count_pages
print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
pull_requests.concat(page)
end
print " \r"
@pull_requests.each { |pr|
fetched_pr = pull_requests.find { |fpr|
fpr.number == pr.number }
pr[:merged_at] = fetched_pr[:merged_at]
pull_requests.delete(fetched_pr)
}
if @options[:verbose]
puts 'Fetching merged dates... Done!'
end
end
# This method fetches missing params for PR and filter them by specified options
# It include add all PR's with labels from @options[:include_labels] array
# And exclude all from :exclude_labels array.
# @return [Array] filtered PR's
def get_filtered_pull_requests
fetch_merged_at_pull_requests
self.fetch_merged_at_pull_requests
filtered_pull_requests = @pull_requests.select {|pr| pr[:merged_at] != nil }
unless @options[:include_labels].nil?
filtered_pull_requests = @pull_requests.select { |issue|
#add all labels from @options[:incluse_labels] array
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
}
end
unless @options[:exclude_labels].nil?
filtered_pull_requests = filtered_pull_requests.select { |issue|
#delete all labels from @options[:exclude_labels] array
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
}
end
if @options[:add_issues_wo_labels]
issues_wo_labels = @pull_requests.select {
# add issues without any labels
|issue| !issue.labels.map { |label| label.name }.any?
}
filtered_pull_requests |= issues_wo_labels
end
filtered_pull_requests = include_issues_by_labels(@pull_requests)
filtered_pull_requests = exclude_issues_by_labels(filtered_pull_requests)
if @options[:verbose]
puts "Filtered pull requests: #{filtered_pull_requests.count}"
@@ -171,17 +133,67 @@ module GitHubChangelogGenerator
filtered_pull_requests
end
def compund_changelog
# This method fetch missing required attributes for pull requests
# :merged_at - is a date, when issue PR was merged.
# More correct to use this date, not closed date.
def fetch_merged_at_pull_requests
if @options[:verbose]
print "Fetching merged dates...\r"
end
pull_requests = @fetcher.fetch_pull_requests
@pull_requests.each { |pr|
fetched_pr = pull_requests.find { |fpr|
fpr.number == pr.number
}
pr[:merged_at] = fetched_pr[:merged_at]
pull_requests.delete(fetched_pr)
}
if @options[:verbose]
puts "Fetching merged dates: Done!"
end
end
# Include issues with labels, specified in :include_labels
# @param [Array] issues to filter
# @return [Array] filtered array of issues
def include_issues_by_labels(issues)
filtered_issues = @options[:include_labels].nil? ? issues : issues.select { |issue| (issue.labels.map(&:name) & @options[:include_labels]).any? }
if @options[:add_issues_wo_labels]
issues_wo_labels = issues.select { |issue|
!issue.labels.map(&:name).any?
}
filtered_issues |= issues_wo_labels
end
filtered_issues
end
# delete all labels with labels from @options[:exclude_labels] array
# @param [Array] issues
# @return [Array] filtered array
def exclude_issues_by_labels(issues)
unless @options[:exclude_labels].nil?
issues = issues.select { |issue|
!(issue.labels.map(&:name) & @options[:exclude_labels]).any?
}
end
issues
end
# The entry point of this script to generate change log
# @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
def compound_changelog
log = "# Change Log\n\n"
if @options[:unreleased_only]
log += self.generate_log_between_tags(self.all_tags[0], nil)
log += generate_log_between_tags(all_tags[0], nil)
elsif @options[:tag1] and @options[:tag2]
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
self.all_tags.each { |x| tags_strings.push(x['name']) }
all_tags.each { |x| tags_strings.push(x["name"]) }
if tags_strings.include?(tag1)
if tags_strings.include?(tag2)
@@ -189,65 +201,63 @@ module GitHubChangelogGenerator
hash = Hash[to_a]
index1 = hash[tag1]
index2 = hash[tag2]
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
else
puts "Can't find tag #{tag2} -> exit"
exit
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
end
else
puts "Can't find tag #{tag1} -> exit"
exit
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
end
else
log += self.generate_log_for_all_tags
log += generate_log_for_all_tags
end
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
output_filename = "#{@options[:output]}"
File.open(output_filename, 'w') { |file| file.write(log) }
puts 'Done!'
File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!"
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
end
# The full cycle of generation for whole project
# @return [String] The complete change log
def generate_log_for_all_tags
fetch_tags_dates
if @options[:verbose]
puts "Sorting tags.."
puts "Sorting tags..."
end
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
if @options[:verbose]
puts "Generating log.."
puts "Generating log..."
end
log = ''
log = ""
if @options[:unreleased] && @all_tags.count != 0
unreleased_log = self.generate_log_between_tags(self.all_tags[0], nil)
unreleased_log = generate_log_between_tags(all_tags[0], nil)
if unreleased_log
log += unreleased_log
end
end
(1 ... self.all_tags.size).each { |index|
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
(1...all_tags.size).each { |index|
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
}
if @all_tags.count != 0
log += generate_log_between_tags(nil, self.all_tags.last)
log += generate_log_between_tags(nil, all_tags.last)
end
log
end
# Async fetching of all tags dates
def fetch_tags_dates
if @options[:verbose]
print "Fetching tags dates..\r"
print "Fetching tag dates...\r"
end
# Async fetching tags:
@@ -255,86 +265,46 @@ module GitHubChangelogGenerator
i = 0
all = @all_tags.count
@all_tags.each { |tag|
# explicit set @tag_times_hash to write data safety.
threads << Thread.new {
self.get_time_of_tag(tag, @tag_times_hash)
@fetcher.get_time_of_tag(tag)
if @options[:verbose]
print "Fetching tags dates: #{i+1}/#{all}\r"
i+=1
print "Fetching tags dates: #{i + 1}/#{all}\r"
i += 1
end
}
}
print " \r"
threads.each { |thr| thr.join }
threads.each(&:join)
if @options[:verbose]
puts 'Fetching tags: Done!'
puts "Fetching tags dates: #{i} Done!"
end
end
def is_megred(number)
@github.pull_requests.merged? @options[:user], @options[:project], number
end
def get_all_tags
if @options[:verbose]
print "Fetching tags...\r"
end
response = @github.repos.tags @options[:user], @options[:project]
tags = []
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
tags.concat(page)
end
print " \r"
if @options[:verbose]
puts "Found #{tags.count} tags"
end
tags
end
def fetch_github_token
env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
unless env_var
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
end
@github_token ||= env_var
end
# Generate log only between 2 specified tags
# @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
def generate_log_between_tags(older_tag, newer_tag)
# older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
older_tag_name = older_tag.nil? ? nil : older_tag['name']
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
if @options[:filter_issues_by_milestone]
#delete excess irrelevant issues (according milestones)
# delete excess irrelevant issues (according milestones)
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
end
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
# do not generate empty unreleased section
return ''
return ""
end
self.create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
end
def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
@@ -343,18 +313,18 @@ module GitHubChangelogGenerator
if issue.milestone.nil?
true
else
#check, that this milestone in tag list:
# check, that this milestone in tag list:
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
end
}
unless newer_tag_name.nil?
#add missed issues (according milestones)
# add missed issues (according milestones)
issues_to_add = src_array.select { |issue|
if issue.milestone.nil?
false
else
#check, that this milestone in tag list:
# check, that this milestone in tag list:
milestone_is_tag = @all_tags.find { |tag|
tag.name == issue.milestone.title
}
@@ -372,12 +342,17 @@ module GitHubChangelogGenerator
filtered_issues
end
def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
# Method filter issues, that belong only specified tag range
# @param [Array] array of issues to filter
# @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] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
# @return [Array] filtered issues
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
fail ChangelogGeneratorError, "At least one of the tags should be not nil!".red if older_tag.nil? && newer_tag.nil?
raise 'At least one of the tags should be not nil!' if (older_tag.nil? && newer_tag.nil?)
newer_tag_time = self.get_time_of_tag(newer_tag)
older_tag_time = self.get_time_of_tag(older_tag)
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
array.select { |req|
if req[hash_key]
@@ -395,7 +370,6 @@ module GitHubChangelogGenerator
tag_in_range_new = t <= newer_tag_time
end
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range
@@ -405,45 +379,38 @@ module GitHubChangelogGenerator
}
end
# @param [Array] pull_requests
# @param [Array] issues
# @param [String] older_tag_name
# @return [String]
# Generates log for section with header and body
#
# @param [Array] pull_requests List or PR's in new section
# @param [Array] issues List of issues in new section
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
# @return [String] Ready and parsed section
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
newer_tag_time = newer_tag.nil? ? nil : self.get_time_of_tag(newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
github_site = options[:github_site] || 'https://github.com'
github_site = options[:github_site] || "https://github.com"
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
if newer_tag.nil?
newer_tag_name = @options[:unreleased_label]
newer_tag_link = 'HEAD'
newer_tag_time = Time.new
else
newer_tag_link = newer_tag_name
end
log = ''
log += generate_header(log, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
if @options[:issues]
# Generate issues:
issues_a = []
enhancement_a = []
bugs_a =[]
bugs_a = []
issues.each { |dict|
added = false
dict.labels.each { |label|
if label.name == 'bug'
if label.name == "bug"
bugs_a.push dict
added = true
next
end
if label.name == 'enhancement'
if label.name == "enhancement"
enhancement_a.push dict
added = true
next
@@ -454,22 +421,26 @@ module GitHubChangelogGenerator
end
}
log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix])
log += generate_log_from_array(bugs_a, @options[:bug_prefix])
log += generate_log_from_array(issues_a, @options[:issue_prefix])
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
log += generate_sub_section(bugs_a, @options[:bug_prefix])
log += generate_sub_section(issues_a, @options[:issue_prefix])
end
if @options[:pulls]
# Generate pull requests:
log += generate_log_from_array(pull_requests, @options[:merge_prefix])
log += generate_sub_section(pull_requests, @options[:merge_prefix])
end
log
end
def generate_log_from_array(issues, prefix)
log = ''
if options[:simple_list].nil? && issues.any?
# @param [Array] issues List of issues on sub-section
# @param [String] prefix Nae of sub-section
# @return [String] Generate ready-to-go sub-section
def generate_sub_section(issues, prefix)
log = ""
if options[:simple_list] != true && issues.any?
log += "#{prefix}\n\n"
end
@@ -482,110 +453,51 @@ module GitHubChangelogGenerator
log
end
def generate_header(log, newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
# It generate one header for section with specific parameters.
#
# @param [String] newer_tag_name - name of newer tag
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
# @param [Time] newer_tag_time - time, when newer tag created
# @param [String] older_tag_link - tag name, used for links.
# @param [String] project_url - url for current project.
# @return [String] - Generate one ready-to-add section.
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
log = ""
#Generate date string:
time_string = newer_tag_time.strftime @options[:format]
# Generate date string:
time_string = newer_tag_time.strftime @options[:dateformat]
# Generate tag name and link
if newer_tag_name.equal? @options[:unreleased_label]
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2})\n\n"
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
else
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
end
if @options[:compare_link] && older_tag_name
if @options[:compare_link] && older_tag_link
# Generate compare link
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name2})\n\n"
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
end
log
end
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
if tag_name.nil?
return nil
end
if tag_times_hash[tag_name['name']]
return @tag_times_hash[tag_name['name']]
end
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
time_string = github_git_data_commits_get['committer']['date']
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
end
# Filter issues according labels
# @return [Array] Filtered issues
def get_filtered_issues
filtered_issues = include_issues_by_labels(@issues)
issues = @issues
filtered_issues = issues
unless @options[:include_labels].nil?
filtered_issues = issues.select { |issue|
#add all labels from @options[:incluse_labels] array
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
}
end
unless @options[:exclude_labels].nil?
filtered_issues = filtered_issues.select { |issue|
#delete all labels from @options[:exclude_labels] array
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
}
end
if @options[:add_issues_wo_labels]
issues_wo_labels = issues.select {
# add issues without any labels
|issue| !issue.labels.map { |label| label.name }.any?
}
filtered_issues |= issues_wo_labels
end
filtered_issues = exclude_issues_by_labels(filtered_issues)
if @options[:verbose]
puts "Filtered issues: #{filtered_issues.count}"
end
filtered_issues
end
def fetch_issues_and_pull_requests
if @options[:verbose]
print "Fetching closed issues...\r"
end
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
issues = []
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
issues.concat(page)
end
print " \r"
if @options[:verbose]
puts "Received issues: #{issues.count}"
end
# remove pull request from issues:
issues_wo_pr = issues.select { |x|
x.pull_request == nil
}
pull_requests = issues.select { |x|
x.pull_request != nil
}
return issues_wo_pr, pull_requests
end
# Fetch event for issues and pull requests
# @return [Array] array of fetched issues
def fetch_event_for_issues_and_pr
if @options[:verbose]
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
@@ -593,38 +505,11 @@ module GitHubChangelogGenerator
# Async fetching events:
fetch_events_async(@issues + @pull_requests)
#to clear line from prev print
print " \r"
if @options[:verbose]
puts 'Fetching events for issues and PR: Done!'
@fetcher.fetch_events_async(@issues + @pull_requests)
end
end
def fetch_events_async(issues)
i = 0
max_thread_number = 50
threads = []
issues.each_slice(max_thread_number) { |issues_slice|
issues_slice.each { |issue|
threads << Thread.new {
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
issue[:events] = obj.body
print "Fetching events for issues and PR: #{i+1}/#{@issues.count + @pull_requests.count}\r"
i +=1
}
}
threads.each { |thr| thr.join }
threads = []
}
if __FILE__ == $PROGRAM_NAME
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
end
end
if __FILE__ == $0
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
end
end

View File

@@ -0,0 +1,209 @@
require "logger"
module GitHubChangelogGenerator
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
# (such as filtering, validating, e.t.c)
#
# Example:
# fetcher = GitHubChangelogGenerator::Fetcher.new options
class Fetcher
PER_PAGE_NUMBER = 30
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be " \
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
def initialize(options = {})
@options = options
@user = @options[:user]
@project = @options[:project]
@github_token = fetch_github_token
@tag_times_hash = {}
@logger = Logger.new(STDOUT)
@logger.formatter = proc do |_severity, _datetime, _progname, msg|
"#{msg}\n"
end
github_options = { per_page: PER_PAGE_NUMBER }
github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
begin
@github = Github.new github_options
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
end
# Returns GitHub token. First try to use variable, provided by --token option,
# otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
#
# @return [String]
def fetch_github_token
env_var = @options[:token] ? @options[:token] : (ENV.fetch "CHANGELOG_GITHUB_TOKEN", nil)
unless env_var
@logger.warn "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
@logger.warn "This script can make only 50 requests to GitHub API per hour without token!".yellow
end
env_var
end
# Fetch all tags from repo
# @return [Array] array of tags
def get_all_tags
if @options[:verbose]
print "Fetching tags...\r"
end
tags = []
begin
response = @github.repos.tags @options[:user], @options[:project]
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
tags.concat(page)
end
print " \r"
if tags.count == 0
@logger.warn "Warning: Can't find any tags in repo.\
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
elsif @options[:verbose]
@logger.info "Found #{tags.count} tags"
end
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
tags
end
# This method fetch all closed issues and separate them to pull requests and pure issues
# (pull request is kind of issue in term of GitHub)
# @return [Tuple] with issues and pull requests
def fetch_issues_and_pull_requests
if @options[:verbose]
print "Fetching closed issues...\r"
end
issues = []
begin
response = @github.issues.list user: @options[:user],
repo: @options[:project],
state: "closed",
filter: "all",
labels: nil
page_i = 0
count_pages = response.count_pages
response.each_page do |page|
page_i += PER_PAGE_NUMBER
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
issues.concat(page)
break if @options[:max_issues] && issues.length >= @options[:max_issues]
end
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
print " \r"
if @options[:verbose]
@logger.info "Received issues: #{issues.count}"
end
# remove pull request from issues:
issues.partition { |x|
x[:pull_request].nil?
}
end
# Fetch all pull requests. We need them to detect :merged_at parameter
# @return [Array] all pull requests
def fetch_pull_requests
pull_requests = []
begin
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
page_i = 0
response.each_page do |page|
page_i += PER_PAGE_NUMBER
count_pages = response.count_pages
print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
pull_requests.concat(page)
end
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
print " \r"
pull_requests
end
# Fetch event for all issues and add them to :events
# @param [Array] issues
# @return [Void]
def fetch_events_async(issues)
i = 0
max_thread_number = 50
threads = []
issues.each_slice(max_thread_number) { |issues_slice|
issues_slice.each { |issue|
threads << Thread.new {
begin
obj = @github.issues.events.list user: @options[:user],
repo: @options[:project],
issue_number: issue["number"]
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
issue[:events] = obj.body
print "Fetching events for issues and PR: #{i + 1}/#{issues.count}\r"
i += 1
}
}
threads.each(&:join)
threads = []
}
# to clear line from prev print
print " \r"
if @options[:verbose]
@logger.info "Fetching events for issues and PR: #{i} Done!"
end
end
# Try to find tag date in local hash.
# Otherwise fFetch tag time and put it to local hash file.
# @param [String] tag_name name of the tag
# @return [Time] time of specified tag
def get_time_of_tag(tag_name)
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
if @tag_times_hash[tag_name["name"]]
return @tag_times_hash[tag_name["name"]]
end
begin
github_git_data_commits_get = @github.git_data.commits.get @options[:user],
@options[:project],
tag_name["commit"]["sha"]
rescue
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
time_string = github_git_data_commits_get["committer"]["date"]
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
end
# Fetch commit for specifed event
# @return [Hash]
def fetch_commit(event)
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
end
end
end

View File

@@ -1,12 +1,18 @@
module GitHubChangelogGenerator
class Generator
def initialize(options = nil)
@options = options
end
# Parse issue and generate single line formatted issue line.
#
# Example output:
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
#
# @param [Hash] issue Fetched issue from GitHub
# @return [String] Markdown-formatted single issue
def get_string_for_issue(issue)
encapsulated_title = self.encapsulate_string issue[:title]
encapsulated_title = encapsulate_string issue[:title]
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
@@ -23,17 +29,14 @@ module GitHubChangelogGenerator
end
def encapsulate_string(string)
string.gsub! '\\', '\\\\'
encpas_chars = %w(> * _ \( \) [ ] #)
encpas_chars.each { |char|
encpas_chars.each do |char|
string.gsub! char, "\\#{char}"
}
end
string
end
end
end

View File

@@ -1,114 +1,142 @@
#!/usr/bin/env ruby
require 'optparse'
require 'pp'
require_relative 'version'
require "optparse"
require "pp"
require_relative "version"
module GitHubChangelogGenerator
class Parser
def self.parse_options
options = {
:tag1 => nil,
:tag2 => nil,
:format => '%Y-%m-%d',
:output => 'CHANGELOG.md',
:exclude_labels => %w(duplicate question invalid wontfix),
:pulls => true,
:issues => true,
:verbose => true,
:add_issues_wo_labels => true,
:add_pr_wo_labels => true,
:merge_prefix => '**Merged pull requests:**',
:issue_prefix => '**Closed issues:**',
:bug_prefix => '**Fixed bugs:**',
:enhancement_prefix => '**Implemented enhancements:**',
:author => true,
:filter_issues_by_milestone => true,
:compare_link => true,
:unreleased => true,
:unreleased_label => 'Unreleased',
:branch => 'origin'
tag1: nil,
tag2: nil,
dateformat: "%Y-%m-%d",
output: "CHANGELOG.md",
issues: true,
add_issues_wo_labels: true,
add_pr_wo_labels: true,
pulls: true,
filter_issues_by_milestone: true,
author: true,
unreleased: true,
unreleased_label: "Unreleased",
compare_link: true,
include_labels: %w(bug enhancement),
exclude_labels: %w(duplicate question invalid wontfix),
max_issues: nil,
simple_list: false,
verbose: true,
merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**",
enhancement_prefix: "**Implemented enhancements:**",
branch: "origin"
}
parser = OptionParser.new { |opts|
opts.banner = 'Usage: github_changelog_generator [options]'
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
parser = OptionParser.new do |opts|
opts.banner = "Usage: github_changelog_generator [options]"
opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
options[:user] = last
end
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
options[:project] = last
end
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
options[:token] = last
end
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
options[:format] = last
opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
options[:dateformat] = last
end
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
end
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
options[:issues] = v
end
opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels to changelog. Default is true') do |v|
opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
options[:add_issues_wo_labels] = v
end
opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels to changelog. Default is true') do |v|
opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
options[:add_pr_wo_labels] = v
end
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
options[:pulls] = v
end
opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
options[:filter_issues_by_milestone] = last
end
opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
options[:author] = author
end
opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
options[:unreleased_only] = v
end
opts.on('--[no-]unreleased', 'Add to log unreleased closed issues. Default is true') do |v|
opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
options[:unreleased] = v
end
opts.on('--unreleased-label [label]', 'Add to log unreleased closed issues. Default is true') do |v|
opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
options[:unreleased_label] = v
end
opts.on('--[no-]compare-link', 'Include compare link (Full Changelog) between older version and newer version. Default is true') do |v|
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
options[:compare_link] = v
end
opts.on('--include-labels x,y,z', Array, 'Issues only with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
options[:include_labels] = list
end
opts.on('--exclude-labels x,y,z', Array, 'Issues with that labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
options[:exclude_labels] = list
end
opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
options[:max_issues] = max
end
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
options[:github_site] = last
end
opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
options[:github_endpoint] = last
end
opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
options[:simple_list] = v
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
end
opts.on('-v', '--version', 'Print version number') do |v|
opts.on("-v", "--version", "Print version number") do |_v|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit
end
opts.on('-h', '--help', 'Displays Help') do
opts.on("-h", "--help", "Displays Help") do
puts opts
exit
end
}
end
parser.parse!
detect_user_and_project(options)
if !options[:user] || !options[:project]
puts parser.banner
exit
end
if ARGV[1]
options[:tag1] = ARGV[0]
options[:tag2] = ARGV[1]
end
if options[:verbose]
puts "Performing task with options:"
pp options
puts ""
end
options
end
def self.detect_user_and_project(options)
if ARGV[0] && !ARGV[1]
github_site = options[:github_site] ? options[:github_site] : 'github.com'
github_site = options[:github_site] ? options[:github_site] : "github.com"
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
@@ -122,13 +150,16 @@ module GitHubChangelogGenerator
exit
else
options[:user] = match[1]
options[:project]= match[2]
options[:project] = match[2]
end
end
if !options[:user] && !options[:project]
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:user] = "skywinder"
options[:project] = "changelog_test"
else
remote = `git config --get remote.#{options[:branch]}.url`
# try to find repo in format:
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
@@ -149,25 +180,7 @@ module GitHubChangelogGenerator
end
end
end
if !options[:user] || !options[:project]
puts parser.banner
exit
end
if ARGV[1]
options[:tag1] = ARGV[0]
options[:tag2] = ARGV[1]
end
if options[:verbose]
puts 'Performing task with options:'
pp options
puts ''
end
options
end
end
end

View File

@@ -0,0 +1,87 @@
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#
# Copyright 2014, Zanui, <engineering@zanui.com.au>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module GitHubChangelogGenerator
# A Reader to read an existing ChangeLog file and return a structured object
#
# Example:
# reader = GitHubChangelogGenerator::Reader.new
# content = reader.read('./CHANGELOG.md')
class Reader
def initialize(options = {})
defaults = {
heading_level: "##",
heading_structures: [
/^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
/^## (?<version>.+?)( \((?<date>.+?)\))?$/
]
}
@options = options.merge(defaults)
@heading_level = @options[:heading_level]
@heading_structures = @options[:heading_structures]
end
# Parse a single heading and return a Hash
#
# The following heading structures are currently valid:
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
# - ## v1.0.2 (2015-03-24)
# - ## v1.0.2
#
# @param [String] heading Heading from the ChangeLog File
# @return [Hash] Returns a structured Hash with version, url and date
def parse_heading(heading)
captures = { "version" => nil, "url" => nil, "date" => nil }
@heading_structures.each do |regexp|
matches = Regexp.new(regexp).match(heading)
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
# Try Regular Expressions until you find one that delivers results
break unless matches.nil?
end
captures
end
# Parse the given ChangeLog data into a Hash
#
# @param [String] data File data from the ChangeLog.md
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
def parse(data)
sections = data.split(/^## .+?$/)
headings = data.scan(/^## .+?$/)
changelog = []
headings.each_with_index do |heading, index|
captures = parse_heading(heading)
captures["content"] = sections.at(index + 1)
changelog.push captures
end
changelog
end
def read(file_path)
parse File.read(file_path)
end
end
end

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator
VERSION = '1.3.10'
VERSION = "1.4.0"
end

9395
spec/files/angular.js.md Normal file

File diff suppressed because it is too large Load Diff

1911
spec/files/bundler.md Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,305 @@
# Change Log
## [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)
**Fixed bugs:**
- Exclude closed PR's from changelog. [\#69](https://github.com/skywinder/Github-Changelog-Generator/issues/69)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.8...1.3.9)
**Implemented enhancements:**
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/Github-Changelog-Generator/issues/63)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
**Merged pull requests:**
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
## [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)
## [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)
**Fixed bugs:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
**Fixed bugs:**
- --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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
**Closed issues:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
**Fixed bugs:**
- 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)
[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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
**Implemented enhancements:**
- 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)
- 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)
**Fixed bugs:**
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
**Closed issues:**
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
**Merged pull requests:**
- 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))
## [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)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
**Implemented enhancements:**
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
**Fixed bugs:**
- 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))
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
**Fixed bugs:**
- 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)
## [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)
**Implemented enhancements:**
- 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)
**Fixed bugs:**
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
**Merged pull requests:**
- 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))
## [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)
**Fixed bugs:**
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
**Fixed bugs:**
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
**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))
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
**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 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))
## [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)
**Implemented enhancements:**
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
**Merged pull requests:**
- 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
**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 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)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
**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))
- 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))
## [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)
**Implemented enhancements:**
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
**Fixed bugs:**
- 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)
## [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)
## [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)
**Implemented enhancements:**
- 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)
**Fixed bugs:**
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
**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))
## [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)
**Merged pull requests:**
- 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 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)
[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)
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

117
spec/spec_helper.rb Normal file
View File

@@ -0,0 +1,117 @@
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#
# Copyright 2014, Zanui, <engineering@zanui.com.au>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require "codeclimate-test-reporter"
require "simplecov"
require "coveralls"
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
Coveralls::SimpleCov::Formatter,
SimpleCov::Formatter::HTMLFormatter,
CodeClimate::TestReporter::Formatter
]
SimpleCov.start
require "github_changelog_generator"
# 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-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|
# 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
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|
# 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
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.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
# Many RSpec users commonly either run the entire suite or an individual
# 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
# 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
end

113
spec/unit/reader_spec.rb Normal file
View File

@@ -0,0 +1,113 @@
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#
# Copyright 2014, Zanui, <engineering@zanui.com.au>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
describe GitHubChangelogGenerator::Reader do
before(:all) do
@reader = GitHubChangelogGenerator::Reader.new
end
describe "#parse_heading" do
context "when heading is empty" do
subject { @reader.parse_heading("## ") }
it { is_expected.to be_a(Hash) }
it { is_expected.to include("version", "url", "date") }
it { is_expected.to include("version" => nil, "url" => nil, "date" => nil) }
# TODO: Doesn't work?
# it { is_expected.to have_all_string_keys }
end
context "when given version, url and date" do
subject { @reader.parse_heading("## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)") }
it { is_expected.to include("version" => "1.3.10") }
it { is_expected.to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
it { is_expected.to include("date" => "2015-03-18") }
end
context "when no url and date is provided" do
subject { @reader.parse_heading("## foobar") }
it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }
end
end
describe "#parse" do
context "when file is empty" do
subject { @reader.parse("") }
it { is_expected.to be_an(Array) }
it { is_expected.to be_empty }
end
context "when file has only the header" do
subject { @reader.parse("# Change Log") }
it { is_expected.to be_an(Array) }
it { is_expected.to be_empty }
end
end
describe "example CHANGELOG files" do
subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "files", self.class.description))) }
context "github-changelog-generator.md" do
it { is_expected.to be_an(Array) }
it { is_expected.not_to be_empty }
it { expect(subject.count).to eq(28) }
it { expect(subject.first).to include("version" => "1.3.10") }
it { expect(subject.first).to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
it { expect(subject.first).to include("date" => "2015-03-18") }
it { expect(subject.first).to include("content") }
it "content should not be empty" do
expect(subject.first["content"]).not_to be_empty
end
end
context "bundler.md" do
it { is_expected.to be_an(Array) }
it { is_expected.not_to be_empty }
it { expect(subject.count).to eq(151) }
it { expect(subject.first).to include("version" => "1.9.1") }
it { expect(subject.first).to include("url" => nil) }
it { expect(subject.first).to include("date" => "2015-03-21") }
it { expect(subject.first).to include("content") }
it "content should not be empty" do
expect(subject.first["content"]).not_to be_empty
end
end
context "angular.js.md" do
it { is_expected.to be_an(Array) }
it { is_expected.not_to be_empty }
it do
pending("Implement heading_level for parser.")
expect(subject.count).to eq(134)
end
# it do
# pending('Implement heading_level for parser.')
# expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
# end
# it do
# pending('Implement heading_level for parser.')
# expect(subject.first).to include('url' => nil)
# end
# it do
# pending('Implement heading_level for parser.')
# expect(subject.first).to include('date' => '2015-03-17')
# end
# it do
# pending('Implement heading_level for parser.')
# expect(subject.first).to include('content')
# end
# it 'content should not be empty' do
# pending('Implement heading_level for parser.')
# expect(subject.first['content']).not_to be_empty
# end
end
end
end