Compare commits

..

228 Commits

Author SHA1 Message Date
Petr Korolev
667768ac15 Merge branch 'feature/thor' of https://github.com/estahn/github-changelog-generator into estahn-feature/thor
Conflicts:
	Gemfile.lock
2015-03-29 21:55:59 +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
e0cf47e027 coveralls integration 2015-03-27 16:04:35 +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
Enrico Stahn
5e55ef672b Migrate all options to thor 2015-03-27 13:43:50 +11: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
Enrico Stahn
da8f725b2d Fix robocop issues with cli.rb 2015-03-27 12:08:53 +11: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
Enrico Stahn
3993eeec28 Add thor CLI binary and app class 2015-03-27 10:23:58 +11:00
tuexss
d425ae1a9a Change option name from format to dateformat 2015-03-27 00:23:28 +01:00
Enrico Stahn
8c0ebe3808 Add thor to Gemfile/gemspec 2015-03-27 10:23:12 +11: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
Petr Korolev
1232f339a0 Merge branch 'release/1.3.10' 2015-03-18 10:27:30 +02:00
Petr Korolev
3cc6418048 Update gemspec to version 1.3.10 2015-03-18 10:27:29 +02:00
Petr Korolev
a4f93feb7d This commit fix #69. 2015-03-18 10:18:58 +02:00
Petr Korolev
b0be9f8b06 Fix termination in case of empty unreleased section with --unreleased-only option. 2015-03-18 09:39:21 +02:00
Petr Korolev
aeaec739f5 Merge branch 'hotfix/readme' into develop 2015-03-17 17:07:36 +02:00
Petr Korolev
bf27187dd3 Merge branch 'hotfix/readme' 2015-03-17 17:07:27 +02:00
Petr Korolev
0e0295645d update readme 2015-03-17 17:07:12 +02:00
Petr Korolev
b2fac89ec1 Merge branch 'hotfix/readme' into develop 2015-03-09 09:59:14 +02:00
Petr Korolev
947163426b Merge branch 'hotfix/readme' 2015-03-09 09:59:13 +02:00
Petr Korolev
2900025f6f update readme 2015-03-09 09:59:04 +02:00
Petr Korolev
802fb44d38 Merge branch 'hotfix/update-changelog' into develop 2015-03-06 16:48:21 +02:00
Petr Korolev
8b299a0394 Merge branch 'hotfix/update-changelog' 2015-03-06 16:48:21 +02:00
Petr Korolev
111931a958 Update changelog for version 1.3.9 2015-03-06 16:48:20 +02:00
Petr Korolev
5a47a075e2 Merge branch 'release/1.3.9' into develop 2015-03-06 16:47:30 +02:00
Petr Korolev
a35d08f6c7 Merge branch 'release/1.3.9' 2015-03-06 16:47:30 +02:00
Petr Korolev
c2e73edc29 Update gemspec to version 1.3.9 2015-03-06 16:47:28 +02:00
Petr Korolev
045dff7cbc Fix: Improve method of detecting owner and repository. Fix #63 2015-03-06 16:32:59 +02:00
Petr Korolev
7c85082e7d Merge branch 'feature/limit-threads' into develop 2015-03-06 16:22:06 +02:00
Petr Korolev
cc65da5153 update changelog 2015-03-06 16:08:02 +02:00
Petr Korolev
c22f8b4a31 increase number of threads to 50, typo fix 2015-03-06 15:09:13 +02:00
Petr Korolev
2c46d32531 limit fetching up to 10 threads 2015-03-06 14:57:55 +02:00
Petr Korolev
e822ddfc98 update changelog 2015-03-05 17:20:57 +02:00
Petr Korolev
25a9490a07 Merge branch 'develop' 2015-03-05 17:20:17 +02:00
Petr Korolev
92a39a4107 Merge branch 'master' into develop 2015-03-05 17:20:04 +02:00
Petr Korolev
583021b474 Merge branch 'hotfix/update-changelog' 2015-03-05 17:15:42 +02:00
Petr Korolev
961aa20138 Merge branch 'hotfix/update-changelog' into develop 2015-03-05 17:15:42 +02:00
Petr Korolev
396622bec0 Update changelog for version 1.3.8 2015-03-05 17:15:40 +02:00
Petr Korolev
06575c9ab2 Merge branch 'release/1.3.8' 2015-03-05 17:14:52 +02:00
Petr Korolev
eba475ee76 Merge branch 'release/1.3.8' into develop 2015-03-05 17:14:52 +02:00
Petr Korolev
aa88122d48 Update gemspec to version 1.3.8 2015-03-05 17:14:51 +02:00
Petr Korolev
a69c2b5343 update gem 2015-03-05 17:14:40 +02:00
Petr Korolev
7fc862a100 update gem 2015-03-05 17:08:39 +02:00
Petr Korolev
87f95140d9 fix: remote branch parsing 2015-03-05 17:07:04 +02:00
Petr Korolev
75ae6f4a3a Merge branch 'hotfix/update-changelog' 2015-03-05 14:36:33 +02:00
Petr Korolev
31c13e8d1d Merge branch 'hotfix/update-changelog' into develop 2015-03-05 14:36:33 +02:00
Petr Korolev
a46fe7470b Update changelog for version 1.3.6 2015-03-05 14:36:31 +02:00
Petr Korolev
27fa9e8e02 Merge branch 'hotfix/fix-nil-tag' 2015-03-05 14:35:56 +02:00
Petr Korolev
b15f6b2837 Merge branch 'hotfix/fix-nil-tag' into develop 2015-03-05 14:35:56 +02:00
Petr Korolev
0706f89c02 Update gemspec to version 1.3.6 2015-03-05 14:35:54 +02:00
Petr Korolev
419e7e78ad Fix: exception in case no tags in repo 2015-03-05 14:33:01 +02:00
Petr Korolev
6159ebba2f refactoring 2015-03-05 13:20:51 +02:00
Petr Korolev
3a200e943c Merge branch 'hotfix/update-changelog' 2015-03-04 21:27:36 +02:00
Petr Korolev
4dc5a094d2 Merge branch 'hotfix/update-changelog' into develop 2015-03-04 21:27:36 +02:00
Petr Korolev
07d52c9465 Update changelog for version 1.3.5 2015-03-04 21:27:34 +02:00
Petr Korolev
02b0f95ab0 Merge branch 'release/1.3.5' 2015-03-04 21:27:05 +02:00
Petr Korolev
0b1f0319db Merge branch 'release/1.3.5' into develop 2015-03-04 21:27:05 +02:00
Petr Korolev
c20529bf32 Update gemspec to version 1.3.5 2015-03-04 21:27:03 +02:00
Petr Korolev
26c393c2cc Fix #60. Thanks, @GeekOnCoffee! 2015-03-04 21:25:21 +02:00
Petr Korolev
f8f887093a update changelog test repo 2015-03-04 19:40:15 +02:00
Petr Korolev
63bf4a59d4 fix help message 2015-03-04 16:45:18 +02:00
Petr Korolev
af189dc66f Merge branch 'hotfix/update-changelog' 2015-03-03 19:20:30 +02:00
Petr Korolev
917041424b Merge branch 'hotfix/update-changelog' into develop 2015-03-03 19:20:30 +02:00
Petr Korolev
2e5099efee Update changelog for version 1.3.4 2015-03-03 19:20:28 +02:00
Petr Korolev
9685d79f61 Merge branch 'hotfix/fix-59' 2015-03-03 19:19:54 +02:00
Petr Korolev
fb6b3dad5b Merge branch 'hotfix/fix-59' into develop 2015-03-03 19:19:54 +02:00
Petr Korolev
8d27718648 Update gemspec to version 1.3.4 2015-03-03 19:19:52 +02:00
Petr Korolev
8f8be4740d fix #59 2015-03-03 19:19:08 +02:00
Petr Korolev
26bd24b7d2 Merge branch 'hotfix/update-changelog' 2015-03-03 17:59:52 +02:00
Petr Korolev
049599a0a4 Merge branch 'hotfix/update-changelog' into develop 2015-03-03 17:59:52 +02:00
Petr Korolev
fcbf661d32 Update changelog for version 1.3.3 2015-03-03 17:59:50 +02:00
Petr Korolev
d1636ccb1d Merge branch 'release/1.3.3' 2015-03-03 17:59:04 +02:00
Petr Korolev
98cdd685b9 Merge branch 'release/1.3.3' into develop 2015-03-03 17:59:04 +02:00
Petr Korolev
84c52dba98 Update gemspec to version 1.3.3 2015-03-03 17:59:03 +02:00
Petr Korolev
b1428c894a update changelog 2015-03-03 17:58:32 +02:00
Petr Korolev
0d72f1236d Merge branch 'master' into develop 2015-03-03 17:57:28 +02:00
Petr Korolev
e3a8a0ed32 update changelog 2015-03-03 17:57:03 +02:00
Petr Korolev
8243f6f00c fix #58 2015-03-03 17:57:02 +02:00
Petr Korolev
2b5c1297b1 Fix: remove date from unreleased section 2015-03-03 17:53:30 +02:00
Petr Korolev
7f68f3db13 fix #58 2015-03-03 17:33:51 +02:00
Petr Korolev
3e2978357c Merge branch 'hotfix/update-changelog' into develop 2015-03-03 17:20:55 +02:00
Petr Korolev
4a53f4a126 Merge branch 'hotfix/update-changelog' 2015-03-03 17:20:55 +02:00
Petr Korolev
0163bf1844 Update changelog for version 1.3.2 2015-03-03 17:20:54 +02:00
Petr Korolev
059d6daf6a Merge branch 'hotfix/fix-57' into develop 2015-03-03 17:20:23 +02:00
Petr Korolev
931c90cecd Merge branch 'hotfix/fix-57' 2015-03-03 17:20:23 +02:00
Petr Korolev
911e6a6e6f Update gemspec to version 1.3.2 2015-03-03 17:20:21 +02:00
Petr Korolev
8201de3758 fix #57 2015-03-03 17:19:58 +02:00
Petr Korolev
8ffe5a168b update gemfile 2015-03-03 09:28:26 +02:00
Petr Korolev
8de7464490 Merge branch 'master' into develop 2015-02-27 15:30:47 +02:00
Petr Korolev
215daa4ede update readme 2015-02-27 15:30:29 +02:00
Petr Korolev
26be13eb11 Merge branch 'hotfix/update-changelog' into develop 2015-02-27 15:25:34 +02:00
Petr Korolev
8a5dc8830b Merge branch 'hotfix/update-changelog' 2015-02-27 15:25:34 +02:00
Petr Korolev
909e192e76 Update changelog for version 1.3.1 2015-02-27 15:25:32 +02:00
Petr Korolev
48cb34e735 Merge branch 'release/1.3.1' into develop 2015-02-27 15:25:01 +02:00
Petr Korolev
d2c5775658 Merge branch 'release/1.3.1' 2015-02-27 15:25:01 +02:00
Petr Korolev
711241621f Update gemspec to version 1.3.1 2015-02-27 15:24:59 +02:00
Petr Korolev
b34128fdb3 Merge branch 'master' into develop
Conflicts:
	CHANGELOG.md
2015-02-27 15:20:09 +02:00
Petr Korolev
54eb81bc6a Fix: replace ###headers to **bold** in sections names 2015-02-27 15:17:10 +02:00
Petr Korolev
035d9d5c19 update readme and changelog 2015-02-27 15:11:56 +02:00
Petr Korolev
004b37b7b9 Fix: Remove redudant spaces between sections 2015-02-27 15:05:22 +02:00
Petr Korolev
21de5f02ca Merge branch 'hotfix/update-changelog' 2015-02-26 12:49:48 +02:00
Petr Korolev
082c83b8e6 Merge branch 'hotfix/update-changelog' into develop 2015-02-26 12:49:48 +02:00
Petr Korolev
3f5d182e7a Update changelog for version 1.3.0 2015-02-26 12:49:46 +02:00
Petr Korolev
2039cacba5 Merge branch 'release/1.3.0' into develop 2015-02-26 12:49:15 +02:00
27 changed files with 12725 additions and 1348 deletions

1
.coveralls.yml Normal file
View File

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

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-03-27 03:03:45 +0200 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: 20
Metrics/AbcSize:
Max: 114
# Offense count: 1
Metrics/BlockNesting:
Max: 4
# Offense count: 2
# Configuration parameters: CountComments.
Metrics/ClassLength:
Max: 471
# Offense count: 6
Metrics/CyclomaticComplexity:
Max: 18
# Offense count: 27
# Configuration parameters: CountComments.
Metrics/MethodLength:
Max: 147
# Offense count: 6
Metrics/PerceivedComplexity:
Max: 20
# Offense count: 3
Style/AccessorMethodName:
Enabled: false
# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
Style/AndOr:
Enabled: false
# Offense count: 29
# Cop supports --auto-correct.
Style/Blocks:
Enabled: false
# Offense count: 7
# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
Style/CaseIndentation:
Enabled: false
# Offense count: 5
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,11 +1,13 @@
---
sudo: false
cache: bundler
language: ruby language: ruby
before_install:
- gem update --system
- gem --version
rvm: rvm:
- 2.1.0 - 2.1.0
gemfile:
- Gemfile script:
- bundle exec rake
notifications: notifications:
email: email:

View File

@@ -1,380 +1,305 @@
# Change Log # Change Log
## [Unreleased](https://github.com/skywinder/Github-Changelog-Generator/tree/HEAD) (2015-02-26) ## [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.2.8...HEAD) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.9...1.3.10)
#### Implemented enhancements: **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) - Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
- Not Released [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47) - Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
#### Fixed bugs: **Fixed bugs:**
- Test pull request with invalid label \(#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44) - Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
**Merged pull requests:**
#### 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)) - Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17) ## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
**Closed issues:**
#### Closed issues:
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37) - Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
**Merged pull requests:**
#### Merged pull requests:
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder)) - Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder)) - Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26) ## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
**Merged pull requests:**
#### 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)) - Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21) ## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
**Merged pull requests:**
#### Merged pull requests:
- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao)) - fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15) ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
#### Implemented enhancements: **Implemented enhancements:**
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22) - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
**Fixed bugs:**
#### Fixed bugs:
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32) - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
**Merged pull requests:**
#### Merged pull requests:
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing)) - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett)) - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16) ## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
**Fixed bugs:**
#### Fixed bugs:
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41) - Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35) - Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
#### Merged pull requests:
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16) ## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
#### Implemented enhancements: **Implemented enhancements:**
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38) - Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33) - Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
**Fixed bugs:**
#### Fixed bugs:
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30) - 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))
#### Merged pull requests:
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder)) - Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10) ## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
**Fixed bugs:**
#### Fixed bugs:
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34) - Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
**Merged pull requests:**
#### 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)) - Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22) ## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
**Fixed bugs:**
#### Fixed bugs:
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20) - Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
**Merged pull requests:**
#### Merged pull requests:
- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder)) - Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder)) - Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19) ## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
**Merged pull requests:**
#### Merged pull requests:
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder)) - Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder)) - Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder)) - Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18) ## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
#### Implemented enhancements: **Implemented enhancements:**
- 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) - 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:**
#### Merged pull requests:
- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder)) - Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12) ## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
**Merged pull requests:**
#### Merged pull requests:
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder)) - Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder)) - Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10) ## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
**Merged pull requests:**
#### Merged pull requests:
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder)) - Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder)) - Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder)) - Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10) ## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
#### Implemented enhancements: **Implemented enhancements:**
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11) - Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
**Fixed bugs:**
#### Fixed bugs:
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12) - Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9) - Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10) ## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
#### Merged pull requests:
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07) ## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
#### Implemented enhancements: **Implemented enhancements:**
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6) - Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4) - Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
**Fixed bugs:**
#### Fixed bugs:
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5) - 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))
#### Merged pull requests:
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder)) - Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07) ## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
**Merged pull requests:**
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
#### Merged pull requests:
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder)) - Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder)) - Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06) ## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2) [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06) ## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

12
Gemfile
View File

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

View File

@@ -1,13 +1,34 @@
PATH
remote: .
specs:
github_changelog_generator (1.3.11)
colorize (~> 0.7)
github_api (~> 0.12)
thor (~> 0.19)
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
addressable (2.3.6) addressable (2.3.7)
colorize (0.7.4) ast (2.0.0)
astrolabe (1.3.0)
parser (>= 2.2.0.pre.3, < 3.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) descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1) 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) multipart-post (>= 1.2, < 3)
github_api (0.12.2) github_api (0.12.3)
addressable (~> 2.3) addressable (~> 2.3)
descendants_tracker (~> 0.0.4) descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10) faraday (~> 0.8, < 0.10)
@@ -15,13 +36,17 @@ GEM
multi_json (>= 1.7.5, < 2.0) multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.3) nokogiri (~> 1.6.3)
oauth2 oauth2
hashie (3.3.2) hashie (3.4.0)
jwt (1.2.0) http-cookie (1.0.2)
mini_portile (0.6.1) domain_name (~> 0.5)
multi_json (1.10.1) jwt (1.4.1)
mime-types (2.4.3)
mini_portile (0.6.2)
multi_json (1.11.0)
multi_xml (0.5.5) multi_xml (0.5.5)
multipart-post (2.0.0) multipart-post (2.0.0)
nokogiri (1.6.5) netrc (0.10.3)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0) mini_portile (~> 0.6.0)
oauth2 (1.0.0) oauth2 (1.0.0)
faraday (>= 0.8, < 0.10) faraday (>= 0.8, < 0.10)
@@ -29,14 +54,58 @@ GEM
multi_json (~> 1.3) multi_json (~> 1.3)
multi_xml (~> 0.5) multi_xml (~> 0.5)
rack (~> 1.2) 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) 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 PLATFORMS
ruby ruby
DEPENDENCIES DEPENDENCIES
colorize bundler (~> 1.7)
github_api coveralls
rake github_changelog_generator!
rake (~> 10.0)
rspec
rubocop
simplecov

139
README.md
View File

@@ -1,8 +1,10 @@
[![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)
[![Coverage Status](http://img.shields.io/coveralls/skywinder/github-changelog-generator/master.svg)](https://coveralls.io/r/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)
[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator) GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)
GitHub Changelog Generator
================== ==================
- [Installation](#installation) - [Installation](#installation)
@@ -13,14 +15,23 @@ GitHub Changelog Generator
- [Features and advantages of this project](#features-and-advantages-of-this-project) - [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives) - [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library) - [Projects using this library](#projects-using-this-library)
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature) - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [License](#license)
Changelog generation has never been so easy. ### Changelog generation has never been so easy:
**Fully automate changelog generation** - This gem 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 ## Installation
@@ -35,35 +46,35 @@ Changelog generation has never been so easy.
- In general it looks like this: - In general it looks like this:
> ## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
> #### 09/01/15
> - *Merged pull-request:* add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115)
> ([skywinder](https://github.com/skywinder))
> >
> - *Merged pull-request:* Fix bad interaction with Git submodules. > [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
> [\#112](https://github.com/skywinder/ActionSheetPicker-3.0/pull/112)
> ([JimDabell](https://github.com/JimDabell))
> >
> - *Implemented enhancement:* Should have minimum/maximum date property exposed > **Implemented enhancements:**
> [\#97](https://github.com/skywinder/ActionSheetPicker-3.0/issues/97)
> >
> ## [1.3.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.9) > - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
> #### 11/12/14
> - *Closed issue:* Bad interaction with submodules [\#111](https://github.com/skywinder/ActionSheetPicker-3.0/issues/111)
> >
> - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122) > **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))
## Usage ## Usage
**It's really simple**: **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 github_changelog_generator
- or from anywhere: - or from anywhere:
- `github_changelog_generator -u github_username -p github_project`
github_changelog_generator -u github_username -p github_project - `github_changelog_generator github_username/github_project`
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
@@ -88,6 +99,7 @@ Type `github_changelog_generator --help` for detailed usage.
--[no-]compare-link Include compare link between older version and newer version. Default is true --[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' --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' --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-site [URL] The Enterprise Github site on which your project is hosted.
--github-api [URL] The enterprise endpoint to use for your Github API. --github-api [URL] The enterprise endpoint to use for your Github API.
-v, --version Print version number -v, --version Print version number
@@ -96,7 +108,7 @@ Type `github_changelog_generator --help` for detailed usage.
### GitHub token ### 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/applications)**.
@@ -115,23 +127,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. 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 ##Features and advantages of this project
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) - Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
- Simply add links for all closed issues and merged pull requests - Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- Possible to generate **Unreleased** changes (closed issues that have not released yet) - **GitHub Enterprise support** via command line options! :factory:
- Flexible format customisation: - Flexible format **customisation**:
- Customize issues, that should be added to changelog - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
- Custom date format supported - **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 - 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:
- Ability to exclude specific issues from change log (by labels) - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
- 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** issues **according labels**. :mag_right:
- Distinguish bug fixes, enchantments, and closed issues according labels. - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
- **Issues** (closed issues w/o any labels) - Bug fixes (by label `bug` in issue) :beetle:
- **Merged pull-requests** (all merged pull-requests) - Enhancements (by label `enhancement` in issue) :star2:
- **Bug-fixes** (by label `bug` in issue) - Issues (closed issues `w/o any labels`) :non-potable_water:
- **Enhancements** (by label `enhancement` in issue)
- 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 ###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!* *If you know other projects - feel free to edit this Wiki page!*
@@ -139,15 +155,49 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
### Projects using this library ### Projects using this library
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
*If you are using `github_changelog_generator` for generation change log in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.* *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 ## Contributing
@@ -157,6 +207,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n
4. Commit your changes (`git commit -am 'Add some feature'`) 4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`) 5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request 6. Create a new Pull Request
7. Profit! :white_check_mark:
## License ## 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| task default: [:rubocop, :rspec]
t.verbose = true
t.libs.push("demo", "test")
t.pattern = "test/**/*_test.rb"
end

3
bin/ghclgen Executable file
View File

@@ -0,0 +1,3 @@
#!/usr/bin/env ruby -U
require 'github_changelog_generator'
GitHubChangelogGenerator::CLI.start(ARGV)

View File

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

View File

@@ -7,7 +7,7 @@ SPEC_TYPE = 'gemspec'
:minor :minor
:patch :patch
@options = {:dry_run => false, :bump_number => :patch} @options = { dry_run: false, bump_number: :patch }
OptionParser.new { |opts| OptionParser.new { |opts|
opts.banner = 'Usage: bump.rb [options]' opts.banner = 'Usage: bump.rb [options]'
@@ -15,13 +15,13 @@ OptionParser.new { |opts|
opts.on('-d', '--dry-run', 'Dry run') do |v| opts.on('-d', '--dry-run', 'Dry run') do |v|
@options[:dry_run] = v @options[:dry_run] = v
end end
opts.on('-a', '--major', 'Bump major version') do |v| opts.on('-a', '--major', 'Bump major version') do |_v|
@options[:bump_number] = :major @options[:bump_number] = :major
end end
opts.on('-m', '--minor', 'Bump minor version') do |v| opts.on('-m', '--minor', 'Bump minor version') do |_v|
@options[:bump_number] = :minor @options[:bump_number] = :minor
end end
opts.on('-p', '--patch', 'Bump patch version') do |v| opts.on('-p', '--patch', 'Bump patch version') do |_v|
@options[:bump_number] = :patch @options[:bump_number] = :patch
end end
opts.on('-r', '--revert', 'Revert last bump') do |v| opts.on('-r', '--revert', 'Revert last bump') do |v|
@@ -32,7 +32,7 @@ OptionParser.new { |opts|
p @options p @options
def check_repo_is_clean_or_dry_run def check_repo_is_clean_or_dry_run
value =%x[#{'git status --porcelain'}] value = `#{'git status --porcelain'}`
if value.empty? if value.empty?
puts 'Repo is clean -> continue' puts 'Repo is clean -> continue'
@@ -46,7 +46,6 @@ def check_repo_is_clean_or_dry_run
end end
end end
def find_spec_file def find_spec_file
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'") list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
arr = list_of_specs.split("\n") arr = list_of_specs.split("\n")
@@ -66,13 +65,12 @@ def find_spec_file
spec_file = arr[input_index - 1] spec_file = arr[input_index - 1]
end end
if spec_file == nil if spec_file.nil?
puts "Can't find specified spec file -> exit" puts "Can't find specified spec file -> exit"
exit exit
end end
spec_file.sub('./', '') spec_file.sub('./', '')
end end
def find_current_gem_file def find_current_gem_file
@@ -94,13 +92,12 @@ def find_current_gem_file
spec_file = arr[input_index - 1] spec_file = arr[input_index - 1]
end end
if spec_file == nil if spec_file.nil?
puts "Can't find specified spec file -> exit" puts "Can't find specified spec file -> exit"
exit exit
end end
spec_file.sub('./', '') spec_file.sub('./', '')
end end
def find_version_in_podspec(podspec) def find_version_in_podspec(podspec)
@@ -117,12 +114,12 @@ def find_version_in_podspec(podspec)
end end
puts "Found version #{match_result[0]}" puts "Found version #{match_result[0]}"
return match_result[0], match_result.captures [match_result[0], match_result.captures]
end end
def bump_version(versions_array) def bump_version(versions_array)
bumped_result = versions_array.dup bumped_result = versions_array.dup
bumped_result.map! { |x| x.to_i } bumped_result.map!(&:to_i)
case @options[:bump_number] case @options[:bump_number]
when :major when :major
@@ -135,10 +132,9 @@ def bump_version(versions_array)
when :patch when :patch
bumped_result[2] += 1 bumped_result[2] += 1
else else
raise('unknown bump_number') fail('unknown bump_number')
end end
bumped_version = bumped_result.join('.') bumped_version = bumped_result.join('.')
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}" puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
bumped_version bumped_version
@@ -157,7 +153,7 @@ def execute_line_if_not_dry_run(line)
nil nil
else else
puts line puts line
value = %x[#{line}] value = `#{line}`
puts value puts value
check_exit_status(value) check_exit_status(value)
value value
@@ -165,14 +161,13 @@ def execute_line_if_not_dry_run(line)
end end
def check_exit_status(output) def check_exit_status(output)
if $?.exitstatus != 0 if $CHILD_STATUS.exitstatus != 0
puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script." puts "Output:\n#{output}\nExit status = #{$CHILD_STATUS.exitstatus} ->Terminate script."
exit exit
end end
end end
def run_bumping_script def run_bumping_script
check_repo_is_clean_or_dry_run check_repo_is_clean_or_dry_run
spec_file = find_spec_file spec_file = find_spec_file
result, versions_array = find_version_in_podspec(spec_file) result, versions_array = find_version_in_podspec(spec_file)
@@ -198,7 +193,6 @@ def run_bumping_script
gem = find_current_gem_file gem = find_current_gem_file
execute_line_if_not_dry_run("gem push #{gem}") execute_line_if_not_dry_run("gem push #{gem}")
# execute_line_if_not_dry_run("pod trunk push #{spec_file}") # execute_line_if_not_dry_run("pod trunk push #{spec_file}")
end end
def revert_last_bump def revert_last_bump
@@ -216,7 +210,7 @@ def revert_last_bump
execute_line_if_not_dry_run("git push --delete origin #{result}") execute_line_if_not_dry_run("git push --delete origin #{result}")
end end
if __FILE__ == $0 if __FILE__ == $PROGRAM_NAME
if @options[:revert] if @options[:revert]
revert_last_bump revert_last_bump

View File

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

BIN
images/logo.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

View File

@@ -1,777 +1,30 @@
# Change Log # Change Log
## [Unreleased](https://github.com/skywinder/ActionSheetPicker-3.0/tree/HEAD) (2015-02-26) ## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.13...HEAD)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...HEAD)
**Merged pull requests:**
### Merged pull requests: - Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
- Add additional showPickerWithTitle method [\#143](https://github.com/skywinder/ActionSheetPicker-3.0/pull/143) ([martinpfannemueller](https://github.com/martinpfannemueller)) ## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
**Merged pull requests:**
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
## [1.3.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.13) (2015-02-09) [Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.12...1.3.13)
### Fixed bugs:
- Wrong background color of pickers [\#136](https://github.com/skywinder/ActionSheetPicker-3.0/issues/136)
### Merged pull requests:
- Fixed an issue when initial selections applied to picker with different number of rows for different components. [\#113](https://github.com/skywinder/ActionSheetPicker-3.0/pull/113) ([venj](https://github.com/venj))
## [1.3.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.12) (2015-02-04)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.11...1.3.12)
### Fixed bugs:
- Light status bar style [\#119](https://github.com/skywinder/ActionSheetPicker-3.0/issues/119)
## [1.3.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.11) (2015-01-15)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.10...1.3.11)
### Merged pull requests:
- Fixes a crash while closing when using the Classy framework for styling [\#128](https://github.com/skywinder/ActionSheetPicker-3.0/pull/128) ([sudeepsidhu](https://github.com/sudeepsidhu))
- .m files should not be included in public header files [\#127](https://github.com/skywinder/ActionSheetPicker-3.0/pull/127) ([ened](https://github.com/ened))
## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) (2015-01-09)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.9...1.3.10)
### Implemented enhancements:
- Should have minimum/maximum date property exposed [\#97](https://github.com/skywinder/ActionSheetPicker-3.0/issues/97)
### Closed issues:
- No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122)
- Swift; Does not conform to protocol [\#120](https://github.com/skywinder/ActionSheetPicker-3.0/issues/120)
### Merged pull requests:
- add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115) ([skywinder](https://github.com/skywinder))
## [1.3.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.9) (2014-12-11)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.8...1.3.9)
### Closed issues:
- Bad interaction with submodules [\#111](https://github.com/skywinder/ActionSheetPicker-3.0/issues/111)
### Merged pull requests:
- Fix bad interaction with Git submodules. Fixes issue #111. [\#112](https://github.com/skywinder/ActionSheetPicker-3.0/pull/112) ([JimDabell](https://github.com/JimDabell))
## [1.3.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.8) (2014-12-10)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.7...1.3.8)
### Closed issues:
- Redefinition of enumerator 'Selector' [\#109](https://github.com/skywinder/ActionSheetPicker-3.0/issues/109)
### Merged pull requests:
- Fix for #109 [\#110](https://github.com/skywinder/ActionSheetPicker-3.0/pull/110) ([michalciolek](https://github.com/michalciolek))
- Fixed an issue when more than one ActionSheetCustomPicker is used in a ViewController [\#108](https://github.com/skywinder/ActionSheetPicker-3.0/pull/108) ([venj](https://github.com/venj))
## [1.3.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.7) (2014-12-04)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.6...1.3.7)
### Fixed bugs:
- UIDatePicker does not fire the target-action associated with the UIControlEventValueChanged event the first time [\#104](https://github.com/skywinder/ActionSheetPicker-3.0/issues/104)
### Merged pull requests:
- Added workaround for a bug in UIDatePicker in count down mode. [\#105](https://github.com/skywinder/ActionSheetPicker-3.0/pull/105) ([tomaskraina](https://github.com/tomaskraina))
- Added minimumDate and maximumDate to contructor of ActionSheetDatePicker [\#98](https://github.com/skywinder/ActionSheetPicker-3.0/pull/98) ([emmanuelay](https://github.com/emmanuelay))
## [1.3.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.6) (2014-12-02)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.5...1.3.6)
### Fixed bugs:
- Example projects failed to launch [\#96](https://github.com/skywinder/ActionSheetPicker-3.0/issues/96)
### Closed issues:
- Travis builds is broken by fix #96 [\#99](https://github.com/skywinder/ActionSheetPicker-3.0/issues/99)
### Merged pull requests:
- Add a Bitdeli Badge to README [\#107](https://github.com/skywinder/ActionSheetPicker-3.0/pull/107) ([bitdeli-chef](https://github.com/bitdeli-chef))
## [1.3.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.5) (2014-11-14)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.4...1.3.5)
### Fixed bugs:
- StatusBar visibility [\#90](https://github.com/skywinder/ActionSheetPicker-3.0/issues/90)
### Merged pull requests:
- Update README.md [\#95](https://github.com/skywinder/ActionSheetPicker-3.0/pull/95) ([jeffreyjackson](https://github.com/jeffreyjackson))
## [1.3.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.4) (2014-11-12)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.3...1.3.4)
### Merged pull requests:
- Fix statusBar visibility [\#93](https://github.com/skywinder/ActionSheetPicker-3.0/pull/93) ([krin-san](https://github.com/krin-san))
## [1.3.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.3) (2014-11-12)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.2...1.3.3)
### Fixed bugs:
- Compiler warning due to Unicode char in source [\#92](https://github.com/skywinder/ActionSheetPicker-3.0/issues/92)
## [1.3.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.2) (2014-11-11)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.1...1.3.2)
### Implemented enhancements:
- Add delegate for custom button pressed [\#33](https://github.com/skywinder/ActionSheetPicker-3.0/issues/33)
### Merged pull requests:
- Add additional check for UIDatePickerModeCountDownTimer [\#91](https://github.com/skywinder/ActionSheetPicker-3.0/pull/91) ([skywinder](https://github.com/skywinder))
- Count down duration fix [\#89](https://github.com/skywinder/ActionSheetPicker-3.0/pull/89) ([ijameelkhan](https://github.com/ijameelkhan))
## [1.3.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.1) (2014-11-04)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.0...1.3.1)
### Merged pull requests:
- Fix for #84 and #63 [\#85](https://github.com/skywinder/ActionSheetPicker-3.0/pull/85) ([skywinder](https://github.com/skywinder))
## [1.3.0](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.0) (2014-11-03)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.2.0...1.3.0)
### Fixed bugs:
- iPad - Swift Popover not visible [\#68](https://github.com/skywinder/ActionSheetPicker-3.0/issues/68)
### Merged pull requests:
- Added callback for custom button being pressed [\#81](https://github.com/skywinder/ActionSheetPicker-3.0/pull/81) ([velga](https://github.com/velga))
- Added support for popover customizations. [\#77](https://github.com/skywinder/ActionSheetPicker-3.0/pull/77) ([openreply](https://github.com/openreply))
## [1.2.0](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.2.0) (2014-10-15)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.21...1.2.0)
### Merged pull requests:
- General fixes for #74 & #50 [\#76](https://github.com/skywinder/ActionSheetPicker-3.0/pull/76) ([skywinder](https://github.com/skywinder))
- Further support for countdown timer [\#74](https://github.com/skywinder/ActionSheetPicker-3.0/pull/74) ([mgmart](https://github.com/mgmart))
## [1.1.21](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.21) (2014-10-13)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.20...1.1.21)
### Fixed bugs:
- i used DatePicker in ActionSheetPicket-3.0, but app crashed. [\#65](https://github.com/skywinder/ActionSheetPicker-3.0/issues/65)
### Closed issues:
- ActionSheetString picker Crash [\#75](https://github.com/skywinder/ActionSheetPicker-3.0/issues/75)
## [1.1.20](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.20) (2014-10-13)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.19...1.1.20)
### Closed issues:
- ActionSheetDatePicker: set selectedDate in response to custom button press [\#73](https://github.com/skywinder/ActionSheetPicker-3.0/issues/73)
- Using ActionSheetDatePicker as CountDownTimer-Picker [\#72](https://github.com/skywinder/ActionSheetPicker-3.0/issues/72)
- Example fails when clicking "Modal Test": 'Pushing a navigation controller is not supported' [\#70](https://github.com/skywinder/ActionSheetPicker-3.0/issues/70)
## [1.1.19](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.19) (2014-10-07)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.18...1.1.19)
### Fixed bugs:
- Xcode 6 / Swift incompatibility [\#36](https://github.com/skywinder/ActionSheetPicker-3.0/issues/36)
### Merged pull requests:
- title text with attributes. [\#64](https://github.com/skywinder/ActionSheetPicker-3.0/pull/64) ([nebiros](https://github.com/nebiros))
## [1.1.18](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.18) (2014-10-03)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.17...1.1.18)
## [1.1.17](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.17) (2014-10-03)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.16...1.1.17)
## [1.1.16](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.16) (2014-10-03)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.15...1.1.16)
## [1.1.15](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.15) (2014-09-29)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.14...1.1.15)
### Implemented enhancements:
- Method request: hideActionSheetPicker [\#51](https://github.com/skywinder/ActionSheetPicker-3.0/issues/51)
### Fixed bugs:
- DatePicker callback freezes screen [\#42](https://github.com/skywinder/ActionSheetPicker-3.0/issues/42)
### Merged pull requests:
- Update SWActionSheet.m [\#60](https://github.com/skywinder/ActionSheetPicker-3.0/pull/60) ([zhongyang](https://github.com/zhongyang))
- Fix for UIDatePickerModeCountDownTimer callback [\#50](https://github.com/skywinder/ActionSheetPicker-3.0/pull/50) ([jklp](https://github.com/jklp))
## [1.1.14](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.14) (2014-09-28)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.13...1.1.14)
### Merged pull requests:
- add block based API to date picker [\#56](https://github.com/skywinder/ActionSheetPicker-3.0/pull/56) ([mrtj](https://github.com/mrtj))
## [1.1.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.13) (2014-09-19)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.12...1.1.13)
### Closed issues:
- impossible to run in xcode 6 [\#48](https://github.com/skywinder/ActionSheetPicker-3.0/issues/48)
### Merged pull requests:
- update badge [\#46](https://github.com/skywinder/ActionSheetPicker-3.0/pull/46) ([skywinder](https://github.com/skywinder))
- Add badge [\#45](https://github.com/skywinder/ActionSheetPicker-3.0/pull/45) ([skywinder](https://github.com/skywinder))
- reformat [\#44](https://github.com/skywinder/ActionSheetPicker-3.0/pull/44) ([skywinder](https://github.com/skywinder))
## [1.1.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.12) (2014-09-17)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.11...1.1.12)
### Merged pull requests:
- unexpected action sheet dismissing in portrait mode only [\#40](https://github.com/skywinder/ActionSheetPicker-3.0/pull/40) ([numen31337](https://github.com/numen31337))
- Support ActionSheet width to full-screen-width in 4.7 inch and 5.5 inch devices [\#38](https://github.com/skywinder/ActionSheetPicker-3.0/pull/38) ([nowsprinting](https://github.com/nowsprinting))
## [1.1.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.11) (2014-09-16)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.10...1.1.11)
### Implemented enhancements:
- Pop over direction [\#28](https://github.com/skywinder/ActionSheetPicker-3.0/issues/28)
- ActionSheetDatePicker needs done/cancel blocks [\#37](https://github.com/skywinder/ActionSheetPicker-3.0/issues/37)
### Fixed bugs:
- Show from a presented view controller [\#31](https://github.com/skywinder/ActionSheetPicker-3.0/issues/31)
- ActionSheetStringPicker not showing on iphone [\#30](https://github.com/skywinder/ActionSheetPicker-3.0/issues/30)
### Closed issues:
- ActionSheetPicker needs cancel block to handle hiding [\#39](https://github.com/skywinder/ActionSheetPicker-3.0/issues/39)
### Merged pull requests:
- Notify cancel on popover dismiss [\#34](https://github.com/skywinder/ActionSheetPicker-3.0/pull/34) ([ynop](https://github.com/ynop))
## [1.1.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.10) (2014-09-04)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.9...1.1.10)
### Merged pull requests:
- Method for presenting overlapping views. [\#32](https://github.com/skywinder/ActionSheetPicker-3.0/pull/32) ([serebryakov-av](https://github.com/serebryakov-av))
## [1.1.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.9) (2014-09-03)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.8...1.1.9)
### Merged pull requests:
- Update SWActionSheet.m [\#29](https://github.com/skywinder/ActionSheetPicker-3.0/pull/29) ([serebryakov-av](https://github.com/serebryakov-av))
## [1.1.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.8) (2014-08-29)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.7...1.1.8)
## [1.1.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.7) (2014-08-29)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.6...1.1.7)
## [1.1.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.6) (2014-08-27)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.5...1.1.6)
### Closed issues:
- Still getting warnings [\#16](https://github.com/skywinder/ActionSheetPicker-3.0/issues/16)
### Merged pull requests:
- fix readme code [\#26](https://github.com/skywinder/ActionSheetPicker-3.0/pull/26) ([abeyuya](https://github.com/abeyuya))
## [1.1.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.5) (2014-08-26)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/compilerBug...1.1.5)
### Fixed bugs:
- Toolbar buttons don't appear when Actionsheet is fired from an iPad Form Sheet or Page Sheet [\#22](https://github.com/skywinder/ActionSheetPicker-3.0/issues/22)
## [compilerBug](https://github.com/skywinder/ActionSheetPicker-3.0/tree/compilerBug) (2014-08-26)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.4...compilerBug)
## [1.1.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.4) (2014-08-26)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.3...1.1.4)
### Fixed bugs:
- iOS 8 iPad wrong frame size. [\#18](https://github.com/skywinder/ActionSheetPicker-3.0/issues/18)
### Closed issues:
- iOS8 - iPad popover, wrong size [\#24](https://github.com/skywinder/ActionSheetPicker-3.0/issues/24)
### Merged pull requests:
- fix iOS8 wrong popover size in iPad [\#25](https://github.com/skywinder/ActionSheetPicker-3.0/pull/25) ([AdrianFlorian](https://github.com/AdrianFlorian))
## [1.1.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.3) (2014-08-25)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.2...1.1.3)
### Closed issues:
- Presented in wrong frame when sender is a navbar bar button item [\#23](https://github.com/skywinder/ActionSheetPicker-3.0/issues/23)
- done button color [\#21](https://github.com/skywinder/ActionSheetPicker-3.0/issues/21)
## [1.1.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.2) (2014-08-15)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.1...1.1.2)
### Closed issues:
- Landscape broken in iOS 7 [\#17](https://github.com/skywinder/ActionSheetPicker-3.0/issues/17)
- Invalid context warning in landscape [\#13](https://github.com/skywinder/ActionSheetPicker-3.0/issues/13)
## [1.1.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.1) (2014-08-13)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.18...1.1.1)
## [1.0.18](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.18) (2014-08-12)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.17...1.0.18)
## [1.0.17](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.17) (2014-08-12)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.15...1.0.17)
### Closed issues:
- Issue with iOS 8 beta [\#9](https://github.com/skywinder/ActionSheetPicker-3.0/issues/9)
## [1.0.15](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.15) (2014-08-11)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.14...1.0.15)
## [1.0.14](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.14) (2014-08-01)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.13...1.0.14)
### Merged pull requests:
- Set minimum date properly. [\#14](https://github.com/skywinder/ActionSheetPicker-3.0/pull/14) ([matt](https://github.com/matt))
## [1.0.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.13) (2014-07-30)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.12...1.0.13)
### Closed issues:
- Use with UITableViewCells [\#4](https://github.com/skywinder/ActionSheetPicker-3.0/issues/4)
### Merged pull requests:
- Minute Interval for ActionDatePicker [\#12](https://github.com/skywinder/ActionSheetPicker-3.0/pull/12) ([Jack-s](https://github.com/Jack-s))
## [1.0.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.12) (2014-07-24)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.11...1.0.12)
### Closed issues:
- i get this warning!'sizeWithFont:' is deprecated: first deprecated in iOS 7.0 - Use -sizeWithAttributes: [\#11](https://github.com/skywinder/ActionSheetPicker-3.0/issues/11)
- configurePickerView for ActionSheetCustomPicker throws exception [\#10](https://github.com/skywinder/ActionSheetPicker-3.0/issues/10)
## [1.0.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.11) (2014-07-19)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.10...1.0.11)
## [1.0.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.10) (2014-07-14)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.9...1.0.10)
## [1.0.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.9) (2014-07-07)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.8...1.0.9)
### Fixed bugs:
- Crash when using in 5s iOS 7.1 [\#8](https://github.com/skywinder/ActionSheetPicker-3.0/issues/8)
- On Iphone 4 the ActionSheetStringPicker doesn't work Well [\#5](https://github.com/skywinder/ActionSheetPicker-3.0/issues/5)
## [1.0.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.8) (2014-06-29)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.7...1.0.8)
### Merged pull requests:
- added check for iPhone 4, to fix transparent view background problem. [\#6](https://github.com/skywinder/ActionSheetPicker-3.0/pull/6) ([JaseElder](https://github.com/JaseElder))
## [1.0.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.7) (2014-06-20)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.6...1.0.7)
## [1.0.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.6) (2014-06-11)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.5...1.0.6)
## [1.0.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.5) (2014-05-27)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.4...1.0.5)
## [1.0.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.4) (2014-05-25)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/0.0.4...1.0.4)
## [0.0.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/0.0.4) (2014-05-25)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.3...0.0.4)
### Merged pull requests:
- Convert screenshots over to iOS 7. [\#3](https://github.com/skywinder/ActionSheetPicker-3.0/pull/3) ([markrickert](https://github.com/markrickert))
- Add basic documentation to the readme. [\#2](https://github.com/skywinder/ActionSheetPicker-3.0/pull/2) ([markrickert](https://github.com/markrickert))
## [1.0.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.3) (2014-05-21)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.2...1.0.3)
## [1.0.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.2) (2014-05-21)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.1...1.0.2)
### Merged pull requests:
- Get tint color for actionsheet buttons from application window [\#1](https://github.com/skywinder/ActionSheetPicker-3.0/pull/1) ([Mau04](https://github.com/Mau04))
## [1.0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.1) (2014-05-19)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/0.1...1.0.1)
## [0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/0.1) (2012-05-11)
[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/v0.1...0.1)
## [v0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/v0.1) (2012-05-11)
**Merged pull requests:**
- Here is a test hotfix should appear in v.0.0.2 [\#2](https://github.com/skywinder/changelog_test/pull/2) ([skywinder](https://github.com/skywinder))
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)

View File

@@ -5,72 +5,77 @@ require 'json'
require 'colorize' require 'colorize'
require 'benchmark' require 'benchmark'
require_relative 'github_changelog_generator/parser' require 'github_changelog_generator/parser'
require_relative 'github_changelog_generator/generator' require 'github_changelog_generator/generator'
require_relative 'github_changelog_generator/version' require 'github_changelog_generator/version'
require 'github_changelog_generator/reader'
require 'github_changelog_generator/cli'
module GitHubChangelogGenerator module GitHubChangelogGenerator
class ChangelogGenerator class ChangelogGenerator
attr_accessor :options, :all_tags, :github attr_accessor :options, :all_tags, :github
PER_PAGE_NUMBER = 30 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 def initialize
@options = Parser.parse_options @options = Parser.parse_options
if options[:verbose] fetch_github_token
puts 'Input options:'
pp options
puts ''
end
github_token
github_options = { per_page: PER_PAGE_NUMBER } github_options = { per_page: PER_PAGE_NUMBER }
github_options[:oauth_token] = @github_token unless @github_token.nil? github_options[:oauth_token] = @github_token unless @github_token.nil?
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil? github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil? github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
begin
@github = Github.new github_options @github = Github.new github_options
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
@generator = Generator.new(@options) @generator = Generator.new(@options)
@all_tags = self.get_all_tags @all_tags = get_all_tags
@issues, @pull_requests = self.fetch_issues_and_pull_requests @issues, @pull_requests = fetch_issues_and_pull_requests
if @options[:pulls] if @options[:pulls]
@pull_requests = self.get_filtered_pull_requests @pull_requests = get_filtered_pull_requests
self.fetch_merged_at_pull_requests
else else
@pull_requests = [] @pull_requests = []
end end
if @options[:issues] if @options[:issues]
@issues = self.get_filtered_issues @issues = get_filtered_issues
fetch_event_for_issues(@issues)
detect_actual_closed_dates
else else
@issues = [] @issues = []
end end
fetch_event_for_issues_and_pr
detect_actual_closed_dates
@tag_times_hash = {} @tag_times_hash = {}
end end
def detect_actual_closed_dates def detect_actual_closed_dates
if @options[:verbose] if @options[:verbose]
print "Fetching closed dates for issues...\r" print "Fetching closed dates for issues...\r"
end end
threads = [] threads = []
@issues.each { |issue| @issues.each { |issue|
threads << Thread.new { threads << Thread.new {
find_closed_date_by_commit(issue) find_closed_date_by_commit(issue)
} }
} }
threads.each { |thr| thr.join }
@pull_requests.each { |pull_request|
threads << Thread.new {
find_closed_date_by_commit(pull_request)
}
}
threads.each(&:join)
if @options[:verbose] if @options[:verbose]
puts 'Fetching closed dates for issues: Done!' puts 'Fetching closed dates for issues: Done!'
@@ -79,14 +84,21 @@ module GitHubChangelogGenerator
def find_closed_date_by_commit(issue) def find_closed_date_by_commit(issue)
unless issue['events'].nil? unless issue['events'].nil?
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
compare_string = issue[:merged_at].nil? ? 'closed' : 'merged'
# reverse! - to find latest closed event. (event goes in date order) # reverse! - to find latest closed event. (event goes in date order)
issue['events'].reverse!.each { |event| issue['events'].reverse!.each { |event|
if event[:event].eql? 'closed' if event[:event].eql? compare_string
if event[:commit_id].nil? if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at] issue[:actual_date] = issue[:closed_at]
else else
begin
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id] commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
issue[:actual_date] = commit[:author][:date] issue[:actual_date] = commit[:author][:date]
rescue
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 end
break break
end end
@@ -99,123 +111,82 @@ module GitHubChangelogGenerator
puts JSON.pretty_generate(json) puts JSON.pretty_generate(json)
end end
def exec_command(cmd)
exec_cmd = "cd #{$project_path} and #{cmd}"
%x[#{exec_cmd}]
end
def fetch_merged_at_pull_requests def fetch_merged_at_pull_requests
if @options[:verbose] if @options[:verbose]
print "Fetching pull requests...\r" print "Fetching merged dates...\r"
end end
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
pull_requests = [] pull_requests = []
begin
response = @github.pull_requests.list @options[:user], @options[:project], state: 'closed'
page_i = 0 page_i = 0
response.each_page do |page| response.each_page do |page|
page_i += PER_PAGE_NUMBER page_i += PER_PAGE_NUMBER
count_pages = response.count_pages count_pages = response.count_pages
print "Fetching pull requests... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r" print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
pull_requests.concat(page) pull_requests.concat(page)
end end
print " \r" rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
if @options[:verbose]
puts "Received pull requests: #{pull_requests.count}"
end end
print " \r"
@pull_requests.each { |pr| @pull_requests.each { |pr|
fetched_pr = pull_requests.find { |fpr| fetched_pr = pull_requests.find { |fpr|
fpr.number == pr.number } fpr.number == pr.number
}
pr[:merged_at] = fetched_pr[:merged_at] pr[:merged_at] = fetched_pr[:merged_at]
pull_requests.delete(fetched_pr) pull_requests.delete(fetched_pr)
} }
if @options[:verbose]
puts 'Fetching merged dates: Done!'
end
end end
def get_filtered_pull_requests def get_filtered_pull_requests
fetch_merged_at_pull_requests
pull_requests = @pull_requests filtered_pull_requests = @pull_requests.select { |pr| !pr[:merged_at].nil? }
filtered_pull_requests = pull_requests
unless @options[:include_labels].nil? unless @options[:include_labels].nil?
filtered_pull_requests = pull_requests.select { |issue| filtered_pull_requests = @pull_requests.select { |issue|
#add all labels from @options[:incluse_labels] array # add all labels from @options[:include_labels] array
(issue.labels.map { |label| label.name } & @options[:include_labels]).any? (issue.labels.map(&:name) & @options[:include_labels]).any?
} }
end end
unless @options[:exclude_labels].nil? unless @options[:exclude_labels].nil?
filtered_pull_requests = filtered_pull_requests.select { |issue| filtered_pull_requests = filtered_pull_requests.select { |issue|
# delete all labels from @options[:exclude_labels] array # delete all labels from @options[:exclude_labels] array
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any? !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
} }
end end
if @options[:add_issues_wo_labels] if @options[:add_issues_wo_labels]
issues_wo_labels = pull_requests.select { issues_wo_labels = @pull_requests.select { |issue|
# add issues without any labels !issue.labels.map(&:name).any?
|issue| !issue.labels.map { |label| label.name }.any?
} }
filtered_pull_requests |= issues_wo_labels filtered_pull_requests |= issues_wo_labels
end end
if @options[:verbose] if @options[:verbose]
puts "Filtered pull requests: #{filtered_pull_requests.count}" puts "Filtered pull requests: #{filtered_pull_requests.count}"
end end
filtered_pull_requests filtered_pull_requests
#
# #
#
#
# unless @options[:pull_request_labels].nil?
#
# if @options[:verbose]
# puts 'Filter all pull requests by labels.'
# end
#
# filtered_pull_requests = filtered_pull_requests.select { |pull_request|
# #fetch this issue to get labels array
# issue = @github.issues.get @options[:user], @options[:project], pull_request.number
#
# #compare is there any labels from @options[:labels] array
# issue_without_labels = !issue.labels.map { |label| label.name }.any?
#
# if @options[:verbose]
# puts "Filter request \##{issue.number}."
# end
#
# if @options[:pull_request_labels].any?
# select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
# else
# select_by_label = false
# end
#
# select_by_label | issue_without_labels
# }
#
# if @options[:verbose]
# puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
# end
# return filtered_pull_requests
# end
#
# filtered_pull_requests
end end
def compund_changelog def compound_changelog
log = "# Change Log\n\n" log = "# Change Log\n\n"
if @options[:unreleased_only] 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] elsif @options[:tag1] and @options[:tag2]
tag1 = @options[:tag1] tag1 = @options[:tag1]
tag2 = @options[:tag2] tag2 = @options[:tag2]
tags_strings = [] 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?(tag1)
if tags_strings.include?(tag2) if tags_strings.include?(tag2)
@@ -223,7 +194,7 @@ module GitHubChangelogGenerator
hash = Hash[to_a] hash = Hash[to_a]
index1 = hash[tag1] index1 = hash[tag1]
index2 = hash[tag2] 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 else
puts "Can't find tag #{tag2} -> exit" puts "Can't find tag #{tag2} -> exit"
exit exit
@@ -233,7 +204,7 @@ module GitHubChangelogGenerator
exit exit
end end
else else
log += self.generate_log_for_all_tags log += generate_log_for_all_tags
end end
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*" log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
@@ -242,45 +213,43 @@ module GitHubChangelogGenerator
File.open(output_filename, 'w') { |file| file.write(log) } File.open(output_filename, 'w') { |file| file.write(log) }
puts 'Done!' puts 'Done!'
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}" puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
end end
def generate_log_for_all_tags def generate_log_for_all_tags
fetch_tags_dates fetch_tags_dates
if @options[:verbose] if @options[:verbose]
puts "Sorting tags.." puts 'Sorting tags...'
end end
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse! @all_tags.sort_by! { |x| get_time_of_tag(x) }.reverse!
if @options[:verbose] if @options[:verbose]
puts "Generating log.." puts 'Generating log...'
end end
log = '' log = ''
if @options[:unreleased] 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 if unreleased_log
log += unreleased_log log += unreleased_log
end end
end end
(1 ... self.all_tags.size).each { |index| (1...all_tags.size).each { |index|
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1]) 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 log
end end
def fetch_tags_dates def fetch_tags_dates
if @options[:verbose] if @options[:verbose]
print "Fetching tags dates..\r" print "Fetching tag dates...\r"
end end
# Async fetching tags: # Async fetching tags:
@@ -290,37 +259,32 @@ module GitHubChangelogGenerator
@all_tags.each { |tag| @all_tags.each { |tag|
# explicit set @tag_times_hash to write data safety. # explicit set @tag_times_hash to write data safety.
threads << Thread.new { threads << Thread.new {
self.get_time_of_tag(tag, @tag_times_hash) get_time_of_tag(tag, @tag_times_hash)
if @options[:verbose] if @options[:verbose]
print "Fetching tags dates: #{i + 1}/#{all}\r" print "Fetching tags dates: #{i + 1}/#{all}\r"
i += 1 i += 1
end end
} }
} }
print " \r" print " \r"
threads.each { |thr| thr.join } threads.each(&:join)
if @options[:verbose] if @options[:verbose]
puts 'Fetching tags: Done!' puts "Fetching tags dates: #{i} Done!"
end end
end end
def is_megred(number)
@github.pull_requests.merged? @options[:user], @options[:project], number
end
def get_all_tags def get_all_tags
if @options[:verbose] if @options[:verbose]
print "Fetching tags...\r" print "Fetching tags...\r"
end end
response = @github.repos.tags @options[:user], @options[:project]
tags = [] tags = []
begin
response = @github.repos.tags @options[:user], @options[:project]
page_i = 0 page_i = 0
count_pages = response.count_pages count_pages = response.count_pages
response.each_page do |page| response.each_page do |page|
@@ -329,32 +293,34 @@ module GitHubChangelogGenerator
tags.concat(page) tags.concat(page)
end end
print " \r" print " \r"
if @options[:verbose]
if tags.count == 0
puts "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]
puts "Found #{tags.count} tags" puts "Found #{tags.count} tags"
end end
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
tags tags
end end
def github_token def fetch_github_token
if @options[:token] env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
return @github_token ||= @options[:token]
end
env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil
unless env_var unless env_var
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow 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 puts 'This script can make only 50 requests per hour to GitHub API without a token!'.yellow
end end
@github_token ||= env_var @github_token ||= env_var
end end
def generate_log_between_tags(older_tag, newer_tag) def generate_log_between_tags(older_tag, newer_tag)
# older_tag nil - means it's first tag, newer_tag nil - means it unreleased section # older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, older_tag, newer_tag) 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) filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name'] newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
@@ -368,10 +334,10 @@ module GitHubChangelogGenerator
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil? if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
# do not generate empty unreleased section # do not generate empty unreleased section
return nil return ''
end 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 end
def filter_by_milestone(filtered_issues, newer_tag_name, src_array) def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
@@ -410,11 +376,10 @@ module GitHubChangelogGenerator
end end
def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil) def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
fail 'At least one of the tags should be not nil!' if older_tag.nil? && newer_tag.nil?
raise 'At least on of the tags should be not nil!' if (older_tag.nil? && newer_tag.nil?) newer_tag_time = get_time_of_tag(newer_tag)
older_tag_time = get_time_of_tag(older_tag)
newer_tag_time = self.get_time_of_tag(newer_tag)
older_tag_time = self.get_time_of_tag(older_tag)
array.select { |req| array.select { |req|
if req[hash_key] if req[hash_key]
@@ -432,7 +397,6 @@ module GitHubChangelogGenerator
tag_in_range_new = t <= newer_tag_time tag_in_range_new = t <= newer_tag_time
end end
tag_in_range = (tag_in_range_old) && (tag_in_range_new) tag_in_range = (tag_in_range_old) && (tag_in_range_new)
tag_in_range tag_in_range
@@ -447,24 +411,14 @@ module GitHubChangelogGenerator
# @param [String] older_tag_name # @param [String] older_tag_name
# @return [String] # @return [String]
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil) def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
newer_tag_time = newer_tag.nil? ? nil : self.get_time_of_tag(newer_tag) newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag['name']
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name'] newer_tag_link = newer_tag.nil? ? 'HEAD' : 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]}" project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
if newer_tag.nil? log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
newer_tag_name = 'Unreleased'
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)
if @options[:issues] if @options[:issues]
# Generate issues: # Generate issues:
@@ -494,15 +448,13 @@ module GitHubChangelogGenerator
log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix]) 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(bugs_a, @options[:bug_prefix])
log += generate_log_from_array(issues_a, @options[:issue_prefix]) log += generate_log_from_array(issues_a, @options[:issue_prefix])
end
if @options[:pulls] if @options[:pulls]
# Generate pull requests: # Generate pull requests:
log += generate_log_from_array(pull_requests, @options[:merge_prefix]) log += generate_log_from_array(pull_requests, @options[:merge_prefix])
end end
end
log +="\n"
log log
end end
@@ -512,21 +464,27 @@ module GitHubChangelogGenerator
log += "#{prefix}\n\n" log += "#{prefix}\n\n"
end end
if issues.any?
issues.each { |issue| issues.each { |issue|
merge_string = @generator.get_string_for_issue(issue) merge_string = @generator.get_string_for_issue(issue)
log += "- #{merge_string}\n" log += "- #{merge_string}\n\n"
}
} if issues end
log +="\n" log
end end
def generate_header(log, newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url) def generate_header(newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
log = ''
# Generate date string: # Generate date string:
time_string = newer_tag_time.strftime @options[:format] time_string = newer_tag_time.strftime @options[:dateformat]
# Generate tag name and link # 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"
else
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n" log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
end
if @options[:compare_link] && older_tag_name if @options[:compare_link] && older_tag_name
# Generate compare link # Generate compare link
@@ -537,7 +495,6 @@ module GitHubChangelogGenerator
end end
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash) def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
if tag_name.nil? if tag_name.nil?
return nil return nil
end end
@@ -546,62 +503,66 @@ module GitHubChangelogGenerator
return @tag_times_hash[tag_name['name']] return @tag_times_hash[tag_name['name']]
end end
begin
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha'] github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
time_string = github_git_data_commits_get['committer']['date'] time_string = github_git_data_commits_get['committer']['date']
@tag_times_hash[tag_name['name']] = Time.parse(time_string) @tag_times_hash[tag_name['name']] = Time.parse(time_string)
end end
def get_filtered_issues def get_filtered_issues
issues = @issues issues = @issues
filtered_issues = issues filtered_issues = issues
unless @options[:include_labels].nil? unless @options[:include_labels].nil?
filtered_issues = issues.select { |issue| filtered_issues = issues.select { |issue|
#add all labels from @options[:incluse_labels] array # add all labels from @options[:include_labels] array
(issue.labels.map { |label| label.name } & @options[:include_labels]).any? (issue.labels.map(&:name) & @options[:include_labels]).any?
} }
end end
unless @options[:exclude_labels].nil? unless @options[:exclude_labels].nil?
filtered_issues = filtered_issues.select { |issue| filtered_issues = filtered_issues.select { |issue|
# delete all labels from @options[:exclude_labels] array # delete all labels from @options[:exclude_labels] array
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any? !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
} }
end end
if @options[:add_issues_wo_labels] if @options[:add_issues_wo_labels]
issues_wo_labels = issues.select { issues_wo_labels = issues.select { |issue|
# add issues without any labels !issue.labels.map(&:name).any?
|issue| !issue.labels.map { |label| label.name }.any?
} }
filtered_issues |= issues_wo_labels filtered_issues |= issues_wo_labels
end end
if @options[:verbose] if @options[:verbose]
puts "Filtered issues: #{filtered_issues.count}" puts "Filtered issues: #{filtered_issues.count}"
end end
filtered_issues filtered_issues
end end
def fetch_issues_and_pull_requests def fetch_issues_and_pull_requests
if @options[:verbose] if @options[:verbose]
print "Fetching closed issues...\r" print "Fetching closed issues...\r"
end end
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
issues = [] issues = []
begin
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
page_i = 0 page_i = 0
count_pages = response.count_pages count_pages = response.count_pages
response.each_page do |page| response.each_page do |page|
page_i += PER_PAGE_NUMBER page_i += PER_PAGE_NUMBER
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r" print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
issues.concat(page) issues.concat(page)
break if @options[:max_issues] && issues.length >= @options[:max_issues]
end
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end end
print " \r" print " \r"
@@ -612,42 +573,55 @@ module GitHubChangelogGenerator
# remove pull request from issues: # remove pull request from issues:
issues_wo_pr = issues.select { |x| issues_wo_pr = issues.select { |x|
x.pull_request == nil x.pull_request.nil?
} }
pull_requests = issues.select { |x| pull_requests = issues.select { |x|
x.pull_request != nil !x.pull_request.nil?
} }
return issues_wo_pr, pull_requests [issues_wo_pr, pull_requests]
end end
def fetch_event_for_issues(filtered_issues) def fetch_event_for_issues_and_pr
if @options[:verbose] if @options[:verbose]
print "Fetching events for issues: 0/#{filtered_issues.count}\r" print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
end end
# Async fetching events: # Async fetching events:
threads = []
fetch_events_async(@issues + @pull_requests)
end
def fetch_events_async(issues)
i = 0 i = 0
filtered_issues.each { |issue| max_thread_number = 50
threads = []
issues.each_slice(max_thread_number) { |issues_slice|
issues_slice.each { |issue|
threads << Thread.new { threads << Thread.new {
begin
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number'] obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
rescue
puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
end
issue[:events] = obj.body issue[:events] = obj.body
print "Fetching events for issues: #{i+1}/#{filtered_issues.count}\r" print "Fetching events for issues and PR: #{i + 1}/#{@issues.count + @pull_requests.count}\r"
i += 1 i += 1
} }
} }
threads.each { |thr| thr.join } threads.each(&:join)
threads = []
}
# to clear line from prev print
print " \r"
if @options[:verbose] if @options[:verbose]
puts "Fetching events for issues: Done!" puts "Fetching events for issues and PR: #{i} Done!"
end
end end
end end
if __FILE__ == $PROGRAM_NAME
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
end end
if __FILE__ == $0
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
end
end end

View File

@@ -0,0 +1,62 @@
#
# 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 'thor'
module GitHubChangelogGenerator
class CLI < Thor
default_task :generate
desc 'generate', 'Generates the CHANGELOG.md based on the given options'
option :user, aliases: '-u', type: :string, desc: 'Username of the owner of target GitHub repo'
option :project, aliases: '-p', type: :string, desc: 'Username of the owner of target GitHub repo'
option :token, aliases: '-t', type: :string, desc: 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new'
option :date_format, aliases: '-f', type: :string, default: '%d/%m/%y', desc: 'Date format.'
option :output, aliases: '-o', type: :string, default: 'CHANGELOG.md', desc: 'Output file.'
# TODO: Should be "closed_issues"
option :issues, type: :boolean, default: true, desc: 'Include closed issues to changelog.'
option :issues_wo_labels, type: :boolean, default: true, desc: 'Include closed issues without labels to changelog.'
option :pr_wo_labels, type: :boolean, default: true, desc: 'Include pull requests without labels to changelog.'
option :pull_requests, type: :boolean, default: true, desc: 'Include pull-requests to changelog.'
option :filter_by_milestone, type: :boolean, default: true, desc: 'Use milestone to detect when issue was resolved.'
option :author, type: :boolean, default: true, desc: 'Add author of pull-request in the end.'
option :unreleased_only, type: :boolean, default: true, desc: 'Generate log from unreleased closed issues only.'
option :unreleased, type: :boolean, default: true, desc: 'Add to log unreleased closed issues.'
option :unreleased_label, type: :boolean, default: true, desc: 'Add to log unreleased closed issues.'
option :compare_link, type: :boolean, default: true, desc: 'Include compare link (Full Changelog) between older version and newer version.'
option :include_labels, type: :array, default: %w(bug enhancement), desc: 'Issues only with that labels will be included to changelog.'
option :exclude_labels, type: :array, default: %w(duplicate question invalid wontfix), desc: 'Issues with that labels will be always excluded from changelog.'
option :max_issues, type: :numeric, desc: 'Max number of issues to fetch from GitHub. Default is unlimited'
option :github_site, :banner => 'URL', type: :string, desc: 'The Enterprise Github site on which your project is hosted.'
option :github_api, :banner => 'URL', type: :string, desc: 'The enterprise endpoint to use for your Github API.'
option :simple_list, type: :boolean, default: false, desc: 'Create simple list from issues and pull requests.'
option :verbose, type: :boolean, default: true, desc: 'Run verbosely.'
long_desc <<-LONGDESC
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
LONGDESC
def generate
end
map %w[--version -v] => :__print_version
desc '--version, -v', 'print the version'
def __print_version
puts "Version: #{GitHubChangelogGenerator::VERSION}"
end
end
end

View File

@@ -1,38 +1,35 @@
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Generator class Generator
def initialize(options = nil) def initialize(options = nil)
@options = options @options = options
end end
def get_string_for_issue(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})"
merge = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
unless issue.pull_request.nil? unless issue.pull_request.nil?
if @options[:author] if @options[:author]
if issue.user.nil? if issue.user.nil?
merge += " ({Null user})\n\n" title_with_number += ' ({Null user})'
else else
merge += " ([#{issue.user.login}](#{issue.user.html_url}))\n\n" title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
end end
end end
end end
merge += "\n" title_with_number
end end
def encapsulate_string(string) def encapsulate_string(string)
string.gsub! '\\', '\\\\' string.gsub! '\\', '\\\\'
encpas_chars = %w(> * _ \( \) [ ]) encpas_chars = %w(> * _ \( \) [ ] #)
encpas_chars.each { |char| encpas_chars.each do |char|
string.gsub! char, "\\#{char}" string.gsub! char, "\\#{char}"
} end
string string
end end
end end
end end

View File

@@ -6,56 +6,60 @@ require_relative 'version'
module GitHubChangelogGenerator module GitHubChangelogGenerator
class Parser class Parser
def self.parse_options def self.parse_options
# :include_labels => %w(bug enhancement), options = {
hash = { tag1: nil,
:tag1 => nil, tag2: nil,
:tag2 => nil, dateformat: '%Y-%m-%d',
:format => '%Y-%m-%d', output: 'CHANGELOG.md',
:output => 'CHANGELOG.md', issues: true,
:exclude_labels => %w(duplicate question invalid wontfix), add_issues_wo_labels: true,
:pulls => true, add_pr_wo_labels: true,
:issues => true, pulls: true,
:verbose => true, filter_issues_by_milestone: true,
:add_issues_wo_labels => true, author: true,
:add_pr_wo_labels => true, unreleased: true,
:merge_prefix => '#### Merged pull requests:', unreleased_label: 'Unreleased',
:issue_prefix => '#### Closed issues:', compare_link: true,
:bug_prefix => '#### Fixed bugs:', include_labels: %w(bug enhancement),
:enhancement_prefix => '#### Implemented enhancements:', exclude_labels: %w(duplicate question invalid wontfix),
:author => true, max_issues: nil,
:filter_issues_by_milestone => true, simple_list: false,
:compare_link => true, verbose: true,
:unreleased => true
}
options = hash
parser = OptionParser.new { |opts| merge_prefix: '**Merged pull requests:**',
opts.banner = 'Usage: changelog_generator [options]' issue_prefix: '**Closed issues:**',
bug_prefix: '**Fixed bugs:**',
enhancement_prefix: '**Implemented enhancements:**',
branch: 'origin'
}
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| opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
options[:user] = last options[:user] = last
end 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 options[:project] = last
end 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 options[:token] = last
end end
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last| opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %Y-%m-%d') do |last|
options[:format] = last options[:dateformat] = last
end 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 options[:output] = last
end 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 options[:issues] = v
end 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 options[:add_issues_wo_labels] = v
end 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 options[:add_pr_wo_labels] = v
end 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 options[:pulls] = v
end 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|
@@ -70,15 +74,21 @@ module GitHubChangelogGenerator
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 options[:unreleased] = v
end end
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 options[:compare_link] = v
end 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 options[:include_labels] = list
end 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 options[:exclude_labels] = list
end end
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| opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
options[:github_site] = last options[:github_site] = last
end end
@@ -91,7 +101,7 @@ module GitHubChangelogGenerator
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v| opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
options[:verbose] = v options[:verbose] = v
end end
opts.on('-v', '--version', 'Print version number') do |v| opts.on('-v', '--version', 'Print version number') do |_v|
puts "Version: #{GitHubChangelogGenerator::VERSION}" puts "Version: #{GitHubChangelogGenerator::VERSION}"
exit exit
end end
@@ -99,7 +109,7 @@ module GitHubChangelogGenerator
puts opts puts opts
exit exit
end end
} end
parser.parse! parser.parse!
@@ -121,19 +131,29 @@ module GitHubChangelogGenerator
options[:project] = match[2] options[:project] = match[2]
end end
end end
if !options[:user] && !options[:project] if !options[:user] && !options[:project]
remote = `git remote -vv`.split("\n") remote = `git config --get remote.#{options[:branch]}.url`
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0]) # try to find repo in format:
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
# git@github.com:skywinder/Github-Changelog-Generator.git
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
if match && match[1] && match[2]
puts "Detected user:#{match[1]}, project:#{match[2]}"
options[:user], options[:project] = match[1], match[2]
else
# try to find repo in format:
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
if match && match[1] && match[2] if match && match[1] && match[2]
puts "Detected user:#{match[1]}, project:#{match[2]}" puts "Detected user:#{match[1]}, project:#{match[2]}"
options[:user], options[:project] = match[1], match[2] options[:user], options[:project] = match[1], match[2]
end end
end end
end
if !options[:user] || !options[:project] if !options[:user] || !options[:project]
puts parser.banner puts parser.banner
@@ -145,6 +165,12 @@ module GitHubChangelogGenerator
options[:tag2] = ARGV[1] options[:tag2] = ARGV[1]
end end
if options[:verbose]
puts 'Performing task with options:'
pp options
puts ''
end
options options
end 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 module GitHubChangelogGenerator
VERSION = '1.3.0' VERSION = '1.3.11'
end 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)*

114
spec/spec_helper.rb Normal file
View File

@@ -0,0 +1,114 @@
#
# 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 'coveralls'
require 'simplecov'
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
SimpleCov::Formatter::HTMLFormatter,
Coveralls::SimpleCov::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