Compare commits

..

602 Commits

Author SHA1 Message Date
Petr Korolev
0c96db9490 Merge branch 'aw/all-merged' of https://github.com/olleolleolle/github-changelog-generator into olleolleolle-aw/all-merged 2016-09-29 19:12:21 +03:00
Petr Korolev
b027884a68 Merge pull request #420 from olleolleolle/feature/travis-with-2.4.0
Travis: Test on 2.4.0-preview2
2016-09-29 18:51:10 +03:00
Olle Jonsson
1c8a2d29ea Style: Use attr_reader for options
- prefer parentheses
2016-09-28 00:49:10 +02:00
Olle Jonsson
fe0fd94ea3 Typo: variable rename 2016-09-28 00:14:26 +02:00
Olle Jonsson
3fc0012de2 VCR: Try to use frobnitz as default token 2016-09-28 00:10:51 +02:00
Olle Jonsson
de525fb1e8 Typo, renamed var 2016-09-27 23:54:17 +02:00
Olle Jonsson
cacd6dc3c8 Travis: Specific gemfiles 2016-09-27 23:50:32 +02:00
Olle Jonsson
db1ffdd59b Linting 2016-09-27 23:44:49 +02:00
Olle Jonsson
0189c2d736 Remove Gemfile.lock 2016-09-27 23:05:41 +02:00
Olle Jonsson
559defcb55 VCR to censor ENV['CHANGELOG_GITHUB_TOKEN'] 2016-09-27 23:03:41 +02:00
Olle Jonsson
0fc6da1a75 Style 2016-09-27 23:03:40 +02:00
Olle Jonsson
4b50b5b257 GeneratorTagsSpec: change name of a test 2016-09-27 23:03:04 +02:00
Olle Jonsson
f98cc8f292 OctoFetcher spec: The new assignees field 2016-09-27 23:03:04 +02:00
Olle Jonsson
8056600180 Style: use the short form for RSpec metadata 2016-09-27 23:02:27 +02:00
Olle Jonsson
6d45d90a5f Drop Hashie dependency 2016-09-27 23:01:14 +02:00
Olle Jonsson
3df84403c4 WIP Remove github_api gem, smaller dependencies
- use VCR with metadata instead of macros
  - upgrade colorize gem
2016-09-27 23:00:34 +02:00
Andrew Waage
1763f9c8ea fixed a bug in fetching tags 2016-09-27 22:58:55 +02:00
Andrew Waage
180b4cb6c9 fixed one bug in filtering excluded tags 2016-09-27 22:58:55 +02:00
Andrew Waage
b82aa64eee fixed 1 bug to work with octokit api 2016-09-27 22:58:55 +02:00
Andrew Waage
cb6286fb83 merged in the tag fixes 2016-09-27 22:58:55 +02:00
Andrew Waage
7dcf617d61 fixed bug in each_with_object 2016-09-27 22:57:43 +02:00
Andrew Waage
e89b03fe48 fixing rubocop and removing original fetcher 2016-09-27 22:56:30 +02:00
Andrew Waage
9ff27b690f max thread 1 2016-09-27 22:46:16 +02:00
Andrew Waage
bcf57dbe0e changing max threads to 4 2016-09-27 22:46:16 +02:00
Andrew Waage
4cfb1e4a5f cleaned up caching and added to options parser 2016-09-27 22:46:16 +02:00
Andrew Waage
b81f8a4169 minor clean up 2016-09-27 22:46:16 +02:00
Andrew Waage
3179f29a7c fixed some handling of hashes 2016-09-27 22:46:16 +02:00
Andrew Waage
aee2f43235 made old fetcher compatible 2016-09-27 22:46:16 +02:00
Andrew Waage
63b3de1281 fixing specs 2016-09-27 22:46:16 +02:00
Andrew Waage
0517674f04 one more place for stringify keys 2016-09-27 22:46:16 +02:00
Andrew Waage
53b0684e67 stringify more keys 2016-09-27 22:46:16 +02:00
Andrew Waage
ca5d6d9675 using strings instead of symbols 2016-09-27 22:46:16 +02:00
Andrew Waage
3cb3584bb9 reverting the old fetcher where I changed to string 2016-09-27 22:45:10 +02:00
Andrew Waage
4fb674b68e added specs for the new octo_fetcher. Also had to refactor a bit to deal with hashes and arrays instead of objects 2016-09-27 22:45:10 +02:00
Andrew Waage
e494fc004e added VCR and specs for original fetcher 2016-09-27 22:38:25 +02:00
Andrew Waage
4ecb21c0b0 first pass at caching. still WIP. Need to parameterize some things 2016-09-27 22:37:26 +02:00
Andrew Waage
3cf2802d9a fixed some bugs and how errors were rescued 2016-09-27 22:34:30 +02:00
Andrew Waage
507b89c665 changed the format of how dates are fetched from commit 2016-09-27 22:34:30 +02:00
Andrew Waage
cd14a86f84 changed the rescued exceptions 2016-09-27 22:34:30 +02:00
Andrew Waage
5d7098282d moved parse_url_for_vars to private method 2016-09-27 22:34:30 +02:00
Andrew Waage
0751082526 clean up 2016-09-27 22:34:30 +02:00
Andrew Waage
baa4e3e659 created a new fetcher with octokit. functionality should remain same 2016-09-27 22:34:30 +02:00
Olle Jonsson
963e18820a README: Add Gitter badge (#413) 2016-09-27 22:25:35 +02:00
Olle Jonsson
dcd15d1f5d Merge pull request #421 from olleolleolle/fix/coverage-skip-logger-helper
Skip logger helper in coverage
2016-09-27 22:24:17 +02:00
Olle Jonsson
e2020bbab3 Skip logger helper in coverage 2016-09-27 22:08:18 +02:00
Olle Jonsson
725194acc0 SimpleCov config: Ignore gemfiles folder 2016-09-27 21:40:23 +02:00
Olle Jonsson
30ffc0e945 Travis: Get rid of Gemfile.lock 2016-09-27 21:31:17 +02:00
Olle Jonsson
3ab802ae7a Travis: Test on 2.4.0-preview2 2016-09-27 21:25:44 +02:00
Olle Jonsson
fac944786b Merge pull request #417 from skywinder/fix/move-deps-about
Travis: Collecting the config, gemspec: extract development deps to Gemfile
2016-09-26 16:23:37 +02:00
Olle Jonsson
88cad51b06 Travis: The bare test can not work on 2.1. Try 2.2.2 2016-09-22 19:35:52 +02:00
Olle Jonsson
f57dcd5be4 README: Explain the use of Gemfiles for older rubies 2016-09-22 19:35:31 +02:00
Olle Jonsson
7f8131d5cd Lint: avoid multi-line ternary operator 2016-09-22 19:17:23 +02:00
Olle Jonsson
04215618a2 Lint: frozen-string-literal 2016-09-22 19:16:29 +02:00
Olle Jonsson
f226343233 Rubocop rule: Disable too-modern ones 2016-09-22 19:16:00 +02:00
Olle Jonsson
5c21fc980f Rubocop setting: avoid copping the universe 2016-09-22 19:04:35 +02:00
Olle Jonsson
334fd3497a Travis: Introduce gemfiles 2016-09-22 18:50:19 +02:00
Olle Jonsson
443d59769f Ruby version file for the CircleCI tests 2016-09-22 18:41:26 +02:00
Olle Jonsson
b9c0a2f736 Travis: Give up 2016-09-22 18:37:05 +02:00
Olle Jonsson
9bd44b010f Gemfile: Try to keep rack runnable on 2.1 again again again 2016-09-22 18:33:31 +02:00
Olle Jonsson
98ddde0094 Gemfile: Try to keep rack runnable on 2.1 again again 2016-09-22 18:30:20 +02:00
Olle Jonsson
22d8113ade Gemfile: Try to keep rack runnable on 2.1 again 2016-09-22 18:29:14 +02:00
Olle Jonsson
1c69994c8a Gemfile: Try to keep rack runnable on 2.1 2016-09-22 18:27:13 +02:00
Olle Jonsson
99c58d3b94 Travis: Collecting the config
- comment
  - tighter matrix
  - pull out development dependencies into the Gemfile
2016-09-22 18:20:58 +02:00
Olle Jonsson
cdd4b7f201 Merge pull request #415 from dijonkitchen/patch-1
Update README.md
2016-09-18 13:55:04 +02:00
Jonathan Chen
94820df2f4 Update README.md 2016-09-18 06:48:52 -04:00
Olle Jonsson
e402eae344 Merge pull request #411 from olleolleolle/feature/community-gitter
CircleCI hook for Gitter notification
2016-09-08 14:10:42 +02:00
Olle Jonsson
7f3ef24b3f circle.yml: Notify chat room as well as Lobby 2016-09-05 21:48:21 +02:00
Olle Jonsson
74c752c3ce CircleCI hook for Gitter notification 2016-09-01 22:02:01 +02:00
Olle Jonsson
d4140f05c9 Merge pull request #409 from olleolleolle/specs/avoid-a-warning-by-using-stub-const
Spec: avoid Ruby warning about already-defined constant
2016-09-01 21:24:48 +02:00
Olle Jonsson
96491a21e0 Merge pull request #408 from jamesc/jc/remove-colorize
Replace GPL'd colorize gem with MIT-licensed rainbow
2016-09-01 21:15:42 +02:00
Olle Jonsson
b259b186a7 Rainbow library: do not extend String
- do not include all the rainbow presenter methods directly in the
    String class
2016-09-01 11:51:53 -07:00
Olle Jonsson
7e77fd6c57 Drop all local color method calls
- The central logging method decides the color of the output
  - pass Rubocop complaints
2016-09-01 11:50:17 -07:00
Olle Jonsson
91b5abc477 Spec: avoid warning when stubbing ARGV 2016-09-01 20:47:31 +02:00
James Casey
f647dc0d98 Change to use Rainbow instead of colorize
colorize is licensed under GPL-2 which conflicts with the MIT license of
github_changelog_generator.  This changes all usage of colorize to
rainbow which does have a compatible license (MIT)
2016-08-31 14:27:39 -07:00
Olle Jonsson
d23375f5ac Merge pull request #405 from jkeiser/jk/error2
Report actual github error when rate limit exceeded
2016-08-11 00:19:35 +02:00
Olle Jonsson
cbb435511b Merge pull request #407 from jkeiser/jk/thread-cap
Limit number of simultaneous requests to 25
2016-08-10 09:19:42 +02:00
John Keiser
27f2536a0e Limit number of simultaneous requests to 25 2016-08-09 18:42:58 -07:00
John Keiser
07f4e530a4 Report actual github error when rate limit exceeded
Also, don't report rate limit exceeded error unless the rate limit was exceeded.
2016-08-09 13:28:52 -07:00
Olle Jonsson
15de60e1d1 Merge pull request #404 from jkeiser/jk/error-message
Make error messages print on error
2016-08-09 00:26:08 +02:00
John Keiser
c66b0f9aff Make error messages print on error 2016-08-08 12:49:02 -07:00
Petr Korolev
b02e8402b3 Merge branch 'hotfix/update-changelog' 2016-07-22 11:17:55 +03:00
Petr Korolev
7388ca8581 Update changelog for version 1.13.1 2016-07-22 11:17:53 +03:00
Petr Korolev
059e4d4bc3 Merge branch 'release/1.13.1' 2016-07-22 11:16:54 +03:00
Petr Korolev
6c2ef97f63 Update gemspec to version 1.13.1 2016-07-22 11:16:51 +03:00
Olle Jonsson
226748d8ff Merge pull request #401 from skywinder/fix-397
Ability to implicity set user and project from command line
2016-07-22 09:06:44 +02:00
Petr Korolev
74882ef900 fix quote escape 2016-07-22 09:28:06 +03:00
Petr Korolev
37a7430d81 add test 2016-07-21 17:48:47 +03:00
Petr Korolev
939f6fd768 THis fix #397 2016-07-21 17:48:46 +03:00
Petr Korolev
f32a02a75b remove unused puts 2016-07-21 17:47:53 +03:00
Petr Korolev
430d6f5bd9 add missing test 2016-07-21 17:47:53 +03:00
Petr Korolev
4f57845465 rename methods to match of it's actions 2016-07-21 17:47:52 +03:00
John Keiser
4969108eca Constrain JSON to < 2.0 so we can test on ruby 1.9 2016-07-21 17:47:52 +03:00
John Keiser
c0c8bb5653 Don't constrain runtime deps.
Since we are a development dependency of many projects,
constraining our runtime deps can cause their Gemfiles to downgrade
dependencies they share with us, which is never desirable.
2016-07-21 17:47:52 +03:00
Petr Korolev
fdd41a22f6 Merge branch 'master' into develop 2016-07-20 16:55:49 +03:00
Olle Jonsson
08c3d9f913 Merge pull request #399 from edusantana/raketask
Show how to use it with Rakefile
2016-07-18 19:02:34 +02:00
Eduardo de Santana Medeiros Alexandre
1c48f633d8 Show how to use it with Rakefile
It was missing the require statement.
2016-07-18 13:58:26 -03:00
Olle Jonsson
f6fcac7aff README: Formatting detail 2016-07-14 16:47:26 +02:00
Olle Jonsson
074320d925 Merge pull request #396 from cormacmccarthy/patch-2
Adds documentation on using a GHE endpoint
2016-07-14 16:38:17 +02:00
Christopher McCulloh
bb87462e3a Addresses some formatting issues 2016-07-13 20:56:41 -04:00
Olle Jonsson
9acfcf103c Merge pull request #391 from olleolleolle/feature/parser-docstrings
Parser: YARD docstrings and a rename, and RegExp named capture groups
2016-07-14 00:34:44 +02:00
Christopher McCulloh
25c7856e19 Adds documentation on using a GHE endpoint 2016-07-12 16:03:02 -04:00
Olle Jonsson
49f8df24aa Merge pull request #393 from perlun/patch-1
Added a missing OPTION
2016-07-06 14:19:51 +02:00
Per Lundberg
408b12111d Added a missing OPTION
I noted that this was missing when trying to use it. 😄
2016-07-06 15:12:22 +03:00
Petr Korolev
f169ea688e Merge branch 'hotfix/update-changelog' into develop 2016-07-04 11:12:44 +03:00
Petr Korolev
a3b32ca2df Merge branch 'hotfix/update-changelog' 2016-07-04 11:12:44 +03:00
Petr Korolev
55fba0f479 Update changelog for version 1.13.0 2016-07-04 11:12:42 +03:00
Petr Korolev
d13d22eb01 Merge branch 'release/1.13.0' into develop 2016-07-04 11:11:46 +03:00
Petr Korolev
c2083a4df5 Merge branch 'release/1.13.0' 2016-07-04 11:11:45 +03:00
Petr Korolev
0c2e62954d Update gemspec to version 1.13.0 2016-07-04 11:11:43 +03:00
Petr Korolev
f09a6183a4 Merge pull request #392 from olleolleolle/feature/phase-usernames-as-github-logins
Carry PR #301: usernames_as_github_logins
2016-07-04 11:10:47 +03:00
Olle Jonsson
3962474e9f usernames_as_github_logins: Use option 2016-07-02 17:20:31 +02:00
Olle Jonsson
58bfa047c4 Option usernames_as_github_logins: Mention Markdown 2016-07-02 17:19:54 +02:00
phase
59db1c7821 CLI option for GitHub tags
Not actually implemented yet
2016-07-02 17:10:56 +02:00
phase
0e671a96da Remove trailing whitespace 2016-07-02 17:10:56 +02:00
phase
4c737c9373 Extract username tagging 2016-07-02 17:10:56 +02:00
phase
df31f98ce3 Use GitHub tags to reference GitHub users
This will use @tags to notify the contributor that their contribution is in the changelog.

As discussed in https://github.com/github/linguist/pull/2698#issuecomment-150887871
2016-07-02 17:10:56 +02:00
Olle Jonsson
b63d9d623e Parser: RegExp with named capture groups 2016-07-02 10:49:49 +02:00
Olle Jonsson
d9e2cdeeac Parser: YARD docstrings and a rename 2016-07-02 10:33:15 +02:00
Petr Korolev
8bd4578e44 check that page is not nil 2016-06-06 10:23:38 +03:00
Petr Korolev
9483c5edcb update changelog 2016-05-09 15:27:44 +03:00
Petr Korolev
ac06e8bffe Merge branch 'hotfix/update-changelog' into develop 2016-05-09 15:24:22 +03:00
Petr Korolev
e66242794b Merge branch 'hotfix/update-changelog' 2016-05-09 15:24:22 +03:00
Petr Korolev
c2fd582c2d Update changelog for version 1.12.1 2016-05-09 15:24:20 +03:00
Petr Korolev
0f5562264c Merge branch 'release/1.12.1' into develop 2016-05-09 15:23:22 +03:00
Petr Korolev
3253c278be Merge branch 'release/1.12.1' 2016-05-09 15:23:22 +03:00
Petr Korolev
29540ced2c Update gemspec to version 1.12.1 2016-05-09 15:23:19 +03:00
Petr Korolev
8de9efbc35 update gemfile 2016-05-09 15:22:56 +03:00
Petr Korolev
7d5c954b28 This should fix #364 2016-05-09 15:22:56 +03:00
Olle Jonsson
63ece13cca Include LICENSE in distributed files 2016-05-09 15:22:56 +03:00
Olle Jonsson
fc831b746c Add MIT LICENSE file
This resolves #369.
2016-05-09 15:22:56 +03:00
Olle Jonsson
7c14a112eb linting 2016-05-09 15:22:56 +03:00
Olle Jonsson
e42b747585 Linting 2016-05-09 15:22:56 +03:00
Olle Jonsson
ceb1b5f843 Spec: Smaller help functions 2016-05-09 15:22:56 +03:00
Olle Jonsson
01a254e412 Avoid nil bug in detect_since_tag 2016-05-09 15:22:56 +03:00
Petr Korolev
aa677df3ca Merge pull request #373 from skywinder/development_dependency
Move dev gems to add_development_dependency
2016-05-09 15:22:17 +03:00
Petr Korolev
79f1b90ff8 fix rubocop checks 2016-05-09 15:08:09 +03:00
Petr Korolev
8722a309e6 update gemfile 2016-05-09 14:49:32 +03:00
Petr Korolev
ce87cecb4a This should fix #364 2016-05-09 14:43:59 +03:00
Petr Korolev
65b0ff8496 Merge pull request #370 from olleolleolle/fix/license-file
Add MIT LICENSE file
2016-05-05 13:04:49 +03:00
Olle Jonsson
8d4ab6c09c Include LICENSE in distributed files 2016-04-30 12:03:15 +02:00
Olle Jonsson
42dbedabb7 Add MIT LICENSE file
This resolves #369.
2016-04-30 11:55:39 +02:00
Olle Jonsson
1a19286ea0 Merge pull request #368 from olleolleolle/fix/issue-with-detect-tags
Avoid nil bug in detect_since_tag
2016-04-18 17:10:48 +02:00
Olle Jonsson
cc653b6b21 linting 2016-04-18 16:53:45 +02:00
Olle Jonsson
9ce5c76d4a Linting 2016-04-18 16:53:25 +02:00
Olle Jonsson
86ca388ecf Spec: Smaller help functions 2016-04-18 16:53:25 +02:00
Olle Jonsson
9c6068f026 Avoid nil bug in detect_since_tag 2016-04-18 16:53:25 +02:00
Petr Korolev
0dddc4a44c Merge branch 'hotfix/update-changelog' into develop 2016-04-01 13:33:21 +03:00
Petr Korolev
253fe49648 Merge branch 'hotfix/update-changelog' 2016-04-01 13:33:20 +03:00
Petr Korolev
663d4d8c81 Update changelog for version 1.12.0 2016-04-01 13:33:19 +03:00
Petr Korolev
dcd50239c5 Merge branch 'release/1.12.0' into develop 2016-04-01 13:32:35 +03:00
Petr Korolev
6a51c0b435 Merge branch 'release/1.12.0' 2016-04-01 13:32:34 +03:00
Petr Korolev
7b78c3f8d0 Update gemspec to version 1.12.0 2016-04-01 13:32:32 +03:00
Petr Korolev
519ca91cd7 Merge pull request #320 from ITV/filter-tags
Added tag exclusion with a filter (string or regex)
2016-03-28 13:04:06 +03:00
Petr Korolev
2e2cc16fe3 Merge branch 'develop' 2016-03-28 13:00:18 +03:00
Petr Korolev
5c9c05ca19 fix rubocop warrnings 2016-03-28 12:59:58 +03:00
Adam
507ffdb910 put filter_excluded_tags_regex after filter_excluded_tags tests 2016-03-24 13:00:53 +00:00
Adam
21d41756b8 regex test include regex identifier 2016-03-24 13:00:02 +00:00
Adam
17ceccdd70 clean up test description 2016-03-24 12:54:19 +00:00
Adam
61ec650801 refactor 2016-03-24 12:40:42 +00:00
Adam
6a0ade1194 refactor 2016-03-24 12:22:33 +00:00
Adam
e5a619b167 add test for #filter_excluded_tags_regex with non-matching regex in exclude_tags 2016-03-24 12:06:39 +00:00
Adam
dd149d7ad9 implement #filter_excluded_tags_regex with regex exclude_tags 2016-03-24 11:59:20 +00:00
Petr Korolev
1c37268c3d Merge branch 'hotfix/update-changelog' into develop 2016-03-22 14:38:51 +02:00
Petr Korolev
92a2e47436 Merge branch 'hotfix/update-changelog' 2016-03-22 14:38:50 +02:00
Petr Korolev
cdc971e86f Update changelog for version 1.11.8 2016-03-22 14:38:49 +02:00
Petr Korolev
84d81a6456 Merge branch 'release/1.11.8' into develop 2016-03-22 14:38:02 +02:00
Petr Korolev
61bfba69c5 Merge branch 'release/1.11.8' 2016-03-22 14:38:02 +02:00
Petr Korolev
11d85bff41 Update gemspec to version 1.11.8 2016-03-22 14:37:59 +02:00
Petr Korolev
944ad69092 Merge pull request #360 from olleolleolle/feature/avoid-git-in-gemspec
Replace shelling-out-to-Git w/ Dir call
2016-03-22 14:27:32 +02:00
Petr Korolev
c798266695 Merge pull request #356 from olleolleolle/feature/drop-extension-building-on-gem-install
On gem install, do not try to copy manpage files in the "extensions" step
2016-03-22 14:27:25 +02:00
Olle Jonsson
170eb40f33 Replace shelling-out-to-Git w/ Dir call 2016-03-21 22:43:19 +01:00
Petr Korolev
6d9fcf202e Merge pull request #358 from olleolleolle/feature/parserfile-allow-comments
ParserFile: Allow comments in settings file
2016-03-21 13:50:07 +02:00
Olle Jonsson
0fccc4396f ParserFile: Config format allows empty lines
- defined as: lines that consist only of whitespace
2016-03-19 17:12:30 +01:00
Olle Jonsson
068af037f5 Spec: use RSpec contexts 2016-03-19 16:54:13 +01:00
Olle Jonsson
4569fad479 ParserFile: Allow comments in settings file
- Ruby-style or semi-colon-style accepted
2016-03-19 16:50:39 +01:00
Olle Jonsson
c5a92b71b2 Merge pull request #357 from olleolleolle/feature/spec-allow-file-object-for-parsefile
ParserFile: fail parsing with config file line number; use a File instead of a filename
2016-03-19 16:32:24 +01:00
Olle Jonsson
7c2b95d24b ParserFile: shorter error message due to context 2016-03-19 16:17:10 +01:00
Olle Jonsson
1a289c872d ParserFile: rename private method 2016-03-19 16:09:34 +01:00
Olle Jonsson
6b64d4e4a2 Docs 2016-03-19 15:50:05 +01:00
Olle Jonsson
0b32484184 Spec: rename local to noun 2016-03-19 15:22:45 +01:00
Olle Jonsson
a997d2417d Spec: Config parse fail message tested 2016-03-19 15:20:48 +01:00
Olle Jonsson
29b5ef3d53 ParserFile: config failure line number 2016-03-19 15:18:20 +01:00
Olle Jonsson
2e8e2a62e1 ParserFile: removed public method 2016-03-19 15:13:12 +01:00
Olle Jonsson
15d92cea45 ParserFile: Drop unused public method 2016-03-19 15:09:08 +01:00
Olle Jonsson
93df2d5646 ParserFile: use a File instead of a filename
- spec: can use StringIOs instead of loose files
2016-03-19 13:59:58 +01:00
Olle Jonsson
deba7efa49 On install, do not try to copy manpage files 2016-03-19 10:30:33 +01:00
Olle Jonsson
f9ad19285e Merge pull request #355 from olleolleolle/refactor/name-constant-irregular-options
Refactor: call it option_name, instead of key_sym
2016-03-19 09:46:09 +01:00
Olle Jonsson
5071b596d2 Refactor: call it option_name
- also, add a IRREGULAR_OPTIONS hash
2016-03-19 09:40:42 +01:00
Olle Jonsson
9150cdc09e Merge pull request #354 from olleolleolle/bugfix/351-exclude_tags
Parse options file options into arrays, integers, flags, and other
2016-03-18 08:59:15 +01:00
Olle Jonsson
669ac73466 Merge pull request #353 from jkeiser/jk/maybe-failure
Add a `bundle install` test
2016-03-18 07:27:32 +01:00
Olle Jonsson
c6b12454d9 Merge pull request #345 from skywinder/docs/readme-add-github-token-scope-to-readme
README: Document GitHub token URI scope
2016-03-17 21:53:33 +01:00
Olle Jonsson
1519d16cef README: only document how to use &scopes=repo 2016-03-17 21:50:14 +01:00
Olle Jonsson
655aa965a7 Spec: option name translation tested 2016-03-17 21:38:28 +01:00
Olle Jonsson
d0bd44e0c8 Translate option names 2016-03-17 21:08:17 +01:00
Olle Jonsson
44bbd9ca01 Parse options file options
- this proof-of-concept code duplicates OptionParser information to
   get something going
 - take care to respect the type of each option from the OptionParser
2016-03-17 20:39:49 +01:00
John Keiser
a7ee304f20 Add bundle install test 2016-03-09 10:37:25 -08:00
Olle Jonsson
42b3955c06 Merge pull request #350 from Arcanemagus/add-appveyor
Add an AppVeyor config
2016-03-05 00:43:49 +01:00
Landon Abney
9cb03fa745 Add an AppVeyor config 2016-03-04 15:38:23 -08:00
Petr Korolev
1391eefcd8 Merge branch 'hotfix/update-changelog' into develop 2016-03-04 12:05:35 +02:00
Petr Korolev
8e659072e8 Merge branch 'hotfix/update-changelog' 2016-03-04 12:05:34 +02:00
Petr Korolev
ce68ab3685 Update changelog for version 1.11.7 2016-03-04 12:05:33 +02:00
Petr Korolev
d53bba3939 Merge branch 'release/1.11.7' into develop 2016-03-04 12:04:50 +02:00
Petr Korolev
18aea22cd6 Merge branch 'release/1.11.7' 2016-03-04 12:04:50 +02:00
Petr Korolev
ce97e212c2 Update gemspec to version 1.11.7 2016-03-04 12:04:47 +02:00
Petr Korolev
cd53e1cd9a Merge branch 'master' into develop 2016-03-04 12:03:54 +02:00
Olle Jonsson
677b0d8c50 Merge pull request #347 from skywinder/add-authors
Add Olle Jonsson as co-author
2016-03-02 08:29:57 +01:00
Petr Korolev
8df1bbad13 Add Olle Jonsson as co-author 2016-03-02 09:12:47 +02:00
Petr Korolev
86386ff7e6 Merge pull request #346 from skywinder/fix/gemspec-default-date
Gemspec, default date
2016-03-02 09:08:14 +02:00
Olle Jonsson
197a438c09 Gemspec, default date 2016-03-02 06:27:11 +01:00
Petr Korolev
8caa577686 Merge branch 'hotfix/update-changelog' into develop 2016-03-01 16:44:17 +02:00
Petr Korolev
d188facd92 Merge branch 'hotfix/update-changelog' 2016-03-01 16:44:16 +02:00
Petr Korolev
f5bdd30d47 Update changelog for version 1.11.6 2016-03-01 16:44:15 +02:00
Petr Korolev
edb1fade20 Merge branch 'release/1.11.6' into develop 2016-03-01 16:43:30 +02:00
Petr Korolev
542a0948fc Merge branch 'release/1.11.6' 2016-03-01 16:43:30 +02:00
Petr Korolev
aaa71d1ed0 Update gemspec to version 1.11.6 2016-03-01 16:43:27 +02:00
Petr Korolev
11ea9eccb1 Merge pull request #343 from skywinder/feature/skip-date-in-gemspec
Gemspec: Calculate date using Date stdlib
2016-03-01 16:23:29 +02:00
Olle Jonsson
7ab1ee1c21 Gemspec: Use Ruby to calculate YYYY-MM-DD date 2016-03-01 14:54:59 +01:00
Petr Korolev
6fa2f2701e Merge branch 'hotfix/update-changelog' into develop 2016-03-01 11:19:55 +02:00
Petr Korolev
2bdaf31da7 Merge branch 'hotfix/update-changelog' 2016-03-01 11:19:54 +02:00
Petr Korolev
6e8a9cb6ce Update changelog for version 1.11.5 2016-03-01 11:19:52 +02:00
Petr Korolev
867337b58e Merge branch 'release/1.11.5' into develop 2016-03-01 11:19:07 +02:00
Petr Korolev
4687b0b025 Merge branch 'release/1.11.5' 2016-03-01 11:19:06 +02:00
Petr Korolev
eca1ffa418 Update gemspec to version 1.11.5 2016-03-01 11:19:03 +02:00
Olle Jonsson
7d92087f4a Merge pull request #341 from skywinder/Fix/return-not-allowed-in-block
Update Rakefile to avoid install-breaking bug
2016-02-29 17:34:52 +01:00
Olle Jonsson
f1a6a79865 Merge pull request #344 from jkeiser/jk/travis-clean-install
Test clean install in Travis
2016-02-29 17:33:49 +01:00
John Keiser
5b46a24f0b Test clean install in Travis 2016-02-29 08:27:30 -08:00
Olle Jonsson
2a1e7daa1d Skip date in gemspec 2016-02-29 15:35:17 +01:00
Olle Jonsson
c76cfd1920 Update Rakefile 2016-02-28 22:13:23 +01:00
Petr Korolev
d3ea8a1b0c Merge branch 'hotfix/update-changelog' into develop 2016-02-26 13:18:58 +02:00
Petr Korolev
7ea80547c5 Merge branch 'hotfix/update-changelog' 2016-02-26 13:18:58 +02:00
Petr Korolev
b4dcd8a0d9 Update changelog for version 1.11.4 2016-02-26 13:18:56 +02:00
Petr Korolev
3d13f9c4b3 Merge branch 'release/1.11.4' into develop 2016-02-26 13:18:14 +02:00
Petr Korolev
76df82fe0b Merge branch 'release/1.11.4' 2016-02-26 13:18:14 +02:00
Petr Korolev
12734dbbe1 Update gemspec to version 1.11.4 2016-02-26 13:18:11 +02:00
Olle Jonsson
d33dcced8f Rake task: enable the default task again 2016-02-26 13:17:54 +02:00
Olle Jonsson
4a9f6fdd43 Gemfile now with test deps, too 2016-02-26 13:17:54 +02:00
Olle Jonsson
32f14e685b Rake task: Try finding a writable manpath
- OS X, Ubuntu manpath files checked
2016-02-26 13:17:54 +02:00
Olle Jonsson
85d5352e6e Look in /etc/manpaths for writable paths 2016-02-26 13:17:54 +02:00
Olle Jonsson
637de14699 Check if man path is writable before writing 2016-02-26 13:17:54 +02:00
Olle Jonsson
925f6fd3f0 Man page copying: only copy .1
- check if possible first
2016-02-26 13:17:54 +02:00
Petr Korolev
568db9e519 Merge pull request #338 from olleolleolle/feature/neutralize-man-page-generation
Man page copying: only copy .1
2016-02-26 13:17:19 +02:00
Olle Jonsson
9b7273f009 Rake task: enable the default task again 2016-02-25 20:29:01 +01:00
Olle Jonsson
08cacdc5ec Gemfile now with test deps, too 2016-02-25 20:26:03 +01:00
Olle Jonsson
159173d86a Rake task: Try finding a writable manpath
- OS X, Ubuntu manpath files checked
2016-02-25 20:13:32 +01:00
Olle Jonsson
c111488376 Look in /etc/manpaths for writable paths 2016-02-25 19:56:25 +01:00
Olle Jonsson
5bc90a32ae Check if man path is writable before writing 2016-02-25 19:43:10 +01:00
Olle Jonsson
772e403e40 Man page copying: only copy .1
- check if possible first
2016-02-25 19:43:10 +01:00
Petr Korolev
fe2162030b Merge branch 'hotfix/update-changelog' into develop 2016-02-25 20:20:15 +02:00
Petr Korolev
ee86b35068 Merge branch 'hotfix/update-changelog' 2016-02-25 20:20:15 +02:00
Petr Korolev
93e29e8e81 Update changelog for version 1.11.3 2016-02-25 20:20:15 +02:00
Petr Korolev
5bff64de19 Merge branch 'release/1.11.3' into develop 2016-02-25 20:18:23 +02:00
Petr Korolev
780ebdf0eb Merge branch 'release/1.11.3' 2016-02-25 20:18:22 +02:00
Petr Korolev
c5837ad9f0 Update gemspec to version 1.11.3 2016-02-25 20:18:22 +02:00
Petr Korolev
17a1b23059 comment out Rakefile to temporary solve installation issue #329 2016-02-25 20:17:34 +02:00
Petr Korolev
7205a060b3 Merge branch 'hotfix/update-changelog' 2016-02-25 15:42:19 +02:00
Petr Korolev
471fe6f312 Merge branch 'hotfix/update-changelog' into develop 2016-02-25 15:42:19 +02:00
Petr Korolev
40df2c7dac Update changelog for version 1.11.2 2016-02-25 15:42:18 +02:00
Petr Korolev
aa87c803ca Merge branch 'release/1.11.2' into develop 2016-02-25 15:41:37 +02:00
Petr Korolev
6962b5e7b2 Merge branch 'release/1.11.2' 2016-02-25 15:41:36 +02:00
Petr Korolev
407bf86e57 Update gemspec to version 1.11.2 2016-02-25 15:41:34 +02:00
Petr Korolev
cff1e8c5ed create manual only by default 2016-02-25 15:41:15 +02:00
Petr Korolev
8e9ff4cb8a Merge pull request #337 from skywinder/fix-install
Fix installation by not running the specs - which have dependencies
2016-02-25 15:35:29 +02:00
Petr Korolev
3e045e3b42 create manual only by default 2016-02-25 15:28:11 +02:00
Petr Korolev
0bfd702d21 Merge branch 'hotfix/update-changelog' into develop 2016-02-25 12:03:31 +02:00
Petr Korolev
c762f82917 Merge branch 'hotfix/update-changelog' 2016-02-25 12:03:30 +02:00
Petr Korolev
b510b2c3fb Update changelog for version 1.11.1 2016-02-25 12:03:28 +02:00
Petr Korolev
f45dc26aba Merge branch 'release/1.11.1' into develop 2016-02-25 12:02:46 +02:00
Petr Korolev
78361faaa9 Merge branch 'release/1.11.1' 2016-02-25 12:02:46 +02:00
Petr Korolev
5898dd4eb9 Update gemspec to version 1.11.1 2016-02-25 12:02:42 +02:00
Petr Korolev
6706b10311 rubocop autofix 2016-02-25 12:00:45 +02:00
Petr Korolev
827afcda02 Merge branch 'master' into develop 2016-02-25 11:56:17 +02:00
Petr Korolev
94c52a17e2 bump to yanked version 2016-02-25 11:50:24 +02:00
Petr Korolev
4af3d1cb06 Merge pull request #336 from jkeiser/jk/rubocop-dep
Add rubocop and rspec as runtime dependencies
2016-02-25 11:48:47 +02:00
John Keiser
b5df8e1e76 Use less restrictive versioning so we don't block other projects 2016-02-24 12:55:39 -08:00
John Keiser
2f179649b9 Add rubocop and rspec as runtime dependencies 2016-02-24 11:05:54 -08:00
Petr Korolev
9a217e3468 rubocop correction 2016-02-24 16:31:18 +02:00
Petr Korolev
035e160f5e Merge pull request #332 from olleolleolle/feature/exclude-issues-by-labels
[Refactor] Generator#exclude_issues_by_labels simpler, tested
2016-02-24 16:30:14 +02:00
Petr Korolev
60517bffe9 Merge pull request #334 from olleolleolle/feature/refactor-parser-file-to-pathname
[Refactor] ParserFile class use Pathname
2016-02-24 16:16:17 +02:00
Petr Korolev
402e70f677 Merge branch 'release/1.10.4' into develop 2016-02-24 15:13:35 +02:00
Petr Korolev
5b192f9e43 Merge branch 'release/1.10.4' 2016-02-24 15:13:14 +02:00
Petr Korolev
1167706335 Update gemspec to version 1.10.4 2016-02-24 15:11:01 +02:00
Petr Korolev
63c70edb25 add pending message 2016-02-24 15:10:32 +02:00
Petr Korolev
0b3e8429c4 rubocop fixes 2016-02-24 15:10:32 +02:00
Olle Jonsson
20c22defc2 Rake and Bundler as runtime deps
To support Rakefile running at install. See #329
2016-02-24 15:10:32 +02:00
Olle Jonsson
bc6bfac2a3 Typo 2016-02-24 15:10:32 +02:00
Olle Jonsson
fb502c0ac7 Spec: Avoid a deprecation 2016-02-24 15:10:32 +02:00
Olle Jonsson
575f42f652 Test case for #327 2016-02-24 15:10:32 +02:00
John Keiser
92fbf47960 If Rakefile is an extension, any requires are runtime deps 2016-02-24 15:10:32 +02:00
Petr Korolev
32ab582797 Merge pull request #333 from skywinder/feature/bug-329-promote-rake-and-bundler-to-runtime-deps
Rake and Bundler as runtime deps
2016-02-24 14:56:50 +02:00
Olle Jonsson
4e6906dccf Add default options filename as constant 2016-02-23 23:54:20 +01:00
Olle Jonsson
179f110b8a Pathnames to iterate over lines, check existence 2016-02-23 23:46:23 +01:00
Olle Jonsson
06585b1c69 Rake and Bundler as runtime deps
To support Rakefile running at install. See #329
2016-02-23 23:39:53 +01:00
Olle Jonsson
89d1b5393d Generator#exclude_issues_by_labels spec clearer 2016-02-23 23:23:54 +01:00
Olle Jonsson
87b9962a8d Refactoring: introduce local, return early
- use #reject
  - add basic spec around it
2016-02-23 23:17:37 +01:00
Petr Korolev
4ceb065cae Merge pull request #331 from olleolleolle/feature/bug-327
Test case for #327
2016-02-23 23:56:34 +02:00
Petr Korolev
cf55352620 Merge pull request #330 from jkeiser/jk/rakefile-dep
Fix crash installing on systems without overcommit
2016-02-23 23:48:20 +02:00
Olle Jonsson
540251ab60 Typo 2016-02-23 22:28:24 +01:00
Olle Jonsson
74f93460bc Spec: Avoid a deprecation 2016-02-23 22:25:07 +01:00
Olle Jonsson
b8f7dbaa2e Test case for #327 2016-02-23 22:24:10 +01:00
John Keiser
74655cce06 If Rakefile is an extension, any requires are runtime deps 2016-02-23 12:25:59 -08:00
Petr Korolev
bc13534d88 Merge branch 'hotfix/update-changelog' into develop 2016-02-23 17:46:05 +02:00
Petr Korolev
e27a471fc8 Merge branch 'hotfix/update-changelog' 2016-02-23 17:46:04 +02:00
Petr Korolev
af90816a96 Update changelog for version 1.10.3 2016-02-23 17:46:02 +02:00
Petr Korolev
1f330a3c18 Merge branch 'release/1.10.3' into develop 2016-02-23 17:45:17 +02:00
Petr Korolev
0627b6c701 Merge branch 'release/1.10.3' 2016-02-23 17:45:17 +02:00
Petr Korolev
bfdb5debec Update gemspec to version 1.10.3 2016-02-23 17:45:13 +02:00
Petr Korolev
e871613d62 Fix #329 ? 2016-02-23 17:44:16 +02:00
Petr Korolev
589dc13938 Merge branch 'hotfix/update-changelog' into develop 2016-02-23 17:21:46 +02:00
Petr Korolev
9a842dae26 Merge branch 'hotfix/update-changelog' 2016-02-23 17:21:45 +02:00
Petr Korolev
bf84a6b479 Update changelog for version 1.10.2 2016-02-23 17:21:43 +02:00
Petr Korolev
843470273c Merge branch 'release/1.10.2' into develop 2016-02-23 17:21:01 +02:00
Petr Korolev
1e405b48ff Merge branch 'release/1.10.2' 2016-02-23 17:20:42 +02:00
Petr Korolev
3a7dbf8138 Update gemspec to version 1.10.2 2016-02-23 17:19:38 +02:00
Petr Korolev
857b9e6f53 rubocop updates 2016-02-23 17:19:14 +02:00
Petr Korolev
2691a3ef96 Revert "Rubocop fixes"
This reverts commit fa0267b586.
2016-02-23 17:19:14 +02:00
Petr Korolev
62623ff2dd update changelog 2016-02-23 17:19:14 +02:00
Petr Korolev
a0f28d3393 update gemfile 2016-02-23 17:19:13 +02:00
Petr Korolev
88e9a3ec88 update gemscpec 2016-02-23 17:19:13 +02:00
Petr Korolev
4fcde1eb28 update rakefile 2016-02-23 17:19:13 +02:00
Petr Korolev
b3cfe76702 update rubocop todo 2016-02-23 17:19:13 +02:00
Petr Korolev
6edf473e25 update changelog 2016-02-23 12:45:14 +02:00
Petr Korolev
13315f4c9d Merge branch 'develop' 2016-02-23 12:43:12 +02:00
Petr Korolev
9149bad71e update gemfile 2016-02-23 12:40:55 +02:00
Petr Korolev
0a562afdf7 update gemscpec 2016-02-23 12:39:49 +02:00
Petr Korolev
be1fd28bcf update rakefile 2016-02-23 12:38:27 +02:00
Petr Korolev
a88622a8a6 update rubocop todo 2016-02-23 12:38:18 +02:00
Petr Korolev
70035737cf Merge branch 'release/1.11.0' into develop 2016-02-23 12:26:50 +02:00
Petr Korolev
0a83b5ed5e Merge branch 'release/1.11.0' 2016-02-23 12:26:49 +02:00
Petr Korolev
fa0267b586 Rubocop fixes 2016-02-23 12:25:55 +02:00
Petr Korolev
a9313dab6b update bundle 2016-02-23 11:55:19 +02:00
Petr Korolev
73cba095b2 Fix #328 2016-02-23 11:41:43 +02:00
Petr Korolev
259105f265 Merge branch 'master' into develop 2016-02-23 11:28:13 +02:00
Dlani Mendes
4058369710 Adjusts Run Post Install 2016-02-17 14:37:41 +02:00
Petr Korolev
341fb109ab Genrated files by command ronn ./man/git-generate-changelog.md 2016-02-17 14:37:41 +02:00
Petr Korolev
a15e45da94 add md man file 2016-02-17 14:37:41 +02:00
Dlani Mendes
2ce8fd07ce Git Subcommand 2016-02-17 14:37:41 +02:00
Zearin
78e5f06cc6 Update README.md
Lots of small edits to fix English grammar, phrasing, and formatting.
2016-02-17 14:37:40 +02:00
retorquere
c2032e1235 placate rubocop 2016-02-17 14:37:40 +02:00
retorquere
6f17e7c236 YAML front matter 2016-02-17 14:37:40 +02:00
Petr Korolev
e673c94ab9 Merge pull request #288 from dlanileonardo/master
Git Subcommand
2016-02-17 14:35:19 +02:00
Dlani Mendes
12f3b76348 Adjusts Run Post Install 2016-02-17 09:13:14 -02:00
Petr Korolev
4c73f4bc68 Genrated files by command ronn ./man/git-generate-changelog.md 2016-02-17 09:13:14 -02:00
Petr Korolev
cea26c2fdd add md man file 2016-02-17 09:13:14 -02:00
Dlani Mendes
b4f6cc14d3 Git Subcommand 2016-02-17 09:13:14 -02:00
Petr Korolev
4f43e86957 Merge pull request #324 from Zearin/patch-1
Update README.md
2016-02-12 12:41:00 +02:00
Zearin
2b56fe986b Update README.md
Lots of small edits to fix English grammar, phrasing, and formatting.
2016-02-11 10:54:49 -05:00
Olle Jonsson
dd3a618d23 Merge pull request #322 from retorquere/front-matter
Introduce frontmatter option: YAML front matter for GitHub Pages
2016-02-03 14:25:39 +01:00
retorquere
42a284b0e0 placate rubocop 2016-02-03 14:15:08 +01:00
retorquere
a282e6c53e YAML front matter 2016-02-03 13:56:44 +01:00
soundstep
1bae4ea204 filter-tags - Rename option. 2016-01-22 15:11:12 +00:00
soundstep
a676650993 filter-tags - Remove unused index. 2016-01-22 13:34:24 +00:00
soundstep
40dec5346b filter-tags - Added capability to exclude tags with a regular expression by filtering names. 2016-01-22 13:32:31 +00:00
Petr Korolev
d36c67c063 Merge branch 'hotfix/update-changelog' into develop 2016-01-06 09:15:32 +02:00
Petr Korolev
4f932fda1a Merge branch 'hotfix/update-changelog' 2016-01-06 09:15:32 +02:00
Petr Korolev
e745a89ac1 Update changelog for version 1.10.1 2016-01-06 09:15:30 +02:00
Petr Korolev
e7f691ad03 Merge branch 'release/1.10.1' into develop 2016-01-06 09:14:45 +02:00
Petr Korolev
7aed6aa528 Merge branch 'release/1.10.1' 2016-01-06 09:14:45 +02:00
Petr Korolev
9ddc676a44 Update gemspec to version 1.10.1 2016-01-06 09:14:41 +02:00
Olle Jonsson
1b9a251c6b linting 2016-01-06 09:14:09 +02:00
Olle Jonsson
88ec105c7d Parser: avoid Ruby exit
- made the method take three arguments
- specs all note these three
2016-01-06 09:14:08 +02:00
Petr Korolev
3a784b16d6 Merge pull request #315 from skywinder/feature/repair-recognizing-user-and-project
Parser: avoid Ruby exit, to make Rake tasks work
2016-01-06 09:13:32 +02:00
Olle Jonsson
0cc7065efc linting 2016-01-05 21:59:39 +01:00
Olle Jonsson
53df784ec3 Parser: avoid Ruby exit
- made the method take three arguments
- specs all note these three
2016-01-05 21:58:13 +01:00
Petr Korolev
d81cb5fcb7 Merge branch 'develop' 2016-01-05 16:50:27 +02:00
Petr Korolev
8c8c7c4d3c bundle update 2016-01-05 16:50:16 +02:00
Petr Korolev
34b8fc7217 Merge branch 'hotfix/update-changelog' 2016-01-05 16:45:33 +02:00
Petr Korolev
6d02c509cd Merge branch 'hotfix/update-changelog' into develop 2016-01-05 16:45:33 +02:00
Petr Korolev
ac1c70978d Update changelog for version 1.10.0 2016-01-05 16:45:31 +02:00
Petr Korolev
670ced30e3 Merge branch 'release/1.10.0' 2016-01-05 16:44:48 +02:00
Petr Korolev
b0b4b1cf0a Merge branch 'release/1.10.0' into develop 2016-01-05 16:44:48 +02:00
Petr Korolev
af97beeb60 Update gemspec to version 1.10.0 2016-01-05 16:44:45 +02:00
Petr Korolev
384b080ad0 Merge pull request #305 from SteveGilvarry/Add_Release_Branch
Fixes #280 Add release-branch option to filter the Pull Requests
2016-01-05 16:43:43 +02:00
Steve Gilvarry
0e4c775ce4 Revert changes made for trying to use github_options
Reverting other changes made that I missed.
2016-01-05 21:31:38 +11:00
Steve Gilvarry
c6eac743b6 Merge pull request #1 from skywinder/SteveGilvarry-Add_Release_Branch
Steve gilvarry add release branch
2016-01-05 21:04:31 +11:00
Petr Korolev
033c7e8d79 Merge branch 'develop' 2016-01-05 12:01:40 +02:00
Petr Korolev
bffe7cd9ff issue 20 in test repo didn't appear in change log. 2016-01-05 11:28:44 +02:00
Petr Korolev
9832dce93c works! 2016-01-05 11:18:04 +02:00
Petr Korolev
d2fa9d3565 Merge branch 'develop' into SteveGilvarry-Add_Release_Branch 2016-01-05 11:07:44 +02:00
Petr Korolev
8f7af37d1e update changelog 2016-01-05 11:04:18 +02:00
Steve Gilvarry
12bc3550e1 Fix Trailing Whitespace error
Rubocop was stopping this from building on Travis.
2016-01-03 07:11:49 +11:00
Steve Gilvarry
5d5a48e00e Remove debug code 2016-01-03 07:06:25 +11:00
Steve Gilvarry
35b581240f Reinstate User and Repo options
Trying to use github options to hold repo and user didn’t seem to work
for all commands. Reverting those changes
2016-01-03 07:02:19 +11:00
Steve Gilvarry
01a0c05a02 Merge remote-tracking branch 'skywinder/master' into Add_Release_Branch 2016-01-02 21:23:37 +11:00
Petr Korolev
90ea75c471 Merge branch 'master' into develop 2015-11-22 11:03:09 +02:00
Petr Korolev
46aaa5f205 Merge pull request #306 from SteveGilvarry/patch-1
Update bundler
2015-11-22 11:02:23 +02:00
Petr Korolev
95d32abbcb Move from legacy code 2015-11-22 10:55:24 +02:00
Petr Korolev
47c0332b55 Merge branch 'master' into develop 2015-11-22 10:48:55 +02:00
Steve Gilvarry
c63b2e1fb9 Update bundler
Standard Bundler in Travis is old and causes build issues, well that is the theory. This will update bundler.

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

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

    > a = [1,2,3]
     => [1, 2, 3]
    > a.each do |e|
    >   p a
    >   a.delete(e)
    > end
    [1, 2, 3]
    [2, 3]
     => [2]
2015-08-27 13:36:41 +02:00
Petr Korolev
0140986091 Merge branch 'hotfix/update-changelog' into develop 2015-08-26 17:06:17 +03:00
Petr Korolev
312fe3d45a Merge branch 'hotfix/update-changelog' 2015-08-26 17:06:17 +03:00
Petr Korolev
be2340ddcb http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/ 2015-08-26 17:06:07 +03:00
Petr Korolev
f29061e75a Update changelog for version 1.8.2 2015-08-26 17:02:49 +03:00
Petr Korolev
de531262c8 Merge branch 'release/1.8.2' into develop 2015-08-26 17:02:02 +03:00
Petr Korolev
35d520d251 Merge branch 'release/1.8.2' 2015-08-26 17:02:02 +03:00
Petr Korolev
1589df3959 Update gemspec to version 1.8.2 2015-08-26 17:02:00 +03:00
Petr Korolev
a0779a5811 This fix #270 2015-08-26 17:01:18 +03:00
Petr Korolev
c611e907e0 Merge branch 'hotfix/update-changelog' into develop 2015-08-25 17:33:34 +03:00
Petr Korolev
42c94c4dd2 Merge branch 'hotfix/update-changelog' 2015-08-25 17:33:33 +03:00
Petr Korolev
16f01dbda1 resolve 2015-08-25 17:33:22 +03:00
Petr Korolev
f285176e25 Update changelog for version 1.8.1 2015-08-25 17:32:45 +03:00
Petr Korolev
ca1ae124af Merge branch 'release/1.8.1' into develop 2015-08-25 17:31:57 +03:00
Petr Korolev
672c89dcc8 Merge branch 'release/1.8.1' 2015-08-25 17:31:56 +03:00
Petr Korolev
5a5de9ee4a Update gemspec to version 1.8.1 2015-08-25 17:31:54 +03:00
Petr Korolev
7e21aacecc simpify expressin & update change log 2015-08-25 17:31:05 +03:00
Petr Korolev
a9f50cd82e Update README.md 2015-08-25 17:31:05 +03:00
Petr Korolev
0b0a762a80 update change log 2015-08-25 17:31:05 +03:00
Raphaël Pinson
0fae7e0f9e Use since_tag as default for older_tag 2015-08-25 17:31:05 +03:00
Raphaël Pinson
953d2813fb Honor labels in PRs, fix #266 2015-08-25 17:31:04 +03:00
Petr Korolev
abd7175eef simpify expressin & update change log 2015-08-25 17:28:07 +03:00
Petr Korolev
8fab94702f Merge pull request #266 from raphink/dev/pr_labels
Honor labels for Pull Requests
2015-08-25 17:27:39 +03:00
Petr Korolev
ef332dd02b Update README.md 2015-08-25 16:56:52 +03:00
Petr Korolev
83ae430dd8 update change log 2015-08-25 16:08:58 +03:00
Petr Korolev
8c0974200c Merge pull request #267 from raphink/dev/older_tag
Use since_tag as default for older_tag
2015-08-25 16:08:06 +03:00
Petr Korolev
28e3ed2500 Merge branch 'develop' 2015-08-25 15:25:00 +03:00
Petr Korolev
1bf5644a72 Merge branch 'feature/fix-262' into develop 2015-08-25 15:15:41 +03:00
Petr Korolev
bc37d0277b update change log 2015-08-25 15:15:30 +03:00
Petr Korolev
c4846b7ef9 Merge branch 'develop' into feature/fix-262 2015-08-25 15:10:04 +03:00
Petr Korolev
d09dad30f4 update change log 2015-08-25 15:08:09 +03:00
Raphaël Pinson
31e98fbc41 Use since_tag as default for older_tag 2015-08-25 13:55:29 +02:00
Petr Korolev
82dd0b3cce This commit close #262 2015-08-25 14:27:40 +03:00
Petr Korolev
1ae86e3cb2 rename and convert string to sybol 2015-08-25 13:14:04 +03:00
Raphaël Pinson
b3eea83ae1 Honor labels in PRs, fix #266 2015-08-25 10:28:27 +02:00
Petr Korolev
7e4d546f60 Merge branch 'hotfix/update-changelog' into develop 2015-08-24 18:31:55 +03:00
Petr Korolev
be62b92fa9 Merge branch 'hotfix/update-changelog' 2015-08-24 18:31:53 +03:00
Petr Korolev
0b6d751388 Update changelog for version 1.8.0 2015-08-24 18:31:31 +03:00
Petr Korolev
410921f673 Merge branch 'release/1.8.0' into develop 2015-08-24 17:55:25 +03:00
Petr Korolev
8b49b5ac0c Merge branch 'release/1.8.0' 2015-08-24 17:55:25 +03:00
Petr Korolev
d7b5d77bbf Update gemspec to version 1.8.0 2015-08-24 17:55:23 +03:00
Petr Korolev
ddf2624bf9 Merge branch 'develop' 2015-08-24 17:53:06 +03:00
Petr Korolev
80b40d1b36 Merge branch 'feature/due-tag' into develop 2015-08-24 17:52:09 +03:00
Petr Korolev
e8e4628261 Merge branch 'master' into develop 2015-08-24 17:51:14 +03:00
Petr Korolev
4261c3494e Add due-tag option and tests 2015-08-24 17:29:07 +03:00
Petr Korolev
d138644925 add docs 2015-08-24 16:47:37 +03:00
Petr Korolev
0301dcb672 Merge pull request #264 from raphink/dev/release_url
Add release_url to rake task options
2015-08-24 16:01:42 +03:00
Raphaël Pinson
73d4415e14 Add release_url to rake task options 2015-08-24 14:55:57 +02:00
Petr Korolev
ed179ed7be Merge branch 'master' into develop 2015-08-24 14:54:53 +03:00
Petr Korolev
0930cfdd88 Update README.md 2015-08-24 14:54:41 +03:00
Petr Korolev
c140349a73 git push origin masterMerge branch 'raphink-dev/no_replace' 2015-08-24 14:43:39 +03:00
Petr Korolev
8c35215697 Merge branch 'dev/no_replace' of https://github.com/raphink/github-changelog-generator into raphink-dev/no_replace 2015-08-24 14:43:05 +03:00
Petr Korolev
840b6666e0 Merge pull request #263 from skywinder/revert-261-patch-1
Revert "Fixed Readme, I think"
2015-08-24 14:38:34 +03:00
Petr Korolev
7b7c6fc793 Revert "Fixed Readme, I think" 2015-08-24 14:28:22 +03:00
Petr Korolev
2357875c13 Merge pull request #261 from dpwspoon/patch-1
Fixed Readme, I think
2015-08-24 14:05:22 +03:00
David Witherspoon
cac840c57d Fixed Readme, I think
I don't know where a 16 digit token comes from.  But the 40 digit token works.  So I think this is a typo.
2015-08-21 09:31:01 -07:00
Raphaël Pinson
9acca33bc2 Test if @options[:base] is set 2015-08-12 16:35:47 +02:00
Petr Korolev
4aa9c61520 Merge pull request #259 from raphink/dev/release_url
Add release_url option
2015-08-09 17:08:52 +03:00
Petr Korolev
f49949147c Merge pull request #260 from raphink/dev/rake_task
Add a rake task
2015-08-09 17:06:32 +03:00
Raphaël Pinson
bfae7b9a45 Auto detect since tag from base file 2015-08-05 10:57:08 +02:00
Raphaël Pinson
4202b95076 Add --base option 2015-08-05 10:40:28 +02:00
Raphaël Pinson
4856a3c8e9 Add release_url option 2015-08-05 10:31:16 +02:00
Raphaël Pinson
5d9b44eac3 Add a rake task 2015-08-05 10:26:29 +02:00
Petr Korolev
295cfbc767 Merge pull request #257 from raphink/dev/since_tag
Add --since-tag, close
2015-08-04 18:42:03 +03:00
Raphaël Pinson
32f4df5742 Add --since-tag option
Fix #254
2015-08-04 16:15:33 +02:00
Raphaël Pinson
0190d417c2 Typo 2015-08-04 14:56:39 +02:00
Petr Korolev
b6efcfced8 Merge branch 'hotfix/update-changelog' into develop 2015-07-16 17:26:54 +03:00
Petr Korolev
b74b457ad0 Merge branch 'hotfix/update-changelog' 2015-07-16 17:26:52 +03:00
Petr Korolev
83cc36959a update 2015-07-16 17:25:32 +03:00
Petr Korolev
2dbf975c06 Update changelog for version 1.7.0 2015-07-16 17:23:52 +03:00
Petr Korolev
63e91d8e72 Merge branch 'release/1.7.0' into develop 2015-07-16 17:22:58 +03:00
Petr Korolev
d081130e3e Merge branch 'release/1.7.0' 2015-07-16 17:22:58 +03:00
Petr Korolev
016f5e690c Update gemspec to version 1.7.0 2015-07-16 17:22:56 +03:00
Petr Korolev
925012049f bundle update 2015-07-16 17:18:36 +03:00
Petr Korolev
b9593f7c70 update versions 2015-07-16 17:18:03 +03:00
Petr Korolev
e6d80b0cf0 update gemfile 2015-07-16 17:04:50 +03:00
Petr Korolev
a4a6e6dedb bundler update 2015-07-16 16:37:50 +03:00
Petr Korolev
f215694ffb update chanhelog 2015-07-16 15:32:02 +03:00
Petr Korolev
68a045da22 fix: fix help message 2015-07-16 15:29:17 +03:00
Petr Korolev
e274f9992a fix #251 2015-07-16 14:47:01 +03:00
Petr Korolev
4de98a7d16 fix #242 2015-07-16 14:36:25 +03:00
Petr Korolev
d21651776c fix for #242 2015-07-16 14:32:11 +03:00
Petr Korolev
77d86b1e91 Merge branch 'hotfix/update-changelog' into develop 2015-07-16 12:30:15 +03:00
Petr Korolev
cb4533abf7 Merge branch 'hotfix/update-changelog' 2015-07-16 12:30:14 +03:00
Petr Korolev
df47a88b47 Update changelog for version 1.6.2 2015-07-16 12:30:13 +03:00
Petr Korolev
8c6b783d6c Merge branch 'release/1.6.2' into develop 2015-07-16 12:29:27 +03:00
Petr Korolev
9e84bfbabf Merge branch 'release/1.6.2' 2015-07-16 12:29:26 +03:00
Petr Korolev
57b33ae6b9 Update gemspec to version 1.6.2 2015-07-16 12:29:24 +03:00
Petr Korolev
36346b5fc6 Fix #250 2015-07-16 12:24:43 +03:00
Petr Korolev
f24780eb19 add direct link for token generation 2015-06-15 16:56:48 +03:00
Petr Korolev
f77f90a750 Merge branch 'hotfix/update-changelog' into develop 2015-06-12 11:42:58 +03:00
Petr Korolev
d33994d595 Merge branch 'hotfix/update-changelog' 2015-06-12 11:42:57 +03:00
Petr Korolev
b6f86a8cb6 Update changelog for version 1.6.1 2015-06-12 11:42:56 +03:00
Petr Korolev
5cd87a44a6 Merge branch 'release/1.6.1' into develop 2015-06-12 11:42:04 +03:00
Petr Korolev
243f0cf292 Merge branch 'release/1.6.1' 2015-06-12 11:42:04 +03:00
Petr Korolev
fee976df22 Update gemspec to version 1.6.1 2015-06-12 11:42:02 +03:00
Petr Korolev
e735683eaf Merge branch 'feature/fix-241' into develop 2015-06-12 11:37:43 +03:00
Petr Korolev
4f21ae7768 Add 3 new options. Fix #241. 2015-06-12 11:37:25 +03:00
Petr Korolev
c480075e8e Merge branch 'develop' into feature/fix-241 2015-06-12 11:09:49 +03:00
Petr Korolev
268a8f39b6 update readme move params explanation to Wiki page 2015-06-12 11:08:45 +03:00
Petr Korolev
1fa1cccd2a update change log 2015-06-12 10:04:14 +03:00
Petr Korolev
adab012de4 fix: fix crash when github api rate exceeded 2015-06-12 10:03:47 +03:00
Petr Korolev
e114901157 Merge branch 'master' into develop 2015-06-12 09:39:03 +03:00
Petr Korolev
6c6116381b add < to encaprulated characters. fix #249 2015-06-12 09:34:27 +03:00
Petr Korolev
f527cfff67 fix: multiple printing of "Fetching closed dates for issues: Done!"
string
2015-06-12 09:16:23 +03:00
Petr Korolev
92496f7c72 Merge branch 'hotfix/update-changelog' into develop 2015-06-11 16:49:29 +03:00
Petr Korolev
082210f49b Merge branch 'hotfix/update-changelog' 2015-06-11 16:49:26 +03:00
Petr Korolev
dc67089c21 Update changelog for version 1.6.0 2015-06-11 16:49:25 +03:00
Petr Korolev
865ddbcacd Merge branch 'release/1.6.0' into develop 2015-06-11 16:44:45 +03:00
Petr Korolev
9f2fb5f56c Merge branch 'release/1.6.0' 2015-06-11 16:44:45 +03:00
Petr Korolev
44ce94d7a8 Update gemspec to version 1.6.0 2015-06-11 16:44:43 +03:00
Petr Korolev
67ea3159cd add capital words for exclude labels 2015-06-11 16:44:33 +03:00
Petr Korolev
80a5fdef0c This fixes #54. And fix #240 also. 2015-06-11 16:44:33 +03:00
Petr Korolev
f7e9199841 Fix #246 2015-06-11 16:10:13 +03:00
Petr Korolev
19eb03c54e Add tests to verify sorting algorithm #244 2015-06-11 15:57:32 +03:00
Petr Korolev
22d1657fd4 Merge branch 'master' into develop 2015-06-11 13:09:59 +03:00
Petr Korolev
6fdcc0c61d fix #245 2015-06-11 13:09:26 +03:00
Petr Korolev
dac3be9f7d update test, between tags. 2015-06-11 13:09:26 +03:00
Petr Korolev
9f1537ab34 add test case 2015-06-11 13:09:04 +03:00
Petr Korolev
9055792021 Merge pull request #248 from dasilvacontin/master
fix guidlines typo in README.md
2015-06-11 12:18:36 +03:00
David da Silva Contin
9720c96b8c fix guidlines typo in README.md 2015-06-11 11:08:24 +02:00
Petr Korolev
8906fe5022 refactoring 2015-06-10 16:49:06 +03:00
Petr Korolev
a415010e86 change internal logic 2015-06-10 14:37:26 +03:00
Petr Korolev
67fbb04b31 add documentation 2015-06-10 14:19:53 +03:00
Petr Korolev
ff6115247e Move logging to separate class, disable logging during test execution. 2015-06-10 13:27:27 +03:00
Petr Korolev
a0cf2f54ee Merge branch 'master' into develop 2015-06-10 13:26:58 +03:00
Petr Korolev
0c8010d854 Merge branch 'hotfix/245' 2015-06-10 13:26:13 +03:00
Petr Korolev
9b46d56a9e fix #245 2015-06-10 13:23:46 +03:00
Petr Korolev
c3867a89f1 update test, between tags. 2015-06-10 10:24:39 +03:00
Petr Korolev
5cc3a7c8fd Merge branch 'hotfix/update-changelog' into develop 2015-05-26 16:08:00 +03:00
Petr Korolev
160cda50bc Merge branch 'hotfix/update-changelog' 2015-05-26 16:07:59 +03:00
Petr Korolev
8e090022f0 Update changelog for version 1.5.0 2015-05-26 16:07:57 +03:00
Petr Korolev
a94834d57e Merge branch 'release/1.5.0' into develop 2015-05-26 16:06:55 +03:00
69 changed files with 3567 additions and 1088 deletions

11
.gitignore vendored
View File

@@ -0,0 +1,11 @@
bin/
!bin/git-generate-changelog
!bin/github_changelog_generator
pkg/
coverage/
.bundle
spec/*.lock
doc
.yardoc
Gemfile.lock
gemfiles/Gemfile.2_4_0.lock

View File

@@ -1,5 +1,12 @@
inherit_from: .rubocop_todo.yml
AllCops:
DisplayCopNames: true
DisplayStyleGuide: true
Exclude:
- 'vendor/**/*'
- 'gemfiles/**/*'
Metrics/LineLength:
Enabled: false
@@ -14,3 +21,49 @@ Metrics/ClassLength:
# Configuration parameters: CountComments.
Metrics/MethodLength:
Enabled: false
Style/FileName:
Exclude:
- 'bin/git-generate-changelog'
#TODOS
# Offense count: 14
Metrics/AbcSize:
Enabled: false
# Offense count: 1
Style/AccessorMethodName:
Enabled: false
# Offense count: 10
Style/Documentation:
Enabled: false
# Offense count: 1
# Configuration parameters: MinBodyLength.
Style/GuardClause:
Enabled: false
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
# SupportedStyles: skip_modifier_ifs, always
Style/Next:
Enabled: false
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral:
Enabled: false
Style/MutableConstant:
Enabled: false
# "Use idx.positive? instead of idx > 0."
Style/NumericPredicate:
Enabled: false
Style/SafeNavigation:
Enabled: false

View File

@@ -1,27 +1,33 @@
# This configuration was generated by `rubocop --auto-gen-config`
# on 2015-05-26 16:00:55 +0300 using RuboCop version 0.31.0.
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
# 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: 1
Lint/ImplicitStringConcatenation:
Exclude:
- 'lib/github_changelog_generator/parser.rb'
# Offense count: 14
Metrics/AbcSize:
Max: 59
Enabled: false
# Offense count: 1
Metrics/CyclomaticComplexity:
Max: 7
# Offense count: 1
# Offense count: 2
Metrics/PerceivedComplexity:
Max: 8
# Offense count: 2
# Offense count: 1
Style/AccessorMethodName:
Enabled: false
# Offense count: 8
# Offense count: 10
Style/Documentation:
Enabled: false
@@ -30,13 +36,16 @@ Style/Documentation:
Style/GuardClause:
Enabled: false
# Offense count: 1
# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
# SupportedStyles: skip_modifier_ifs, always
Style/Next:
Enabled: false
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral:
Enabled: false

1
.ruby-version Normal file
View File

@@ -0,0 +1 @@
2.3.1

View File

@@ -1,14 +1,29 @@
sudo: false
cache: bundler
language: ruby
rvm:
- 2.1.0
script:
- bundle exec rake
cache:
- bundler
before_install:
- gem update --system
- gem install bundler
matrix:
include:
- rvm: 2.2.2
install: true # This skips 'bundle install'
script: gem build github_changelog_generator && gem install *.gem
- rvm: 2.2.2
install: true # This skips 'bundle install'
script: gem build github_changelog_generator && bundle install
gemfile: spec/install-gem-in-bundler.gemfile
- rvm: 2.1
gemfile: gemfiles/Gemfile.2_1
- rvm: 2.3.1
gemfile: gemfiles/Gemfile.2_3_1
- rvm: 2.4.0-preview2
gemfile: gemfiles/Gemfile.2_4_0
notifications:
email:
recipients:
- sky4winder+githubchangeloggenerator@gmail.com
- sky4winder+githubchangeloggenerator@gmail.com
on_success: never
on_failure: change
addons:

2
.yardopts Normal file
View File

@@ -0,0 +1,2 @@
--markup=markdown

View File

@@ -1,7 +1,354 @@
# Change Log
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.0...1.13.1)
**Implemented enhancements:**
- Don't constrain runtime deps. [\#400](https://github.com/skywinder/github-changelog-generator/pull/400) ([jkeiser](https://github.com/jkeiser))
**Fixed bugs:**
- `--user` flag should not be ignored [\#397](https://github.com/skywinder/github-changelog-generator/issues/397)
- GHE not working with --github-site set to an enterprise site [\#395](https://github.com/skywinder/github-changelog-generator/issues/395)
**Closed issues:**
- Contributors Section [\#398](https://github.com/skywinder/github-changelog-generator/issues/398)
**Merged pull requests:**
- Ability to implicity set user and project from command line [\#401](https://github.com/skywinder/github-changelog-generator/pull/401) ([skywinder](https://github.com/skywinder))
- Show how to use it with Rakefile [\#399](https://github.com/skywinder/github-changelog-generator/pull/399) ([edusantana](https://github.com/edusantana))
- Adds documentation on using a GHE endpoint [\#396](https://github.com/skywinder/github-changelog-generator/pull/396) ([cormacmccarthy](https://github.com/cormacmccarthy))
- Rake task usage: Added a missing option exclude\_tags\_regex [\#393](https://github.com/skywinder/github-changelog-generator/pull/393) ([perlun](https://github.com/perlun))
- Parser: YARD docstrings and a rename, and RegExp named capture groups [\#391](https://github.com/skywinder/github-changelog-generator/pull/391) ([olleolleolle](https://github.com/olleolleolle))
## [1.13.0](https://github.com/skywinder/github-changelog-generator/tree/1.13.0) (2016-07-04)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.1...1.13.0)
**Merged pull requests:**
- Carry PR \#301: usernames\_as\_github\_logins [\#392](https://github.com/skywinder/github-changelog-generator/pull/392) ([olleolleolle](https://github.com/olleolleolle))
## [1.12.1](https://github.com/skywinder/github-changelog-generator/tree/1.12.1) (2016-05-09)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.0...1.12.1)
**Fixed bugs:**
- github\_changelog\_generator/generator/generator\_tags.rb:61:in `detect\_since\_tag': undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#351](https://github.com/skywinder/github-changelog-generator/issues/351)
**Closed issues:**
- Add a LICENSE file [\#369](https://github.com/skywinder/github-changelog-generator/issues/369)
- Error installing on Ubuntu 14.04 [\#364](https://github.com/skywinder/github-changelog-generator/issues/364)
**Merged pull requests:**
- Move dev gems to add\_development\_dependency [\#373](https://github.com/skywinder/github-changelog-generator/pull/373) ([skywinder](https://github.com/skywinder))
- Add MIT LICENSE file [\#370](https://github.com/skywinder/github-changelog-generator/pull/370) ([olleolleolle](https://github.com/olleolleolle))
- Avoid nil bug in detect\_since\_tag [\#368](https://github.com/skywinder/github-changelog-generator/pull/368) ([olleolleolle](https://github.com/olleolleolle))
## [1.12.0](https://github.com/skywinder/github-changelog-generator/tree/1.12.0) (2016-04-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.8...1.12.0)
**Closed issues:**
- .github\_changelog\_generator config file is not consistent with the internal options hash [\#312](https://github.com/skywinder/github-changelog-generator/issues/312)
- Feature request: YAML front matter [\#276](https://github.com/skywinder/github-changelog-generator/issues/276)
**Merged pull requests:**
- Added tag exclusion with a filter \(string or regex\) [\#320](https://github.com/skywinder/github-changelog-generator/pull/320) ([soundstep](https://github.com/soundstep))
## [1.11.8](https://github.com/skywinder/github-changelog-generator/tree/1.11.8) (2016-03-22)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.7...1.11.8)
**Implemented enhancements:**
- ParserFile: Allow comments in settings file [\#358](https://github.com/skywinder/github-changelog-generator/pull/358) ([olleolleolle](https://github.com/olleolleolle))
**Fixed bugs:**
- Error when specifying exclude\_labels [\#327](https://github.com/skywinder/github-changelog-generator/issues/327)
- Parse options file options into arrays, integers, flags, and other [\#354](https://github.com/skywinder/github-changelog-generator/pull/354) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- Installation fails on Ubuntu [\#352](https://github.com/skywinder/github-changelog-generator/issues/352)
- Test installing on Windows: use AppVeyor [\#348](https://github.com/skywinder/github-changelog-generator/issues/348)
- Can't run under RubyGems 2.5.1 and Ruby 2.3.0 [\#325](https://github.com/skywinder/github-changelog-generator/issues/325)
- Ruby 2.3.0 - Deprecation warning: Github::ResponseWrapper\#respond\_to?\(:to\_ary\) is old fashion which takes only one parameter [\#323](https://github.com/skywinder/github-changelog-generator/issues/323)
- between-tags and exclude-tags do not work in .github\_changelog\_generator [\#317](https://github.com/skywinder/github-changelog-generator/issues/317)
- Add a "documentation" label [\#284](https://github.com/skywinder/github-changelog-generator/issues/284)
**Merged pull requests:**
- Replace shelling-out-to-Git w/ Dir call [\#360](https://github.com/skywinder/github-changelog-generator/pull/360) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: fail parsing with config file line number; use a File instead of a filename [\#357](https://github.com/skywinder/github-changelog-generator/pull/357) ([olleolleolle](https://github.com/olleolleolle))
- On gem install, do not try to copy manpage files in the "extensions" step [\#356](https://github.com/skywinder/github-changelog-generator/pull/356) ([olleolleolle](https://github.com/olleolleolle))
- Refactor: call it option\_name, instead of key\_sym [\#355](https://github.com/skywinder/github-changelog-generator/pull/355) ([olleolleolle](https://github.com/olleolleolle))
- Add a `bundle install` test [\#353](https://github.com/skywinder/github-changelog-generator/pull/353) ([jkeiser](https://github.com/jkeiser))
- Add an AppVeyor config [\#350](https://github.com/skywinder/github-changelog-generator/pull/350) ([Arcanemagus](https://github.com/Arcanemagus))
- README: Document GitHub token URI scope [\#345](https://github.com/skywinder/github-changelog-generator/pull/345) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.7](https://github.com/skywinder/github-changelog-generator/tree/1.11.7) (2016-03-04)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.6...1.11.7)
**Merged pull requests:**
- Add Olle Jonsson as co-author [\#347](https://github.com/skywinder/github-changelog-generator/pull/347) ([skywinder](https://github.com/skywinder))
- Gemspec, default date [\#346](https://github.com/skywinder/github-changelog-generator/pull/346) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.6](https://github.com/skywinder/github-changelog-generator/tree/1.11.6) (2016-03-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.5...1.11.6)
**Fixed bugs:**
- Can't build on Windows [\#340](https://github.com/skywinder/github-changelog-generator/issues/340)
**Closed issues:**
- install error "Not a git repository" [\#339](https://github.com/skywinder/github-changelog-generator/issues/339)
**Merged pull requests:**
- Gemspec: Calculate date using Date stdlib [\#343](https://github.com/skywinder/github-changelog-generator/pull/343) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
**Merged pull requests:**
- Test clean install in Travis [\#344](https://github.com/skywinder/github-changelog-generator/pull/344) ([jkeiser](https://github.com/jkeiser))
- Update Rakefile to avoid install-breaking bug [\#341](https://github.com/skywinder/github-changelog-generator/pull/341) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.4](https://github.com/skywinder/github-changelog-generator/tree/1.11.4) (2016-02-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.3...1.11.4)
**Merged pull requests:**
- Man page copying: only copy .1 [\#338](https://github.com/skywinder/github-changelog-generator/pull/338) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
**Closed issues:**
- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)
**Fixed bugs:**
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
**Merged pull requests:**
- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
**Merged pull requests:**
- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
**Fixed bugs:**
- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
**Merged pull requests:**
- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
**Implemented enhancements:**
- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
**Fixed bugs:**
- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
**Merged pull requests:**
- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
**Fixed bugs:**
- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
**Implemented enhancements:**
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
**Closed issues:**
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
**Merged pull requests:**
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
**Implemented enhancements:**
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
**Merged pull requests:**
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
**Fixed bugs:**
- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
**Merged pull requests:**
- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
**Closed issues:**
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
**Merged pull requests:**
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
**Implemented enhancements:**
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
**Merged pull requests:**
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
**Implemented enhancements:**
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
**Merged pull requests:**
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
**Implemented enhancements:**
- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
**Fixed bugs:**
- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
**Implemented enhancements:**
- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
**Fixed bugs:**
- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
**Implemented enhancements:**
- Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
**Fixed bugs:**
- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
**Implemented enhancements:**
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
**Merged pull requests:**
- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
**Implemented enhancements:**
@@ -11,28 +358,23 @@
**Fixed bugs:**
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
**Merged pull requests:**
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
**Implemented enhancements:**
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
**Closed issues:**
@@ -40,22 +382,14 @@
**Merged pull requests:**
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
**Merged pull requests:**
@@ -63,35 +397,30 @@
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
**Merged pull requests:**
**Fixed bugs:**
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
## [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:**
**Fixed bugs:**
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
## [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)
## [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:**
@@ -99,7 +428,6 @@
- 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:**
@@ -107,7 +435,6 @@
- --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:**
@@ -115,7 +442,6 @@
- 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:**
@@ -123,21 +449,16 @@
- 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:**
@@ -149,7 +470,6 @@
- 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:**
@@ -159,19 +479,16 @@
**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:**
**Implemented enhancements:**
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
## [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:**
@@ -179,41 +496,32 @@
- 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)
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
**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:**
@@ -223,23 +531,16 @@
**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:**
@@ -249,23 +550,18 @@
**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:**
@@ -277,29 +573,23 @@
- 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:**
@@ -309,22 +599,19 @@
**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)
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
**Fixed bugs:**
@@ -332,28 +619,21 @@
**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)*

28
Gemfile
View File

@@ -1,14 +1,26 @@
# frozen_string_literal: true
source "https://rubygems.org"
gem "rake", ">=10.4.2"
gemspec
gem "github_api", ">=0.12.3"
gem "colorize", ">=0.7.7"
group :development, :test do
gem "rake"
gem "bundler"
gem "overcommit", ">= 0.31"
gem "rubocop", ">= 0.43"
end
group :test do
gem "rspec"
gem "rubocop"
gem "coveralls", require: false
gem "simplecov", require: false
gem "codeclimate-test-reporter"
gem "vcr"
gem "multi_json"
gem "webmock"
gem "coveralls", "~>0.8", require: false
gem "simplecov", "~>0.10", require: false
gem "codeclimate-test-reporter", "~>0.4"
if RUBY_VERSION > "2"
gem "json", "~> 2.0", ">= 2.0.2"
else
gem "json"
end
gem "rspec", "< 4"
end

View File

@@ -1,107 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.3.8)
ast (2.0.0)
astrolabe (1.3.0)
parser (>= 2.2.0.pre.3, < 3.0)
codeclimate-test-reporter (0.4.7)
simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.7)
coveralls (0.8.1)
json (~> 1.8)
rest-client (>= 1.6.8, < 2)
simplecov (~> 0.10.0)
term-ansicolor (~> 1.3)
thor (~> 0.19.1)
descendants_tracker (0.0.4)
thread_safe (~> 0.3, >= 0.3.1)
diff-lcs (1.2.5)
docile (1.1.5)
domain_name (0.5.24)
unf (>= 0.0.5, < 1.0.0)
faraday (0.9.1)
multipart-post (>= 1.2, < 3)
github_api (0.12.3)
addressable (~> 2.3)
descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10)
hashie (>= 3.3)
multi_json (>= 1.7.5, < 2.0)
nokogiri (~> 1.6.3)
oauth2
hashie (3.4.1)
http-cookie (1.0.2)
domain_name (~> 0.5)
json (1.8.2)
jwt (1.5.0)
mime-types (2.5)
mini_portile (0.6.2)
multi_json (1.11.0)
multi_xml (0.5.5)
multipart-post (2.0.0)
netrc (0.10.3)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
oauth2 (1.0.0)
faraday (>= 0.8, < 0.10)
jwt (~> 1.0)
multi_json (~> 1.3)
multi_xml (~> 0.5)
rack (~> 1.2)
parser (2.2.2.2)
ast (>= 1.1, < 3.0)
powerpack (0.1.1)
rack (1.6.1)
rainbow (2.0.0)
rake (10.4.2)
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.3)
rspec-support (~> 3.2.0)
rspec-expectations (3.2.1)
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.31.0)
astrolabe (~> 1.3)
parser (>= 2.2.2.1, < 3.0)
powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.4)
ruby-progressbar (1.7.5)
simplecov (0.10.0)
docile (~> 1.1.0)
json (~> 1.8)
simplecov-html (~> 0.10.0)
simplecov-html (0.10.0)
term-ansicolor (1.3.0)
tins (~> 1.0)
thor (0.19.1)
thread_safe (0.3.5)
tins (1.5.1)
unf (0.1.4)
unf_ext
unf_ext (0.0.7.1)
PLATFORMS
ruby
DEPENDENCIES
codeclimate-test-reporter
colorize (>= 0.7.7)
coveralls
github_api (>= 0.12.3)
rake (>= 10.4.2)
rspec
rubocop
simplecov

9
LICENSE Normal file
View File

@@ -0,0 +1,9 @@
The MIT License (MIT)
Copyright (c) 2016 Petr Korolev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

489
README.md
View File

@@ -1,223 +1,268 @@
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
==================
- [Installation](#installation)
- [Output example](#output-example)
- [Usage](#usage)
- [Params](#params)
- [GitHub token](#github-token)
- [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library)
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing)
- [License](#license)
### Changelog generation has never been so easy:
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
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
[sudo] gem install github_changelog_generator
## Output example
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
- In general it looks like this:
> ## [1.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))
## Usage
**It's really simple**:
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
github_changelog_generator
- or from anywhere:
- `github_changelog_generator -u github_username -p github_project`
- `github_changelog_generator github_username/github_project`
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
### Params
Type `github_changelog_generator --help` for detailed usage.
Usage: github_changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo
-p, --project [PROJECT] Name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
-f, --date-format [FORMAT] Date format. Default is %Y-%m-%d
-o, --output [NAME] Output file. Default is CHANGELOG.md
--[no-]issues Include closed issues in changelog. Default is true
--[no-]issues-wo-labels Include closed issues without labels in changelog. Default is true
--[no-]pr-wo-labels Include pull requests without labels in changelog. Default is true
--[no-]pull-requests Include pull-requests in changelog. Default is true
--[no-]filter-by-milestone Use milestone to detect when issue was resolved. Default is true
--[no-]author Add author of pull-request in the end. Default is true
--unreleased-only Generate log from unreleased closed issues only.
--[no-]unreleased Add to log unreleased closed issues. Default is true
--unreleased-label [label] Add to log unreleased closed issues. Default is true
--[no-]compare-link Include compare link (Full Changelog) between older version and newer version. Default is true
--include-labels x,y,z Only issues with the specified labels will be included in the changelog. Default is 'bug,enhancement'
--exclude-labels x,y,z Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
--between-tags x,y,z Change log will be filled only between specified tags
--exclude-tags x,y,z Change log will be exclude specified tags
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited
--github-site [URL] The Enterprise Github site on which your project is hosted.
--github-api [URL] The enterprise endpoint to use for your Github API.
--simple-list Create simple list from issues and pull requests. Default is false.
--future-release [RELEASE-VERSION]
Put the unreleased changes in the specified release number.
--[no-]verbose Run verbosely. Default is true
-v, --version Print version number
-h, --help Displays Help
### GitHub 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/tokens)**.
And:
- Run with key `-t [your-16-digit-token]`
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
So, if you got error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
##Features and advantages of this project
- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory:
- Flexible format **customisation**:
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
- **Distinguish** issues **according labels**. :mag_right:
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
- Bug fixes (by label `bug` in issue) :beetle:
- Enhancements (by label `enhancement` in issue) :star2:
- Issues (closed issues `w/o any labels`) :non-potable_water:
- You can manually set which labels should be included/excluded. :wrench:
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*look `github_changelog_generator --help` for details)*
###Alternatives
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
*If you know other projects - feel free to edit this Wiki page!*
### Projects using this library
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
[![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
==================
- [Installation](#installation)
- [Output example](#output-example)
- [Usage](#usage)
- [Params](#params)
- [GitHub token](#github-token)
- [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library)
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing)
- [License](#license)
### Changelog generation has never been so easy
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to 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.
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
## Installation
gem install github_changelog_generator
See also Troubleshooting.
## Output example
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
- In general, it looks like this:
> ## [1.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))
## Usage
**It's really simple!**
- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
github_changelog_generator
- Or, run this from anywhere:
- `github_changelog_generator -u github_username -p github_project`
- `github_changelog_generator github_username/github_project`
- If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options:
github_changelog_generator --github-site="https://github.yoursite.com" \
--github-api="https://github.yoursite.com/api/v3/"
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
### Params
Type `github_changelog_generator --help` for details.
For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
### Params File
In your project root, you can put a params file named `.github_changelog_generator` to override default params:
Example:
```
unreleased=false
future-release=5.0.0
since-tag=1.0.0
```
### GitHub token
GitHub only allows only 50 unauthenticated requests per hour.
Therefore, it's recommended to run this script with authentication by using a **token**.
Here's how:
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
- Either:
- Run the script with `--token <your-40-digit-token>`; **OR**
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
So, if you got an error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
## Migrating from a manual changelog
Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
That's where `--base <your-manual-changelog.md>` comes in handy!
This option lets append your old manual changelog to the end of the generated entries.
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
### Rake task
You love `rake`? We do, too! So, we've made it even easier for you:
we've provided a `rake` task library for your changelog generation.
Just put something like this in your `Rakefile`:
```ruby
require 'github_changelog_generator/task'
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
config.since_tag = '0.1.14'
config.future_release = '0.2.0'
end
```
All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
## Features and advantages of this project
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
- **GitHub Enterprise support** via command line options! :factory:
- Flexible format **customization**:
- **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
- **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
- Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
- Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
- **Distinguish** issues **by labels**. :mag_right:
- Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
- Bug fixes (issues labeled `bug`) :beetle:
- Enhancements (issues labeled `enhancement`) :star2:
- Issues (closed issues with no labels) :non-potable_water:
- Manually include or exclude issues by labels :wrench:
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
(*See `github_changelog_generator --help` for details)*
###Alternatives
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
*If you know other projects, feel free to edit this Wiki page!*
### Projects using this library
Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
## Am I missing some essential feature?
- **Nothing is impossible!**
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
- *Bug reports, feature requests, patches, well-wishes are always welcome* :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
1. Create an issue to discuss about your idea
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:
## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
## Am I missing some essential feature?
- **Nothing is impossible!**
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
- *Bug reports, feature requests, patches, and 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 a lot of people are using it yet!) :congratulations:
*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
An auto-generated changelog really helps, even if you manually fill in the release notes!
For example:
When I found a closed bug, it's very useful know which release fixed it.
In this case, you can easily find the issue by \# in `CHANGELOG.md`.
- it's not quite as easy to find this in handwritten releases notes
- a generated file saves you the trouble of remembering everything;
sometimes people forget to add things to a handwritten file
Ultimately, I think GitHub Releases is ideal for end-users.
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
- ***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 is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
If you're seeing this warning, please do the following:
1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
- ***My Ruby version is very old, can I use this?***
When your Ruby is old, and you don't want to upgrade, and your want to
control which libraries you use, you can use Bundler.
In a Gemfile, perhaps in a non-deployed `:development` group, add this
gem:
```ruby
group :development do
gem 'github_changelog_generator', require: false
end
```
Then you can keep back dependencies like rack, which currently is only
compatible with Ruby >= 2.2.2. So, use an older version for your app by
adding a line like this to the Gemfile:
```
gem 'rack', '~> 1.6'
```
This way, you can keep on using github_changelog_generator, even if you
can't get the latest version of Ruby installed.
## Contributing
1. Create an issue and describe your idea
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Publish the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:
*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

View File

@@ -1,7 +1,40 @@
# frozen_string_literal: true
require "bundler"
require "bundler/gem_tasks"
require "rubocop/rake_task"
require "rspec/core/rake_task"
require "pathname"
require "fileutils"
require "overcommit"
RuboCop::RakeTask.new
RSpec::Core::RakeTask.new(:rspec)
task :copy_man_page_to_manpath do |_t|
known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
manpath = known_manpath_paths.find do |f|
path = Pathname(f)
path.file? && path.readable?
end
next unless manpath
writable_man_path = Pathname(manpath).each_line.find do |line|
path = Pathname(line.chomp)
path.directory? && path.writable?
end
next unless writable_man_path
man_prefix = Pathname("#{writable_man_path.chomp}/man1")
man_pages = "man/git-*.1"
Pathname.glob(man_pages) do |path|
if path.exist? && man_prefix.exist? && man_prefix.writable?
FileUtils.cp(path, man_prefix + path.basename)
end
end
end
task checks: [:rubocop, :rspec]
task default: [:rubocop, :rspec]

50
appveyor.yml Normal file
View File

@@ -0,0 +1,50 @@
version: "{build}"
platform: x64
branches:
only:
- master
clone_depth: 10
skip_tags: true
# See here for Ruby versions pre-installed:
# http://www.appveyor.com/docs/installed-software#ruby
environment:
matrix:
- ruby_version: "21" # Older version, but matches Travis-CI
- ruby_version: "21-x64"
install:
- SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
# Print version and location for pre-installed ruby
- ruby --version
- where ruby
# Install latest version of RubyGems
- gem update --system --no-document --no-post-install-message
- gem --version
- where gem
# Print version and location for pre-installed bundler
- bundler --version
- where bundler
build_script:
# Install ruby dependencies
- bundle install --retry 3
- bundle exec rake checks
test_script:
- gem build github_changelog_generator
- gem install *.gem
notifications:
- provider: Email
to:
- sky4winder+githubchangeloggenerator@gmail.com
on_build_success: false
on_build_status_changed: true

5
bin/git-generate-changelog Executable file
View File

@@ -0,0 +1,5 @@
#! /usr/bin/env ruby
# frozen_string_literal: true
require_relative "../lib/github_changelog_generator"
GitHubChangelogGenerator::ChangelogGenerator.new.run

View File

@@ -1,4 +1,5 @@
#! /usr/bin/env ruby
# frozen_string_literal: true
require_relative "../lib/github_changelog_generator"
GitHubChangelogGenerator::ChangelogGenerator.new.run

8
circle.yml Normal file
View File

@@ -0,0 +1,8 @@
notify:
webhooks:
# A list of hook hashes, containing the url field
# gitter hook
- url: https://webhooks.gitter.im/e/2d81eb1ae7695fdc82c4
- url: https://webhooks.gitter.im/e/3ec6a35fad7e9991058e

3
gemfiles/Gemfile.2_1 Normal file
View File

@@ -0,0 +1,3 @@
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
gem 'rack', '~> 1.6'
gem 'activesupport', '~> 4'

3
gemfiles/Gemfile.2_3_1 Normal file
View File

@@ -0,0 +1,3 @@
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
gem 'rack', '>= 2'
gem 'activesupport', '>= 4'

3
gemfiles/Gemfile.2_4_0 Normal file
View File

@@ -0,0 +1,3 @@
eval_gemfile File.expand_path('../../Gemfile', __FILE__)
gem 'rack', '>= 2'

View File

@@ -1,5 +1,5 @@
# coding: utf-8
# frozen_string_literal: true
lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "github_changelog_generator/version"
@@ -9,23 +9,24 @@ Gem::Specification.new do |spec|
spec.version = GitHubChangelogGenerator::VERSION
spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev"]
spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev", "Olle Jonsson"]
spec.email = "sky4winder+github_changelog_generator@gmail.com"
spec.date = `date +"%Y-%m-%d"`.strip!
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
spec.license = "MIT"
spec.license = "MIT"
spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
spec.files = `git ls-files -z`.split("\x0")
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ["lib"]
spec.add_development_dependency "bundler", "~> 1.7"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_runtime_dependency("github_api", ["~> 0.12"])
spec.add_runtime_dependency("colorize", ["~> 0.7"])
spec.add_runtime_dependency "rake", ">= 10.0"
spec.add_runtime_dependency "rainbow", ">= 2.1"
spec.add_runtime_dependency("octokit", ["~> 4.0"])
spec.add_runtime_dependency("faraday-http-cache")
spec.add_runtime_dependency("activesupport")
end

View File

@@ -1,7 +1,33 @@
# Change Log
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
**Implemented enhancements:**
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
**Fixed bugs:**
- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
**Closed issues:**
- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
**Merged pull requests:**
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
**Closed issues:**
@@ -13,7 +39,6 @@
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
**Merged pull requests:**
@@ -21,7 +46,6 @@
- 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)
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
**Merged pull requests:**
@@ -31,5 +55,4 @@
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

View File

@@ -1,14 +1,22 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "github_api"
require "octokit"
require "faraday-http-cache"
require "logger"
require "active_support"
require "json"
require "colorize"
require "multi_json"
require "benchmark"
require_relative "github_changelog_generator/helper"
require_relative "github_changelog_generator/parser"
require_relative "github_changelog_generator/parser_file"
require_relative "github_changelog_generator/generator/generator"
require_relative "github_changelog_generator/version"
require_relative "github_changelog_generator/reader"
require_relative "github_changelog_generator/hash"
require_relative "github_changelog_generator/array"
# The main module, where placed all classes (now, at least)
module GitHubChangelogGenerator
@@ -26,7 +34,7 @@ module GitHubChangelogGenerator
def run
log = @generator.compound_changelog
output_filename = "#{@options[:output]}"
output_filename = (@options[:output]).to_s
File.open(output_filename, "w") { |file| file.write(log) }
puts "Done!"
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

View File

@@ -0,0 +1,14 @@
# frozen_string_literal: true
class Array
def stringify_keys_deep!
new_ar = []
each do |value|
new_value = value
if value.is_a?(Hash) || value.is_a?(Array)
new_value = value.stringify_keys_deep!
end
new_ar << new_value
end
new_ar
end
end

View File

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

View File

@@ -1,4 +1,5 @@
require "github_changelog_generator/fetcher"
# frozen_string_literal: true
require_relative "../octo_fetcher"
require_relative "generator_generation"
require_relative "generator_fetcher"
require_relative "generator_processor"
@@ -10,25 +11,25 @@ module GitHubChangelogGenerator
end
class Generator
attr_accessor :options, :all_tags, :github
attr_accessor :options, :filtered_tags, :github, :tag_section_mapping
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
#
# Example:
# generator = GitHubChangelogGenerator::Generator.new
# content = generator.compound_changelog
def initialize(options = nil)
@options = options || {}
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
def initialize(options = {})
@options = options
@tag_times_hash = {}
@fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
end
def fetch_issues_and_pr
issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
@pull_requests = @options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
@pull_requests = options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
@issues = @options[:issues] ? get_filtered_issues(issues) : []
@issues = options[:issues] ? get_filtered_issues(issues) : []
fetch_events_for_issues_and_pr
detect_actual_closed_dates(@issues + @pull_requests)
@@ -41,7 +42,7 @@ module GitHubChangelogGenerator
def encapsulate_string(string)
string.gsub! '\\', '\\\\'
encpas_chars = %w(> * _ \( \) [ ] #)
encpas_chars = %w(< > * _ \( \) [ ] #)
encpas_chars.each do |char|
string.gsub! char, "\\#{char}"
end
@@ -56,38 +57,39 @@ module GitHubChangelogGenerator
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
# @return [String] Ready and parsed section
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
github_site = options[:github_site] || "https://github.com"
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
if @options[:issues]
if options[:issues]
# Generate issues:
log += issues_to_log(issues)
log += issues_to_log(issues, pull_requests)
end
if @options[:pulls]
if options[:pulls]
# Generate pull requests:
log += generate_sub_section(pull_requests, @options[:merge_prefix])
log += generate_sub_section(pull_requests, options[:merge_prefix])
end
log
end
# Generate ready-to-paste log from list of issues.
# Generate ready-to-paste log from list of issues and pull requests.
#
# @param [Array] issues
# @param [Array] pull_requests
# @return [String] generated log for issues
def issues_to_log(issues)
def issues_to_log(issues, pull_requests)
log = ""
bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
log += generate_sub_section(bugs_a, @options[:bug_prefix])
log += generate_sub_section(issues_a, @options[:issue_prefix])
log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
log += generate_sub_section(bugs_a, options[:bug_prefix])
log += generate_sub_section(issues_a, options[:issue_prefix])
log
end
@@ -95,28 +97,47 @@ module GitHubChangelogGenerator
# (bugs, features, or just closed issues) by labels
#
# @param [Array] issues
# @param [Array] pull_requests
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
def parse_by_sections(issues)
def parse_by_sections(issues, pull_requests)
issues_a = []
enhancement_a = []
bugs_a = []
issues.each do |dict|
added = false
dict.labels.each do |label|
if label.name == "bug"
bugs_a.push dict
dict["labels"].each do |label|
if options[:bug_labels].include?(label["name"])
bugs_a.push(dict)
added = true
next
end
if label.name == "enhancement"
enhancement_a.push dict
if options[:enhancement_labels].include?(label["name"])
enhancement_a.push(dict)
added = true
next
end
end
issues_a.push dict unless added
issues_a.push(dict) unless added
end
added_pull_requests = []
pull_requests.each do |pr|
pr["labels"].each do |label|
if options[:bug_labels].include?(label["name"])
bugs_a.push(pr)
added_pull_requests.push(pr)
next
end
if options[:enhancement_labels].include?(label["name"])
enhancement_a.push(pr)
added_pull_requests.push(pr)
next
end
end
end
added_pull_requests.each { |p| pull_requests.delete(p) }
[bugs_a, enhancement_a, issues_a]
end
end

View File

@@ -1,9 +1,12 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
class Generator
MAX_THREAD_NUMBER = 1
# Fetch event for issues and pull requests
# @return [Array] array of fetched issues
def fetch_events_for_issues_and_pr
if @options[:verbose]
if options[:verbose]
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
end
@@ -12,37 +15,36 @@ module GitHubChangelogGenerator
end
# Async fetching of all tags dates
def fetch_tags_dates
print "Fetching tag dates...\r" if @options[:verbose]
def fetch_tags_dates(tags)
print "Fetching tag dates...\r" if options[:verbose]
# Async fetching tags:
threads = []
i = 0
all = @all_tags.count
@all_tags.each do |tag|
all = tags.count
tags.each do |tag|
print " \r"
threads << Thread.new do
@fetcher.get_time_of_tag(tag)
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
get_time_of_tag(tag)
print "Fetching tags dates: #{i + 1}/#{all}\r" if options[:verbose]
i += 1
end
end
threads.each(&:join)
puts "Fetching tags dates: #{i}" if @options[:verbose]
puts "Fetching tags dates: #{i}" if options[:verbose]
end
# Find correct closed dates, if issues was closed by commits
def detect_actual_closed_dates(issues)
print "Fetching closed dates for issues...\r" if @options[:verbose]
print "Fetching closed dates for issues...\r" if options[:verbose]
max_thread_number = 50
issues.each_slice(max_thread_number) do |issues_slice|
issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
threads = []
issues_slice.each do |issue|
threads << Thread.new { find_closed_date_by_commit(issue) }
end
threads.each(&:join)
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
end
puts "Fetching closed dates for issues: Done!" if options[:verbose]
end
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
@@ -50,10 +52,10 @@ module GitHubChangelogGenerator
def find_closed_date_by_commit(issue)
unless issue["events"].nil?
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
compare_string = issue["merged_at"].nil? ? "closed" : "merged"
# reverse! - to find latest closed event. (event goes in date order)
issue["events"].reverse!.each do |event|
if event[:event].eql? compare_string
if event["event"].eql? compare_string
set_date_from_event(event, issue)
break
end
@@ -67,15 +69,17 @@ module GitHubChangelogGenerator
# @param [Hash] event
# @param [Hash] issue
def set_date_from_event(event, issue)
if event[:commit_id].nil?
issue[:actual_date] = issue[:closed_at]
if event["commit_id"].nil?
issue["actual_date"] = issue["closed_at"]
else
begin
commit = @fetcher.fetch_commit(event)
issue[:actual_date] = commit[:author][:date]
issue["actual_date"] = commit["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]
puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
issue["actual_date"] = issue["closed_at"]
end
end
end

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
class Generator
# Main function to start change log generation
@@ -7,54 +8,35 @@ module GitHubChangelogGenerator
fetch_and_filter_tags
fetch_issues_and_pr
log = "# Change Log\n\n"
log = ""
log += options[:frontmatter] if options[:frontmatter]
log += "#{options[:header]}\n\n"
if @options[:unreleased_only]
log += generate_log_between_tags(all_tags[0], nil)
else
log += generate_log_for_all_tags
end
log += if options[:unreleased_only]
generate_log_between_tags(filtered_tags[0], nil)
else
generate_log_for_all_tags
end
log += File.read(options[:base]) if File.file?(options[:base])
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
@log = log
end
# @return [String] temp method should be removed soon
def generate_for_2_tags(log)
tag1 = @options[:tag1]
tag2 = @options[:tag2]
tags_strings = []
all_tags.each { |x| tags_strings.push(x["name"]) }
if tags_strings.include?(tag1)
if tags_strings.include?(tag2)
to_a = tags_strings.map.with_index.to_a
hash = Hash[to_a]
index1 = hash[tag1]
index2 = hash[tag2]
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
else
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
end
else
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
end
log
end
# @param [Array] issues List of issues on sub-section
# @param [String] prefix Nae of sub-section
# @return [String] Generate ready-to-go sub-section
def generate_sub_section(issues, prefix)
log = ""
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
if issues.any?
log += "#{prefix}\n\n" unless options[:simple_list]
issues.each do |issue|
merge_string = get_string_for_issue(issue)
log += "- #{merge_string}\n\n"
log += "- #{merge_string}\n"
end
log += "\n"
end
log
end
@@ -71,16 +53,21 @@ module GitHubChangelogGenerator
log = ""
# Generate date string:
time_string = newer_tag_time.strftime @options[:date_format]
time_string = newer_tag_time.strftime(options[:date_format])
# Generate tag name and link
if newer_tag_name.equal? @options[:unreleased_label]
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
else
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
end
release_url = if options[:release_url]
format(options[:release_url], newer_tag_link)
else
"#{project_url}/tree/#{newer_tag_link}"
end
log += if newer_tag_name.equal?(options[:unreleased_label])
"## [#{newer_tag_name}](#{release_url})\n\n"
else
"## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
end
if @options[:compare_link] && older_tag_link
if options[:compare_link] && older_tag_link
# Generate compare link
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
end
@@ -94,26 +81,26 @@ module GitHubChangelogGenerator
def generate_log_between_tags(older_tag, newer_tag)
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
# do not generate empty unreleased section
return ""
end
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
end
# Apply all filters to issues and pull requests
#
# @return [Array] filtered issues and pull requests
def filter_issues_for_tags(newer_tag, older_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_pull_requests = delete_by_time(@pull_requests, "actual_date", older_tag, newer_tag)
filtered_issues = delete_by_time(@issues, "actual_date", older_tag, newer_tag)
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
if @options[:filter_issues_by_milestone]
if options[:filter_issues_by_milestone]
# delete excess irrelevant issues (according milestones). Issue #22.
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
@@ -124,15 +111,13 @@ module GitHubChangelogGenerator
# The full cycle of generation for whole project
# @return [String] The complete change log
def generate_log_for_all_tags
puts "Generating log..." if @options[:verbose]
puts "Generating log..." if options[:verbose]
log = generate_unreleased_section
(1...all_tags.size).each do |index|
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
end
if @all_tags.count != 0
log += generate_log_between_tags(nil, all_tags.last)
@tag_section_mapping.each_pair do |_tag_section, left_right_tags|
older_tag, newer_tag = left_right_tags
log += generate_log_between_tags(older_tag, newer_tag)
end
log
@@ -140,8 +125,8 @@ module GitHubChangelogGenerator
def generate_unreleased_section
log = ""
if @options[:unreleased]
unreleased_log = generate_log_between_tags(all_tags[0], nil)
if options[:unreleased]
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
log += unreleased_log if unreleased_log
end
log
@@ -150,25 +135,30 @@ module GitHubChangelogGenerator
# Parse issue and generate single line formatted issue line.
#
# Example output:
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
#
# @param [Hash] issue Fetched issue from GitHub
# @return [String] Markdown-formatted single issue
def get_string_for_issue(issue)
encapsulated_title = encapsulate_string issue[:title]
encapsulated_title = encapsulate_string issue["title"]
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
issue_line_with_user(title_with_number, issue)
end
unless issue.pull_request.nil?
if @options[:author]
if issue.user.nil?
title_with_number += " ({Null user})"
else
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
end
end
private
def issue_line_with_user(line, issue)
return line if !options[:author] || issue.pull_request.nil?
user = issue["user"]
return "#{line} ({Null user})" unless user
if options[:usernames_as_github_logins]
"#{line} (@#{user['login']})"
else
"#{line} ([#{user['login']}](#{user['html_url']}))"
end
title_with_number
end
end
end

View File

@@ -1,16 +1,16 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
class Generator
# delete all labels with labels from @options[:exclude_labels] array
# delete all labels with labels from options[:exclude_labels] array
# @param [Array] issues
# @return [Array] filtered array
def exclude_issues_by_labels(issues)
unless @options[:exclude_labels].nil?
issues = issues.select do |issue|
var = issue.labels.map(&:name) & @options[:exclude_labels]
!(var).any?
end
return issues if !options[:exclude_labels] || options[:exclude_labels].empty?
issues.reject do |issue|
labels = issue["labels"].map { |l| l["name"] }
(labels & options[:exclude_labels]).any?
end
issues
end
# @return [Array] filtered issues accourding milestone
@@ -32,18 +32,18 @@ module GitHubChangelogGenerator
# @return [Array] issues with milestone #tag_name
def find_issues_to_add(all_issues, tag_name)
all_issues.select do |issue|
if issue.milestone.nil?
if issue["milestone"].nil?
false
else
# check, that this milestone in tag list:
milestone_is_tag = @all_tags.find do |tag|
tag.name == issue.milestone.title
milestone_is_tag = @filtered_tags.find do |tag|
tag["name"] == issue["milestone"]["title"]
end
if milestone_is_tag.nil?
false
else
issue.milestone.title == tag_name
issue["milestone"]["title"] == tag_name
end
end
end
@@ -53,37 +53,37 @@ module GitHubChangelogGenerator
def remove_issues_in_milestones(filtered_issues)
filtered_issues.select! do |issue|
# leave issues without milestones
if issue.milestone.nil?
if issue["milestone"].nil?
true
else
# check, that this milestone in tag list:
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
@filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
end
end
end
# Method filter issues, that belong only specified tag range
# @param [Array] array of issues to filter
# @param [Array] issues issues to filter
# @param [Symbol] hash_key key of date value default is :actual_date
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
# @return [Array] filtered issues
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
def delete_by_time(issues, hash_key = "actual_date", older_tag = nil, newer_tag = nil)
# in case if not tags specified - return unchanged array
return array if older_tag.nil? && newer_tag.nil?
return issues if older_tag.nil? && newer_tag.nil?
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
older_tag_time = older_tag && get_time_of_tag(older_tag)
array.select do |req|
if req[hash_key]
time = Time.parse(req[hash_key]).utc
issues.select do |issue|
if issue[hash_key]
time = Time.parse(issue[hash_key].to_s).utc
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
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
else
@@ -93,20 +93,20 @@ module GitHubChangelogGenerator
end
def tag_older_new_tag?(newer_tag_time, time)
if newer_tag_time.nil?
tag_in_range_new = true
else
tag_in_range_new = time <= newer_tag_time
end
tag_in_range_new = if newer_tag_time.nil?
true
else
time <= newer_tag_time
end
tag_in_range_new
end
def tag_newer_old_tag?(older_tag_time, t)
if older_tag_time.nil?
tag_in_range_old = true
else
tag_in_range_old = t > older_tag_time
end
tag_in_range_old = if older_tag_time.nil?
true
else
t > older_tag_time
end
tag_in_range_old
end
@@ -121,9 +121,9 @@ module GitHubChangelogGenerator
# @return [Array] issues without labels or empty array if add_issues_wo_labels is false
def filter_wo_labels(issues)
if @options[:add_issues_wo_labels]
if options[:add_issues_wo_labels]
issues_wo_labels = issues.select do |issue|
!issue.labels.map(&:name).any?
!issue["labels"].map { |l| l["name"] }.any?
end
return issues_wo_labels
end
@@ -131,11 +131,14 @@ module GitHubChangelogGenerator
end
def filter_by_include_labels(issues)
filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
labels = issue.labels.map(&:name) & @options[:include_labels]
(labels).any?
if options[:include_labels].nil?
issues
else
issues.select do |issue|
labels = issue["labels"].map { |l| l["name"] } & options[:include_labels]
labels.any?
end
end
filtered_issues
end
# General filtered function
@@ -151,18 +154,18 @@ module GitHubChangelogGenerator
# @return [Array] Filtered issues
def get_filtered_issues(issues)
issues = filter_array_by_labels(issues)
puts "Filtered issues: #{issues.count}" if @options[:verbose]
puts "Filtered issues: #{issues.count}" if options[:verbose]
issues
end
# This method fetches missing params for PR and filter them by specified options
# It include add all PR's with labels from @options[:include_labels] array
# It include add all PR's with labels from options[:include_labels] array
# And exclude all from :exclude_labels array.
# @return [Array] filtered PR's
def get_filtered_pull_requests(pull_requests)
pull_requests = filter_array_by_labels(pull_requests)
pull_requests = filter_merged_pull_requests(pull_requests)
puts "Filtered pull requests: #{pull_requests.count}" if @options[:verbose]
puts "Filtered pull requests: #{pull_requests.count}" if options[:verbose]
pull_requests
end
@@ -171,19 +174,21 @@ module GitHubChangelogGenerator
# :merged_at - is a date, when issue PR was merged.
# More correct to use merged date, rather than closed date.
def filter_merged_pull_requests(pull_requests)
print "Fetching merged dates...\r" if @options[:verbose]
print "Fetching merged dates...\r" if options[:verbose]
closed_pull_requests = @fetcher.fetch_closed_pull_requests
pull_requests.each do |pr|
fetched_pr = closed_pull_requests.find do |fpr|
fpr.number == pr.number
fpr["number"] == pr["number"]
end
if fetched_pr
pr["merged_at"] = fetched_pr["merged_at"]
closed_pull_requests.delete(fetched_pr)
end
pr[:merged_at] = fetched_pr[:merged_at]
closed_pull_requests.delete(fetched_pr)
end
pull_requests.select! do |pr|
!pr[:merged_at].nil?
!pr["merged_at"].nil?
end
pull_requests

View File

@@ -1,16 +1,62 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
class Generator
# fetch, filter tags, fetch dates and sort them in time order
def fetch_and_filter_tags
@all_tags = get_filtered_tags(@fetcher.get_all_tags)
fetch_tags_dates
sort_tags_by_date
detect_since_tag
detect_due_tag
all_tags = @fetcher.get_all_tags
included_tags = filter_excluded_tags(all_tags)
fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
sorted_tags = sort_tags_by_date(included_tags)
@filtered_tags = get_filtered_tags(included_tags)
@tag_section_mapping = build_tag_section_mapping(@filtered_tags, sorted_tags)
@filtered_tags
end
# Sort all tags by date
def sort_tags_by_date
puts "Sorting tags..." if @options[:verbose]
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
# @param [Array] filtered_tags are the tags that need a subsection output
# @param [Array] all_tags is the list of all tags ordered from newest -> oldest
# @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag]
# PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date]
def build_tag_section_mapping(filtered_tags, all_tags)
tag_mapping = {}
filtered_tags.each do |tag|
older_tag_idx = all_tags.index(tag) + 1
older_tag = all_tags[older_tag_idx]
tag_mapping[tag] = [older_tag, tag]
end
tag_mapping
end
# Sort all tags by date, newest to oldest
def sort_tags_by_date(tags)
puts "Sorting tags..." if options[:verbose]
tags.sort_by! do |x|
get_time_of_tag(x)
end.reverse!
end
# Returns date for given GitHub Tag hash
#
# Memoize the date by tag name.
#
# @param [Hash] tag_name
#
# @return [Time] time of specified tag
def get_time_of_tag(tag_name)
raise ChangelogGeneratorError, "tag_name is nil" if tag_name.nil?
name_of_tag = tag_name.fetch("name")
time_for_tag_name = @tag_times_hash[name_of_tag]
return time_for_tag_name if time_for_tag_name
@fetcher.fetch_date_of_tag(tag_name).tap do |time_string|
@tag_times_hash[name_of_tag] = time_string
end
end
# Detect link, name and time for specified tag.
@@ -19,52 +65,152 @@ module GitHubChangelogGenerator
# @return [Array] link, name and time of the tag
def detect_link_tag_time(newer_tag)
# if tag is nil - set current time
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
# if it's future release tag - set this value
if newer_tag.nil? && @options[:future_release]
newer_tag_name = @options[:future_release]
newer_tag_link = @options[:future_release]
if newer_tag.nil? && options[:future_release]
newer_tag_name = options[:future_release]
newer_tag_link = options[:future_release]
else
# put unreleased label if there is no name for the tag
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
newer_tag_name = newer_tag.nil? ? options[:unreleased_label] : newer_tag["name"]
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
end
[newer_tag_link, newer_tag_name, newer_tag_time]
end
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
def detect_since_tag
@since_tag ||= options.fetch(:since_tag) { version_of_first_item }
end
def detect_due_tag
@due_tag ||= options.fetch(:due_tag, nil)
end
def version_of_first_item
return unless File.file?(options[:base].to_s)
sections = GitHubChangelogGenerator::Reader.new.read(options[:base])
sections.first["version"] if sections && sections.any?
end
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
#
# @return [Array]
def get_filtered_tags(all_tags)
filtered_tags = filter_between_tags(all_tags)
filter_excluded_tags(filtered_tags)
filtered_tags = filter_since_tag(all_tags)
filtered_tags = filter_due_tag(filtered_tags)
filter_between_tags(filtered_tags)
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :since_tag option
def filter_since_tag(all_tags)
filtered_tags = all_tags
tag = detect_since_tag
if tag
if all_tags.map { |t| t["name"] }.include? tag
idx = all_tags.index { |t| t["name"] == tag }
filtered_tags = if idx > 0
all_tags[0..idx - 1]
else
[]
end
else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
end
end
filtered_tags
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :due_tag option
def filter_due_tag(all_tags)
filtered_tags = all_tags
tag = detect_due_tag
if tag
if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
idx = all_tags.index { |t| t["name"] == tag }
filtered_tags = if idx > 0
all_tags[(idx + 1)..-1]
else
[]
end
else
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
end
end
filtered_tags
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :between_tags option
def filter_between_tags(all_tags)
filtered_tags = all_tags
if @options[:between_tags]
@options[:between_tags].each do |tag|
unless all_tags.include? tag
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
tag_names = filtered_tags.map { |ft| ft["name"] }
if options[:between_tags]
options[:between_tags].each do |tag|
unless tag_names.include?(tag)
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
end
end
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) }
end
filtered_tags
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
def filter_excluded_tags(all_tags)
filtered_tags = all_tags
if @options[:exclude_tags]
@options[:exclude_tags].each do |tag|
unless all_tags.include? tag
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
end
end
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag }
if options[:exclude_tags]
apply_exclude_tags(all_tags)
elsif options[:exclude_tags_regex]
apply_exclude_tags_regex(all_tags)
else
all_tags
end
end
private
def apply_exclude_tags(all_tags)
if options[:exclude_tags].is_a?(Regexp)
filter_tags_with_regex(all_tags, options[:exclude_tags])
else
filter_exact_tags(all_tags)
end
end
def apply_exclude_tags_regex(all_tags)
filter_tags_with_regex(all_tags, Regexp.new(options[:exclude_tags_regex]))
end
def filter_tags_with_regex(all_tags, regex)
warn_if_nonmatching_regex(all_tags)
all_tags.reject { |tag| regex =~ tag["name"] }
end
def filter_exact_tags(all_tags)
options[:exclude_tags].each do |tag|
warn_if_tag_not_found(all_tags, tag)
end
all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
end
def warn_if_nonmatching_regex(all_tags)
unless all_tags.map { |t| t["name"] }.any? { |t| options[:exclude_tags] =~ t }
Helper.log.warn "Warning: unable to reject any tag, using regex "\
"#{options[:exclude_tags].inspect} in --exclude-tags "\
"option."
end
end
def warn_if_tag_not_found(all_tags, tag)
unless all_tags.map { |t| t["name"] }.include?(tag)
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
end
filtered_tags
end
end
end

View File

@@ -0,0 +1,16 @@
# frozen_string_literal: true
class Hash
def stringify_keys_deep!
new_hash = {}
keys.each do |k|
ks = k.respond_to?(:to_s) ? k.to_s : k
new_hash[ks] = if values_at(k).first.is_a?(Hash) || values_at(k).first.is_a?(Array)
values_at(k).first.send(:stringify_keys_deep!)
else
values_at(k).first
end
end
new_hash
end
end

View File

@@ -0,0 +1,36 @@
# frozen_string_literal: true
require "logger"
require "rainbow"
module GitHubChangelogGenerator
module Helper
# @return true if the currently running program is a unit test
def self.test?
defined? SpecHelper
end
# :nocov:
@log ||= if test?
Logger.new(nil) # don't show any logs when running tests
else
Logger.new(STDOUT)
end
@log.formatter = proc do |severity, _datetime, _progname, msg|
string = "#{msg}\n"
case severity
when "DEBUG" then Rainbow(string).magenta
when "INFO" then Rainbow(string).white
when "WARN" then Rainbow(string).yellow
when "ERROR" then Rainbow(string).red
when "FATAL" then Rainbow(string).red.bright
else string
end
end
# :nocov:
# Logging happens using this method
class << self
attr_reader :log
end
end
end

View File

@@ -0,0 +1,322 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
# (such as filtering, validating, e.t.c)
#
# Example:
# fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
class OctoFetcher
PER_PAGE_NUMBER = 100
MAX_THREAD_NUMBER = 1
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
"This script can make only 50 requests to GitHub API per hour without token!"
# @param options [Hash] Options passed in
# @option options [String] :user GitHub username
# @option options [String] :project GitHub project
# @option options [String] :since Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. eg. Time.parse("2016-01-01 10:00:00").iso8601
# @option options [Boolean] :http_cache Use ActiveSupport::Cache::FileStore to cache http requests
# @option options [Boolean] :cache_file If using http_cache, this is the cache file path
# @option options [Boolean] :cache_log If using http_cache, this is the cache log file path
def initialize(options = {}) # rubocop:disable Metrics/CyclomaticComplexity
@options = options || {}
@user = @options[:user]
@project = @options[:project]
@since = @options[:since]
@http_cache = @options[:http_cache]
@cache_file = @options.fetch(:cache_file, "/tmp/github-changelog-http-cache") if @http_cache
@cache_log = @options.fetch(:cache_log, "/tmp/github-changelog-logger.log") if @http_cache
init_cache if @http_cache
@github_token = fetch_github_token
@request_options = { per_page: PER_PAGE_NUMBER }
@github_options = {}
@github_options[:access_token] = @github_token unless @github_token.nil?
@github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
client_type = @options[:github_endpoint].nil? ? Octokit::Client : Octokit::EnterpriseAdminClient
@client = client_type.new(@github_options)
end
def init_cache
middleware_opts = {
serializer: Marshal,
store: ActiveSupport::Cache::FileStore.new(@cache_file),
logger: Logger.new(@cache_log),
shared_cache: false
}
stack = Faraday::RackBuilder.new do |builder|
builder.use Faraday::HttpCache, middleware_opts
builder.use Octokit::Response::RaiseError
builder.adapter Faraday.default_adapter
# builder.response :logger
end
Octokit.middleware = stack
end
# Fetch all tags from repo
#
# @return [Array <Hash>] array of tags
def get_all_tags
print "Fetching tags...\r" if @options[:verbose]
check_github_response { github_fetch_tags }
end
# Returns the number of pages for a API call
#
# @return [Integer] number of pages for this API call in total
def calculate_pages(client, method, request_options)
# Makes the first API call so that we can call last_response
check_github_response do
client.send(method, user_project, @request_options.merge(request_options))
end
last_response = client.last_response
if (last_pg = last_response.rels[:last])
parse_url_for_vars(last_pg.href)["page"].to_i
else
1
end
end
# Fill input array with tags
#
# @return [Array <Hash>] array of tags in repo
def github_fetch_tags
tags = []
page_i = 0
count_pages = calculate_pages(@client, "tags", {})
iterate_pages(@client, "tags", {}) do |new_tags|
page_i += PER_PAGE_NUMBER
print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
tags.concat(new_tags)
end
print_empty_line
if tags.count == 0
Helper.log.warn "Warning: Can't find any tags in repo.\
Make sure, that you push tags to remote repo via 'git push --tags'"
else
Helper.log.info "Found #{tags.count} tags"
end
# tags are a Sawyer::Resource. Convert to hash
tags = tags.map { |h| h.to_hash.stringify_keys_deep! }
tags
end
# This method fetch all closed issues and separate them to pull requests and pure issues
# (pull request is kind of issue in term of GitHub)
#
# @return [Tuple] with (issues [Array <Hash>], pull-requests [Array <Hash>])
def fetch_closed_issues_and_pr
print "Fetching closed issues...\r" if @options[:verbose]
issues = []
options = {
state: "closed",
filter: "all",
labels: nil
}
options[:since] = @since unless @since.nil?
page_i = 0
count_pages = calculate_pages(@client, "issues", options)
iterate_pages(@client, "issues", options) do |new_issues|
page_i += PER_PAGE_NUMBER
print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
issues.concat(new_issues)
break if @options[:max_issues] && issues.length >= @options[:max_issues]
end
print_empty_line
Helper.log.info "Received issues: #{issues.count}"
issues = issues.map { |h| h.to_hash.stringify_keys_deep! }
# separate arrays of issues and pull requests:
issues.partition do |x|
x["pull_request"].nil?
end
end
# Fetch all pull requests. We need them to detect :merged_at parameter
#
# @return [Array <Hash>] all pull requests
def fetch_closed_pull_requests
pull_requests = []
options = { state: "closed" }
unless @options[:release_branch].nil?
options[:base] = @options[:release_branch]
end
page_i = 0
count_pages = calculate_pages(@client, "pull_requests", options)
iterate_pages(@client, "pull_requests", options) do |new_pr|
page_i += PER_PAGE_NUMBER
log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
print_in_same_line(log_string)
pull_requests.concat(new_pr)
end
print_empty_line
Helper.log.info "Pull Request count: #{pull_requests.count}"
pull_requests = pull_requests.map { |h| h.to_hash.stringify_keys_deep! }
pull_requests
end
# Fetch event for all issues and add them to 'events'
#
# @param [Array] issues
# @return [Void]
def fetch_events_async(issues)
i = 0
threads = []
issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
issues_slice.each do |issue|
threads << Thread.new do
issue["events"] = []
iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
issue["events"].concat(new_event)
end
issue["events"] = issue["events"].map { |h| h.to_hash.stringify_keys_deep! }
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
i += 1
end
end
threads.each(&:join)
threads = []
end
# to clear line from prev print
print_empty_line
Helper.log.info "Fetching events for issues and PR: #{i}"
end
# Fetch tag time from repo
#
# @param [Hash] tag GitHub data item about a Tag
#
# @return [Time] time of specified tag
def fetch_date_of_tag(tag)
commit_data = check_github_response { @client.commit(user_project, tag["commit"]["sha"]) }
commit_data = commit_data.to_hash.stringify_keys_deep!
commit_data["commit"]["committer"]["date"]
end
# Fetch commit for specified event
#
# @return [Hash]
def fetch_commit(event)
check_github_response do
commit = @client.commit(user_project, event["commit_id"])
commit = commit.to_hash.stringify_keys_deep!
commit
end
end
private
# Iterates through all pages until there are no more :next pages to follow
# yields the result per page
#
# @param [Octokit::Client] client
# @param [String] method (eg. 'tags')
# @return [Integer] total number of pages
def iterate_pages(client, method, *args)
if args.size == 1 && args.first.is_a?(Hash)
request_options = args.delete_at(0)
elsif args.size > 1 && args.last.is_a?(Hash)
request_options = args.delete_at(args.length - 1)
end
args.push(@request_options.merge(request_options))
pages = 1
check_github_response do
client.send(method, user_project, *args)
end
last_response = client.last_response
yield last_response.data
until (next_one = last_response.rels[:next]).nil?
pages += 1
last_response = check_github_response { next_one.get }
yield last_response.data
end
pages
end
# This is wrapper with rescue block
#
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
def check_github_response
begin
value = yield
rescue Octokit::Unauthorized => e
Helper.log.error e.message
abort "Error: wrong GitHub token"
rescue Octokit::Forbidden => e
Helper.log.warn e.message
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
Helper.log.warn @client.rate_limit
end
value
end
# Print specified line on the same string
#
# @param [String] log_string
def print_in_same_line(log_string)
print log_string + "\r"
end
# Print long line with spaces on same line to clear prev message
def print_empty_line
print_in_same_line(" ")
end
# Returns GitHub token. First try to use variable, provided by --token option,
# otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
#
# @return [String]
def fetch_github_token
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
Helper.log.warn NO_TOKEN_PROVIDED unless env_var
env_var
end
# @return [String] helper to return Github "user/project"
def user_project
"#{@options[:user]}/#{@options[:project]}"
end
# Parses a URI and returns a hash of all GET variables
#
# @param [String] uri eg. https://api.github.com/repositories/43914960/tags?page=37&foo=1
# @return [Hash] of all GET variables. eg. { 'page' => 37, 'foo' => 1 }
def parse_url_for_vars(uri)
URI(uri).query.split("&").each_with_object({}) do |get_var, params|
k, v = get_var.split("=")
params[k] = v
params
end
end
end
end

232
lib/github_changelog_generator/parser.rb Normal file → Executable file
View File

@@ -1,34 +1,45 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "optparse"
require "pp"
require_relative "version"
require_relative "helper"
module GitHubChangelogGenerator
class Parser
# parse options with optparse
def self.parse_options
options = get_default_options
options = default_options
ParserFile.new(options).parse!
parser = setup_parser(options)
parser.parse!
detect_user_and_project(options)
fetch_user_and_project(options)
if !options[:user] || !options[:project]
puts parser.banner
exit
end
abort(parser.banner) unless options[:user] && options[:project]
if options[:verbose]
puts "Performing task with options:"
pp options
puts ""
end
print_options(options)
options
end
# If options set to verbose, print the parsed options.
#
# The GitHub `:token` key is censored in the output.
#
# @param options [Hash] The options to display
# @option options [Boolean] :verbose If false this method does nothing
def self.print_options(options)
if options[:verbose]
Helper.log.info "Performing task with options:"
options_to_display = options.clone
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
pp options_to_display
puts ""
end
end
# setup parsing options
def self.setup_parser(options)
parser = OptionParser.new do |opts|
@@ -48,6 +59,27 @@ module GitHubChangelogGenerator
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
options[:output] = last
end
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
options[:base] = last
end
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
options[:bug_prefix] = v
end
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
options[:enhancement_prefix] = v
end
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
options[:issue_prefix] = v
end
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
options[:header] = v
end
opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
end
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
options[:merge_prefix] = v
end
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
options[:issues] = v
end
@@ -66,6 +98,9 @@ module GitHubChangelogGenerator
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
options[:author] = author
end
opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
options[:usernames_as_github_logins] = v
end
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
options[:unreleased_only] = v
end
@@ -78,21 +113,39 @@ module GitHubChangelogGenerator
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
options[:compare_link] = v
end
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the 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.") do |list|
options[:include_labels] = list
end
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
options[:exclude_labels] = list
end
opts.on("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
options[:bug_labels] = list
end
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
options[:enhancement_labels] = list
end
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
options[:between_tags] = list
end
opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list|
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
options[:exclude_tags] = list
end
opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
options[:exclude_tags_regex] = last
end
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
options[:since_tag] = v
end
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
options[:due_tag] = v
end
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
options[:max_issues] = max
end
opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
options[:release_url] = url
end
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
options[:github_site] = last
end
@@ -105,6 +158,18 @@ module GitHubChangelogGenerator
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
options[:future_release] = future_release
end
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
options[:release_branch] = release_branch
end
opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
options[:http_cache] = http_cache
end
opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is /tmp/github-changelog-http-cache") do |cache_file|
options[:cache_file] = cache_file
end
opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is /tmp/github-changelog-logger.log") do |cache_log|
options[:cache_log] = cache_log
end
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
options[:verbose] = v
end
@@ -120,13 +185,14 @@ module GitHubChangelogGenerator
parser
end
# just get default options
def self.get_default_options
options = {
# @return [Hash] Default options
def self.default_options
{
tag1: nil,
tag2: nil,
date_format: "%Y-%m-%d",
output: "CHANGELOG.md",
base: "HISTORY.md",
issues: true,
add_issues_wo_labels: true,
add_pr_wo_labels: true,
@@ -136,56 +202,82 @@ module GitHubChangelogGenerator
unreleased: true,
unreleased_label: "Unreleased",
compare_link: true,
include_labels: %w(bug enhancement),
exclude_labels: %w(duplicate question invalid wontfix),
enhancement_labels: %w(enhancement Enhancement),
bug_labels: %w(bug Bug),
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
max_issues: nil,
simple_list: false,
verbose: true,
header: "# Change Log",
merge_prefix: "**Merged pull requests:**",
issue_prefix: "**Closed issues:**",
bug_prefix: "**Fixed bugs:**",
enhancement_prefix: "**Implemented enhancements:**",
git_remote: "origin"
git_remote: "origin",
http_cache: true,
cache_file: "/tmp/github-changelog-http-cache",
cache_log: "/tmp/github-changelog-logger.log"
}
options
end
# Detects user and project from git
def self.detect_user_and_project(options)
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
if !options[:user] || !options[:project]
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
options[:user] = "skywinder"
options[:project] = "changelog_test"
else
remote = `git config --get remote.#{options[:git_remote]}.url`
options[:user], options[:project] = user_project_from_remote(remote)
end
# If `:user` or `:project` not set in options, try setting them
# Valid unnamed parameters:
# 1) in 1 param: repo_name/project
# 2) in 2 params: repo name project
def self.fetch_user_and_project(options)
if options[:user].nil? || options[:project].nil?
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
options[:user] ||= user
options[:project] ||= project
end
end
# Try to find user and project name from git remote output
# Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
# @param [String] arg0 first argument in cli
# @param [String] arg1 second argument in cli
# @return [Array<String>] user and project, or nil if unsuccessful
def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
user, project = user_project_from_option(arg0, arg1, options[:github_site])
unless user && project
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
user = "skywinder"
project = "changelog_test"
else
remote = `git config --get remote.#{options[:git_remote]}.url`
user, project = user_project_from_remote(remote)
end
end
[user, project]
end
# Returns GitHub username and project from CLI arguments
#
# @param [String] output of git remote command
# @return [Array] user and project
def self.user_project_from_option(arg0, arg1, github_site = nil)
# @param arg0 [String] This parameter takes two forms: Either a full
# GitHub URL, or a 'username/projectname', or
# simply a GitHub username
# @param arg1 [String] If arg0 is given as a username,
# then arg1 can given as a projectname
# @param github_site [String] Domain name of GitHub site
#
# @return [Array, nil] user and project, or nil if unsuccessful
def self.user_project_from_option(arg0, arg1, github_site)
user = nil
project = nil
github_site ||= "github.com"
if arg0 && !arg1
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
puts arg0
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or
# "skywinder/Github-Changelog-Generator" to user and name
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
begin
param = match[2].nil?
rescue
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
exit
return
end
if param
exit
return
else
user = match[1]
project = match[2]
@@ -194,43 +286,43 @@ module GitHubChangelogGenerator
[user, project]
end
# Try to find user and project name from git remote output
# These patterns match these formats:
#
# ```
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
# git@github.com:skywinder/Github-Changelog-Generator.git
# ```
#
# and
#
# ```
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
# ```
GIT_REMOTE_PATTERNS = [
/.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
/.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
]
# Returns GitHub username and project from git remote output
#
# @param git_remote_output [String] Output of git remote command
#
# @param [String] output of git remote command
# @return [Array] user and project
def self.user_project_from_remote(remote)
# try to find repo in format:
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
# git@github.com:skywinder/Github-Changelog-Generator.git
regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
# try to find repo in format:
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
remote_structures = [regex1, regex2]
def self.user_project_from_remote(git_remote_output)
user = nil
project = nil
remote_structures.each do |regex|
matches = Regexp.new(regex).match(remote)
GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
git_remote_pattern =~ git_remote_output
if matches && matches[1] && matches[2]
puts "Detected user:#{matches[1]}, project:#{matches[2]}"
user = matches[1]
project = matches[2]
if Regexp.last_match
user = Regexp.last_match(:user)
project = Regexp.last_match(:project)
break
end
break unless matches.nil?
end
[user, project]
end
end
if __FILE__ == $PROGRAM_NAME
remote = "invalid reference to project"
p user_project_from_option(ARGV[0], ARGV[1], remote)
end
end

View File

@@ -0,0 +1,104 @@
# frozen_string_literal: true
require "pathname"
module GitHubChangelogGenerator
ParserError = Class.new(StandardError)
# ParserFile is a configuration file reader which sets options in the
# given Hash.
#
# In your project's root, you can put a file named
# <tt>.github_changelog_generator</tt> to override defaults.
#
# Example:
# header_label=# My Super Changelog
# ; Comments are allowed
# future-release=5.0.0
# # Ruby-style comments, too
# since-tag=1.0.0
#
# The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
#
class ParserFile
# @param options [Hash] options to be configured from file contents
# @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
def initialize(options, file = open_settings_file)
@options = options
@file = file
end
# Sets options using configuration file content
def parse!
return unless @file
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
@file.close
end
private
FILENAME = ".github_changelog_generator"
def open_settings_file
path = Pathname(File.expand_path(FILENAME))
File.open(path) if path.exist?
end
def parse_line!(line, line_number)
return if non_configuration_line?(line)
option_name, value = extract_pair(line)
@options[option_key_for(option_name)] = convert_value(value, option_name)
rescue
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
end
# Returns true if the line starts with a pound sign or a semi-colon.
def non_configuration_line?(line)
line =~ /^[\#;]/ || line =~ /^[\s]+$/
end
# Returns a the option name as a symbol and its string value sans newlines.
#
# @param line [String] unparsed line from config file
# @return [Array<Symbol, String>]
def extract_pair(line)
key, value = line.split("=", 2)
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
end
KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
:enhancement_labels, :between_tags, :exclude_tags]
KNOWN_INTEGER_KEYS = [:max_issues]
def convert_value(value, option_name)
if KNOWN_ARRAY_KEYS.include?(option_name)
value.split(",")
elsif KNOWN_INTEGER_KEYS.include?(option_name)
value.to_i
elsif value =~ /^(true|t|yes|y|1)$/i
true
elsif value =~ /^(false|f|no|n|0)$/i
false
else
value
end
end
IRREGULAR_OPTIONS = {
bugs_label: :bug_prefix,
enhancement_label: :enhancement_prefix,
issues_label: :issue_prefix,
header_label: :header,
front_matter: :frontmatter,
pr_label: :merge_prefix,
issues_wo_labels: :add_issues_wo_labels,
pr_wo_labels: :add_pr_wo_labels,
pull_requests: :pulls,
filter_by_milestone: :filter_issues_by_milestone,
github_api: :github_endpoint
}
def option_key_for(option_name)
IRREGULAR_OPTIONS.fetch(option_name) { option_name }
end
end
end

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#
@@ -53,31 +54,28 @@ module GitHubChangelogGenerator
@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?
if matches
captures.merge!(Hash[matches.names.zip(matches.captures)])
break
end
end
captures
end
# Parse the given ChangeLog data into a Hash
# Parse the given ChangeLog data into a list of Hashes
#
# @param [String] data File data from the ChangeLog.md
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
# @return [Array<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
headings.each_with_index.map do |heading, index|
section = parse_heading(heading)
section["content"] = sections.at(index + 1)
section
end
changelog
end
def read(file_path)

View File

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

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
VERSION = "1.5.0"
VERSION = "1.13.1"
end

View File

@@ -0,0 +1,252 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
.
.SH "NAME"
\fBgit\-generate\-changelog\fR \- Generate changelog from github
.
.SH "SYNOPSIS"
\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
.
.SH "DESCRIPTION"
Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
.
.SH "OPTIONS"
\-u, \-\-user [USER]
.
.P
Username of the owner of target GitHub repo
.
.P
\-p, \-\-project [PROJECT]
.
.P
Name of project on GitHub
.
.P
\-t, \-\-token [TOKEN]
.
.P
To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
.
.P
\-f, \-\-date\-format [FORMAT]
.
.P
Date format\. Default is %Y\-%m\-%d
.
.P
\-o, \-\-output [NAME]
.
.P
Output file\. Default is CHANGELOG\.md
.
.P
\-b, \-\-base [NAME]
.
.P
Optional base file to append generated changes to\.
.
.P
\-\-bugs\-label [LABEL]
.
.P
Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
.
.P
\-\-enhancement\-label [LABEL]
.
.P
Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
.
.P
\-\-issues\-label [LABEL]
.
.P
Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
.
.P
\-\-header\-label [LABEL]
.
.P
Setup custom header label\. Default is "# Change Log"
.
.P
\-\-pr\-label [LABEL]
.
.P
Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
.
.P
\-\-[no\-]issues
.
.P
Include closed issues in changelog\. Default is true
.
.P
\-\-[no\-]issues\-wo\-labels
.
.P
Include closed issues without labels in changelog\. Default is true
.
.P
\-\-[no\-]pr\-wo\-labels
.
.P
Include pull requests without labels in changelog\. Default is true
.
.P
\-\-[no\-]pull\-requests
.
.P
Include pull\-requests in changelog\. Default is true
.
.P
\-\-[no\-]filter\-by\-milestone
.
.P
Use milestone to detect when issue was resolved\. Default is true
.
.P
\-\-[no\-]author
.
.P
Add author of pull\-request in the end\. Default is true
.
.P
\-\-unreleased\-only
.
.P
Generate log from unreleased closed issues only\.
.
.P
\-\-[no\-]unreleased
.
.P
Add to log unreleased closed issues\. Default is true
.
.P
\-\-unreleased\-label [label]
.
.P
Add to log unreleased closed issues\. Default is true
.
.P
\-\-[no\-]compare\-link
.
.P
Include compare link (Full Changelog) between older version and newer version\. Default is true
.
.P
\-\-include\-labels x,y,z
.
.P
Only issues with the specified labels will be included in the changelog\.
.
.P
\-\-exclude\-labels x,y,z
.
.P
Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
.
.P
\-\-bug\-labels x,y,z
.
.P
Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
.
.P
\-\-enhancement\-labels x,y,z
.
.P
Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
.
.P
\-\-between\-tags x,y,z
.
.P
Change log will be filled only between specified tags
.
.P
\-\-exclude\-tags x,y,z
.
.P
Change log will exclude specified tags
.
.P
\-\-since\-tag x
.
.P
Change log will start after specified tag
.
.P
\-\-due\-tag x
.
.P
Change log will end before specified tag
.
.P
\-\-max\-issues [NUMBER]
.
.P
Max number of issues to fetch from GitHub\. Default is unlimited
.
.P
\-\-release\-url [URL]
.
.P
The URL to point to for release links, in printf format (with the tag as variable)\.
.
.P
\-\-github\-site [URL]
.
.P
The Enterprise Github site on which your project is hosted\.
.
.P
\-\-github\-api [URL]
.
.P
The enterprise endpoint to use for your Github API\.
.
.P
\-\-simple\-list
.
.P
Create simple list from issues and pull requests\. Default is false\.
.
.P
\-\-future\-release [RELEASE\-VERSION]
.
.P
Put the unreleased changes in the specified release number\.
.
.P
\-\-[no\-]verbose
.
.P
Run verbosely\. Default is true
.
.P
\-v, \-\-version
.
.P
Print version number
.
.P
\-h, \-\-help
.
.P
Displays Help
.
.SH "EXAMPLES"
.
.SH "AUTHOR"
Written by Petr Korolev sky4winder@gmail\.com
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>

View File

@@ -0,0 +1,262 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>git-generate-changelog(1) - Generate changelog from github</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>git-generate-changelog(1)</li>
<li class='tc'></li>
<li class='tr'>git-generate-changelog(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p> -u, --user [USER]</p>
<p> Username of the owner of target GitHub repo</p>
<p> -p, --project [PROJECT]</p>
<p> Name of project on GitHub</p>
<p> -t, --token [TOKEN]</p>
<p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
<p> -f, --date-format [FORMAT]</p>
<p> Date format. Default is %Y-%m-%d</p>
<p> -o, --output [NAME]</p>
<p> Output file. Default is CHANGELOG.md</p>
<p> -b, --base [NAME]</p>
<p> Optional base file to append generated changes to.</p>
<p> --bugs-label [LABEL]</p>
<p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
<p> --enhancement-label [LABEL]</p>
<p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
<p> --issues-label [LABEL]</p>
<p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
<p> --header-label [LABEL]</p>
<p> Setup custom header label. Default is "# Change Log"</p>
<p> --pr-label [LABEL]</p>
<p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
<p> --[no-]issues</p>
<p> Include closed issues in changelog. Default is true</p>
<p> --[no-]issues-wo-labels</p>
<p> Include closed issues without labels in changelog. Default is true</p>
<p> --[no-]pr-wo-labels</p>
<p> Include pull requests without labels in changelog. Default is true</p>
<p> --[no-]pull-requests</p>
<p> Include pull-requests in changelog. Default is true</p>
<p> --[no-]filter-by-milestone</p>
<p> Use milestone to detect when issue was resolved. Default is true</p>
<p> --[no-]author</p>
<p> Add author of pull-request in the end. Default is true</p>
<p> --unreleased-only</p>
<p> Generate log from unreleased closed issues only.</p>
<p> --[no-]unreleased</p>
<p> Add to log unreleased closed issues. Default is true</p>
<p> --unreleased-label [label]</p>
<p> Add to log unreleased closed issues. Default is true</p>
<p> --[no-]compare-link</p>
<p> Include compare link (Full Changelog) between older version and newer version. Default is true</p>
<p> --include-labels x,y,z</p>
<p> Only issues with the specified labels will be included in the changelog.</p>
<p> --exclude-labels x,y,z</p>
<p> Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
<p> --bug-labels x,y,z</p>
<p> Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
<p> --enhancement-labels x,y,z</p>
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
<p> --between-tags x,y,z</p>
<p> Change log will be filled only between specified tags</p>
<p> --exclude-tags x,y,z</p>
<p> Change log will exclude specified tags</p>
<p> --since-tag x</p>
<p> Change log will start after specified tag</p>
<p> --due-tag x</p>
<p> Change log will end before specified tag</p>
<p> --max-issues [NUMBER]</p>
<p> Max number of issues to fetch from GitHub. Default is unlimited</p>
<p> --release-url [URL]</p>
<p> The URL to point to for release links, in printf format (with the tag as variable).</p>
<p> --github-site [URL]</p>
<p> The Enterprise Github site on which your project is hosted.</p>
<p> --github-api [URL]</p>
<p> The enterprise endpoint to use for your Github API.</p>
<p> --simple-list</p>
<p> Create simple list from issues and pull requests. Default is false.</p>
<p> --future-release [RELEASE-VERSION]</p>
<p> Put the unreleased changes in the specified release number.</p>
<p> --[no-]verbose</p>
<p> Run verbosely. Default is true</p>
<p> -v, --version</p>
<p> Print version number</p>
<p> -h, --help</p>
<p> Displays Help</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Petr Korolev sky4winder@gmail.com</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>October 2015</li>
<li class='tr'>git-generate-changelog(1)</li>
</ol>
</div>
</body>
</html>

View File

@@ -0,0 +1,179 @@
git-generate-changelog(1) - Generate changelog from github
================================
## SYNOPSIS
`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
## DESCRIPTION
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
## OPTIONS
-u, --user [USER]
Username of the owner of target GitHub repo
-p, --project [PROJECT]
Name of project on GitHub
-t, --token [TOKEN]
To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
-f, --date-format [FORMAT]
Date format. Default is %Y-%m-%d
-o, --output [NAME]
Output file. Default is CHANGELOG.md
-b, --base [NAME]
Optional base file to append generated changes to.
--bugs-label [LABEL]
Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
--enhancement-label [LABEL]
Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
--issues-label [LABEL]
Setup custom label for closed-issues section. Default is "**Closed issues:**"
--header-label [LABEL]
Setup custom header label. Default is "# Change Log"
--pr-label [LABEL]
Setup custom label for pull requests section. Default is "**Merged pull requests:**"
--[no-]issues
Include closed issues in changelog. Default is true
--[no-]issues-wo-labels
Include closed issues without labels in changelog. Default is true
--[no-]pr-wo-labels
Include pull requests without labels in changelog. Default is true
--[no-]pull-requests
Include pull-requests in changelog. Default is true
--[no-]filter-by-milestone
Use milestone to detect when issue was resolved. Default is true
--[no-]author
Add author of pull-request in the end. Default is true
--unreleased-only
Generate log from unreleased closed issues only.
--[no-]unreleased
Add to log unreleased closed issues. Default is true
--unreleased-label [label]
Add to log unreleased closed issues. Default is true
--[no-]compare-link
Include compare link (Full Changelog) between older version and newer version. Default is true
--include-labels x,y,z
Only issues with the specified labels will be included in the changelog.
--exclude-labels x,y,z
Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
--bug-labels x,y,z
Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
--enhancement-labels x,y,z
Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
--between-tags x,y,z
Change log will be filled only between specified tags
--exclude-tags x,y,z
Change log will exclude specified tags
--since-tag x
Change log will start after specified tag
--due-tag x
Change log will end before specified tag
--max-issues [NUMBER]
Max number of issues to fetch from GitHub. Default is unlimited
--release-url [URL]
The URL to point to for release links, in printf format (with the tag as variable).
--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.
--simple-list
Create simple list from issues and pull requests. Default is false.
--future-release [RELEASE-VERSION]
Put the unreleased changes in the specified release number.
--[no-]verbose
Run verbosely. Default is true
-v, --version
Print version number
-h, --help
Displays Help
## EXAMPLES
## AUTHOR
Written by Petr Korolev sky4winder@gmail.com
## REPORTING BUGS
&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
## SEE ALSO
&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;

View File

@@ -0,0 +1,3 @@
source "https://rubygems.org"
gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#
@@ -18,100 +19,61 @@
require "codeclimate-test-reporter"
require "simplecov"
require "coveralls"
require "vcr"
require "webmock/rspec"
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
Coveralls::SimpleCov::Formatter,
SimpleCov::Formatter::HTMLFormatter,
CodeClimate::TestReporter::Formatter
]
SimpleCov.start
# This module is only used to check the environment is currently a testing env
module SpecHelper
end
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
Coveralls::SimpleCov::Formatter,
SimpleCov::Formatter::HTMLFormatter,
CodeClimate::TestReporter::Formatter
])
SimpleCov.start do
add_filter "gemfiles/"
end
require "github_changelog_generator"
require "github_changelog_generator/task"
VCR.configure do |c|
c.allow_http_connections_when_no_cassette = true
c.cassette_library_dir = "spec/vcr"
c.ignore_localhost = true
c.default_cassette_options = {
record: :new_episodes,
serialize_with: :json,
preserve_exact_body_bytes: true,
decode_compressed_response: true
}
c.filter_sensitive_data("<GITHUB_TOKEN>") do
"token #{ENV.fetch('CHANGELOG_GITHUB_TOKEN') { 'frobnitz' }}"
end
c.configure_rspec_metadata!
c.hook_into :webmock, :faraday
end
# 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
config.default_formatter = "doc" if config.files_to_run.one?
# 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

View File

@@ -1,59 +0,0 @@
VALID_TOKEN = "0123456789abcdef"
INVALID_TOKEN = "0000000000000000"
DEFAULT_OPTIONS = { user: "skywinder",
project: "changelog_test" }
def options_with_invalid_token
options = DEFAULT_OPTIONS
options[:token] = INVALID_TOKEN
options
end
describe GitHubChangelogGenerator::Fetcher do
before(:all) do
@fetcher = GitHubChangelogGenerator::Fetcher.new
end
describe "#fetch_github_token" do
token = GitHubChangelogGenerator::Fetcher::CHANGELOG_GITHUB_TOKEN
context "when token in ENV exist" do
before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
subject { @fetcher.fetch_github_token }
it { is_expected.to eq(VALID_TOKEN) }
end
context "when token in ENV is nil" do
before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
subject { @fetcher.fetch_github_token }
it { is_expected.to be_nil }
end
context "when token in options and ENV is nil" do
before do
stub_const("ENV", ENV.to_hash.merge(token => nil))
@fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
end
subject { @fetcher.fetch_github_token }
it { is_expected.to eq(VALID_TOKEN) }
end
context "when token in options and ENV specified" do
before do
stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
@fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
end
subject { @fetcher.fetch_github_token }
it { is_expected.to eq(VALID_TOKEN) }
end
end
describe "#github_fetch_tags" do
context "when wrong token provided" do
before do
options = options_with_invalid_token
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
end
it "should raise Unauthorized error" do
expect { @fetcher.github_fetch_tags [] }.to raise_error Github::Error::Unauthorized
end
end
end
end

View File

@@ -0,0 +1,29 @@
# frozen_string_literal: true
module GitHubChangelogGenerator
describe Generator do
context "#exclude_issues_by_labels" do
let(:label) { { "name" => "BAD" } }
let(:issue) { { "labels" => [label] } }
let(:good_label) { { "name" => "GOOD" } }
let(:good_issue) { { "labels" => [good_label] } }
let(:issues) { [issue, good_issue] }
subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
it "removes issues with labels in the exclude_label list" do
result = generator.exclude_issues_by_labels(issues)
expect(result).to include(good_issue)
expect(result).not_to include(issue)
end
context "with no option given" do
subject(:generator) { described_class.new }
it "passes everything through when no option given" do
result = generator.exclude_issues_by_labels(issues)
expect(result).to eq(issues)
end
end
end
end
end

View File

@@ -1,4 +1,17 @@
# frozen_string_literal: true
describe GitHubChangelogGenerator::Generator do
def tag_with_name(tag)
{
"name" => tag
}
end
def tags_from_strings(tags_strings)
tags_strings.map do |tag|
tag_with_name(tag)
end
end
describe "#filter_between_tags" do
context "when between_tags nil" do
before do
@@ -6,20 +19,20 @@ describe GitHubChangelogGenerator::Generator do
end
subject do
@generator.get_filtered_tags(%w(1 2 3))
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(%w(1 2 3)) }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
context "when between_tags same as input array" do
before do
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
end
subject do
@generator.get_filtered_tags(%w(1 2 3))
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(%w(1 2 3)) }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
context "when between_tags filled with correct values" do
@@ -27,10 +40,10 @@ describe GitHubChangelogGenerator::Generator do
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
end
subject do
@generator.get_filtered_tags(%w(1 2 3))
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(%w(1 2)) }
it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
end
context "when between_tags filled with invalid values" do
@@ -39,31 +52,196 @@ describe GitHubChangelogGenerator::Generator do
end
subject do
@generator.get_filtered_tags(%w(1 2 3))
@generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
end
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(%w(1)) }
it { is_expected.to match_array(tags_from_strings(%w(1))) }
end
end
describe "#get_filtered_tags" do
subject { generator.get_filtered_tags(%w(1 2 3 4 5)) }
# before { generator.get_filtered_tags(%w(1 2 3 4 5)) }
subject do
generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5)))
end
context "respects between tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
context "with excluded and between tags" do
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(%w(1 3)) }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
end
describe "#filter_excluded_tags" do
subject { generator.filter_excluded_tags(%w(1 2 3)) }
subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
context "with valid excluded tags" do
context "with matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(%w(1 2)) }
it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
end
context "with non-matching string" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1))) }
end
context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
end
describe "#filter_excluded_tags_regex" do
subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
context "with matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1))) }
end
context "with non-matching regex" do
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
end
describe "#filter_since_tag" do
context "with filled array" do
subject { generator.filter_since_tag(tags_from_strings(%w(1 2 3))) }
context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1))) }
end
context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
end
context "with empty array" do
subject { generator.filter_since_tag(tags_from_strings(%w())) }
context "with valid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w())) }
end
context "with invalid since tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w())) }
end
end
end
describe "#filter_due_tag" do
context "with filled array" do
subject { generator.filter_due_tag(tags_from_strings(%w(1 2 3))) }
context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(3))) }
end
context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
end
end
context "with empty array" do
subject { generator.filter_due_tag(tags_from_strings(%w())) }
context "with valid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w())) }
end
context "with invalid due tag" do
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
it { is_expected.to be_a Array }
it { is_expected.to match_array(tags_from_strings(%w())) }
end
end
end
describe "#get_time_of_tag" do
current_time = Time.now
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
context "run with nil parameter" do
it "should raise ChangelogGeneratorError" do
expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
end
end
context "fetch already filled tag" do
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
subject { @generator.get_time_of_tag tag_with_name("valid_tag") }
it { is_expected.to be_a_kind_of(Time) }
it { is_expected.to eq(current_time) }
end
context "fetch not filled tag" do
before do
mock = double("fake fetcher")
allow(mock).to receive_messages(fetch_date_of_tag: current_time)
@generator.instance_variable_set :@fetcher, mock
end
subject do
of_tag = @generator.get_time_of_tag(tag_with_name("valid_tag"))
of_tag
end
it { is_expected.to be_a_kind_of(Time) }
it { is_expected.to eq(current_time) }
end
end
describe "#sort_tags_by_date" do
let(:time1) { Time.now }
let(:time2) { Time.now }
let(:time3) { Time.now }
before(:all) do
@generator = GitHubChangelogGenerator::Generator.new
end
before do
@generator.instance_variable_set(:@tag_times_hash, "valid_tag1" => time1,
"valid_tag2" => time2,
"valid_tag3" => time3)
end
subject do
@generator.sort_tags_by_date(tags)
end
context "sort unsorted tags" do
let(:tags) { tags_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
it { is_expected.to be_a_kind_of(Array) }
it { is_expected.to match_array(tags.reverse!) }
end
context "sort sorted tags" do
let(:tags) { tags_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
it { is_expected.to be_a_kind_of(Array) }
it { is_expected.to match_array(tags) }
end
end
end

View File

@@ -0,0 +1,489 @@
# frozen_string_literal: true
VALID_TOKEN = "0123456789abcdef"
INVALID_TOKEN = "0000000000000000"
describe GitHubChangelogGenerator::OctoFetcher do
let(:options) do
{
user: "skywinder",
project: "changelog_test"
}
end
let(:fetcher) { GitHubChangelogGenerator::OctoFetcher.new(options) }
describe "#fetch_github_token" do
token = GitHubChangelogGenerator::OctoFetcher::CHANGELOG_GITHUB_TOKEN
context "when token in ENV exist" do
before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
subject { fetcher.send(:fetch_github_token) }
it { is_expected.to eq(VALID_TOKEN) }
end
context "when token in ENV is nil" do
before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
subject { fetcher.send(:fetch_github_token) }
it { is_expected.to be_nil }
end
context "when token in options and ENV is nil" do
let(:options) { { token: VALID_TOKEN } }
before do
stub_const("ENV", ENV.to_hash.merge(token => nil))
end
subject { fetcher.send(:fetch_github_token) }
it { is_expected.to eq(VALID_TOKEN) }
end
context "when token in options and ENV specified" do
let(:options) { { token: VALID_TOKEN } }
before do
stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
end
subject { fetcher.send(:fetch_github_token) }
it { is_expected.to eq(VALID_TOKEN) }
end
end
describe "#get_all_tags" do
context "when github_fetch_tags returns tags" do
it "returns tags" do
mock_tags = ["tag"]
allow(fetcher).to receive(:github_fetch_tags).and_return(mock_tags)
expect(fetcher.get_all_tags).to eq(mock_tags)
end
end
end
describe "#github_fetch_tags" do
context "when wrong token provided", :vcr do
let(:options) do
{
user: "skywinder",
project: "changelog_test",
token: INVALID_TOKEN
}
end
it "should raise Unauthorized error" do
expect { fetcher.github_fetch_tags }.to raise_error SystemExit, "Error: wrong GitHub token"
end
end
context "when API call is valid", :vcr do
it "should return tags" do
expected_tags = [{ "name" => "v0.0.3",
"zipball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
"tarball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
"commit" =>
{ "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } },
{ "name" => "v0.0.2",
"zipball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.2",
"tarball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.2",
"commit" =>
{ "sha" => "9b35bb13dcd15b68e7bcbf10cde5eb937a54f710",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/9b35bb13dcd15b68e7bcbf10cde5eb937a54f710" } },
{ "name" => "v0.0.1",
"zipball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.1",
"tarball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.1",
"commit" =>
{ "sha" => "4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d" } },
{ "name" => "0.0.4",
"zipball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/zipball/0.0.4",
"tarball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/tarball/0.0.4",
"commit" =>
{ "sha" => "ece0c3ab7142b21064b885061c55ede00ef6ce94",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/ece0c3ab7142b21064b885061c55ede00ef6ce94" } }]
expect(fetcher.github_fetch_tags).to eq(expected_tags)
end
it "should return tags count" do
tags = fetcher.github_fetch_tags
expect(tags.size).to eq(4)
end
end
end
describe "#fetch_closed_issues_and_pr" do
context "when API call is valid", :vcr do
it "returns issues" do
issues, pull_requests = fetcher.fetch_closed_issues_and_pr
expect(issues.size).to eq(7)
expect(pull_requests.size).to eq(14)
end
it "returns issue with proper key/values" do
issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
expected_issue = { "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
"labels_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
"comments_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
"events_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
"html_url" => "https://github.com/skywinder/changelog_test/issues/14",
"id" => 95_419_412,
"number" => 14,
"title" => "Issue closed from commit from PR",
"user" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"labels" => [],
"state" => "closed",
"locked" => false,
"assignee" => nil,
"assignees" => [],
"milestone" => nil,
"comments" => 0,
"created_at" => "2015-07-16T12:06:08Z",
"updated_at" => "2015-07-16T12:21:42Z",
"closed_at" => "2015-07-16T12:21:42Z",
"body" => "" }
# Convert times to Time
expected_issue.each_pair do |k, v|
expected_issue[k] = Time.parse(v) if v =~ /^2015-/
end
expect(issues.first).to eq(expected_issue)
end
it "returns pull request with proper key/values" do
_issues, pull_requests = fetcher.fetch_closed_issues_and_pr
expected_pr = { "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/21",
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
"labels_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/21/labels{/name}",
"comments_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/21/comments",
"events_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/21/events",
"html_url" => "https://github.com/skywinder/changelog_test/pull/21",
"id" => 124_925_759,
"number" => 21,
"title" => "Merged br (should appear in change log with #20)",
"user" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"labels" => [],
"state" => "closed",
"locked" => false,
"assignee" => nil,
"assignees" => [],
"milestone" => nil,
"comments" => 0,
"created_at" => "2016-01-05T09:24:08Z",
"updated_at" => "2016-01-05T09:26:53Z",
"closed_at" => "2016-01-05T09:24:27Z",
"pull_request" =>
{ "url" => "https://api.github.com/repos/skywinder/changelog_test/pulls/21",
"html_url" => "https://github.com/skywinder/changelog_test/pull/21",
"diff_url" => "https://github.com/skywinder/changelog_test/pull/21.diff",
"patch_url" => "https://github.com/skywinder/changelog_test/pull/21.patch" },
"body" =>
"to test https://github.com/skywinder/github-changelog-generator/pull/305\r\nshould appear in change log with #20" }
# Convert times to Time
expected_pr.each_pair do |k, v|
expected_pr[k] = Time.parse(v) if v =~ /^2016-01/
end
expect(pull_requests.first).to eq(expected_pr)
end
it "returns issues with labels" do
issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
expected = [[], [], ["Bug"], [], ["enhancement"], ["some label"], []]
expect(issues.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
end
it "returns pull_requests with labels" do
_issues, pull_requests = fetcher.fetch_closed_issues_and_pr
expected = [[], [], [], [], [], ["enhancement"], [], [], ["invalid"], [], [], [], [], ["invalid"]]
expect(pull_requests.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
end
end
end
describe "#fetch_closed_pull_requests" do
context "when API call is valid", :vcr do
it "returns pull requests" do
pull_requests = fetcher.fetch_closed_pull_requests
expect(pull_requests.size).to eq(14)
end
it "returns correct pull request keys" do
pull_requests = fetcher.fetch_closed_pull_requests
pr = pull_requests.first
expect(pr.keys).to eq(%w(url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links))
end
end
end
describe "#fetch_events_async" do
context "when API call is valid", :vcr do
it "populates issues" do
issues = [{ "url" => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
"repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
"labels_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
"comments_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
"events_url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
"html_url" => "https://github.com/skywinder/changelog_test/issues/14",
"id" => 95_419_412,
"number" => 14,
"title" => "Issue closed from commit from PR",
"user" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" =>
"https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"labels" => [],
"state" => "closed",
"locked" => false,
"assignee" => nil,
"assignees" => [],
"milestone" => nil,
"comments" => 0,
"created_at" => "2015-07-16T12:06:08Z",
"updated_at" => "2015-07-16T12:21:42Z",
"closed_at" => "2015-07-16T12:21:42Z",
"body" => "" }]
# Check that they are blank to begin with
expect(issues.first["events"]).to be_nil
fetcher.fetch_events_async(issues)
issue_events = issues.first["events"]
expected_events = [{ "id" => 357_462_189,
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
"actor" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" =>
"https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"event" => "referenced",
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
"commit_url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
"created_at" => "2015-07-16T12:21:16Z" },
{ "id" => 357_462_542,
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462542",
"actor" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" =>
"https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"event" => "closed",
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
"commit_url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
"created_at" => "2015-07-16T12:21:42Z" }]
# Convert times to Time
expected_events.map! do |event|
event.each_pair do |k, v|
event[k] = Time.parse(v) if v =~ /^201[56]-/
end
end
expect(issue_events).to eq(expected_events)
end
end
end
describe "#fetch_date_of_tag" do
context "when API call is valid", :vcr do
it "returns date" do
tag = { "name" => "v0.0.3",
"zipball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
"tarball_url" =>
"https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
"commit" =>
{ "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } }
dt = fetcher.fetch_date_of_tag(tag)
expect(dt).to eq(Time.parse("2015-03-04 19:01:48 UTC"))
end
end
end
describe "#fetch_commit" do
context "when API call is valid", :vcr do
it "returns commit" do
event = { "id" => 357_462_189,
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
"actor" =>
{ "login" => "skywinder",
"id" => 3_356_474,
"avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3",
"gravatar_id" => "",
"url" => "https://api.github.com/users/skywinder",
"html_url" => "https://github.com/skywinder",
"followers_url" => "https://api.github.com/users/skywinder/followers",
"following_url" =>
"https://api.github.com/users/skywinder/following{/other_user}",
"gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}",
"starred_url" =>
"https://api.github.com/users/skywinder/starred{/owner}{/repo}",
"subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions",
"organizations_url" => "https://api.github.com/users/skywinder/orgs",
"repos_url" => "https://api.github.com/users/skywinder/repos",
"events_url" => "https://api.github.com/users/skywinder/events{/privacy}",
"received_events_url" =>
"https://api.github.com/users/skywinder/received_events",
"type" => "User",
"site_admin" => false },
"event" => "referenced",
"commit_id" => "decfe840d1a1b86e0c28700de5362d3365a29555",
"commit_url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
"created_at" => "2015-07-16T12:21:16Z" }
commit = fetcher.fetch_commit(event)
expectations = [
%w(sha decfe840d1a1b86e0c28700de5362d3365a29555),
["url",
"https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
# OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
["html_url",
"https://github.com/skywinder/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
["author",
{ "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
["committer",
{ "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
["parents",
[{ "sha" => "7ec095e5e3caceacedabf44d0b9b10da17c92e51",
"url" =>
"https://api.github.com/repos/skywinder/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
# OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
"html_url" =>
"https://github.com/skywinder/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
]
expectations.each do |property, val|
expect(commit[property]).to eq(val)
end
end
end
end
end

View File

@@ -0,0 +1,74 @@
# frozen_string_literal: true
describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do
let(:options) { {} }
context "when the well-known default file does not exist" do
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parser.parse! }
it { is_expected.to be_nil }
end
context "when file is empty" do
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
it "does not change the options" do
expect { parser.parse! }.to_not change { options }
end
end
context "when file is incorrect" do
let(:options_before_change) { options.dup }
let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
let(:parser) do
GitHubChangelogGenerator::ParserFile.new(options, file)
end
it { expect { parser.parse! }.to raise_error(/line #2/) }
end
context "allows empty lines and comments with semi-colon or pound sign" do
let(:file) { StringIO.new("\n \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
let(:parser) do
GitHubChangelogGenerator::ParserFile.new(options, file)
end
it { expect { parser.parse! }.not_to raise_error }
end
context "when override default values" do
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
let(:options) { {}.merge(default_options) }
let(:options_before_change) { options.dup }
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
it "changes the options" do
expect { parser.parse! }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(unreleased_label: "staging",
unreleased: false,
header: "=== Changelog ==="))
end
context "turns exclude-labels into an Array", bug: "#327" do
let(:file) do
StringIO.new(<<EOF
exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
header_label=# My changelog
EOF
)
end
it "reads exclude_labels into an Array" do
expect { parser.parse! }.to change { options[:exclude_labels] }
.from(default_options[:exclude_labels])
.to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
end
it "translates given header_label into the :header option" do
expect { parser.parse! }.to change { options[:header] }
.from(default_options[:header])
.to("# My changelog")
end
end
end
end
end

View File

@@ -1,21 +1,22 @@
# frozen_string_literal: true
describe GitHubChangelogGenerator::Parser do
describe ".user_project_from_remote" do
context "when remote is 1" do
context "when remote is type 1" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is 2" do
context "when remote is type 2" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is 3" do
context "when remote is type 3" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when remote is 4" do
context "when remote is type 4" do
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
@@ -27,17 +28,17 @@ describe GitHubChangelogGenerator::Parser do
end
end
describe ".user_project_from_option" do
# context "when option is invalid" do
# it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
# end
context "when option is invalid" do
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
end
context "when option is valid" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
end
context "when option nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
@@ -56,5 +57,26 @@ describe GitHubChangelogGenerator::Parser do
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
context "when all args is not nil" do
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", "https://codeclimate.com") }
it { is_expected.to be_a(Array) }
it { is_expected.to match_array([nil, nil]) }
end
end
describe ".fetch_user_and_project" do
before do
stub_const("ARGV", ["https://github.com/skywinder/github-changelog-generator"])
end
context do
let(:valid_user) { "initialized_user" }
let(:options) { { user: valid_user } }
let(:options_before_change) { options.dup }
it "should leave user unchanged" do
expect { GitHubChangelogGenerator::Parser.fetch_user_and_project(options) }.to change { options }
.from(options_before_change)
.to(options_before_change.merge(project: "github-changelog-generator"))
end
end
end
end

View File

@@ -1,3 +1,4 @@
# frozen_string_literal: true
#
# Author:: Enrico Stahn <mail@enricostahn.com>
#

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1 @@
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/issues/14/events?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 06:13:06 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["200 OK"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["37"],"X-Ratelimit-Reset":["1463724861"],"Cache-Control":["public, max-age=60, s-maxage=60"],"Vary":["Accept","Accept-Encoding"],"Etag":["W/\"4d408c4e8053c706d7255563141ccb80\""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Served-By":["2d7a5e35115884240089368322196939"],"X-Github-Request-Id":["6C2F0F69:7F8B:2084B01:573EAAF2"]},"body":{"encoding":"ASCII-8BIT","base64_string":"W3siaWQiOjM1NzQ2MjE4OSwidXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNv\nbS9yZXBvcy9za3l3aW5kZXIvY2hhbmdlbG9nX3Rlc3QvaXNzdWVzL2V2ZW50\ncy8zNTc0NjIxODkiLCJhY3RvciI6eyJsb2dpbiI6InNreXdpbmRlciIsImlk\nIjozMzU2NDc0LCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1\nYnVzZXJjb250ZW50LmNvbS91LzMzNTY0NzQ/dj0zIiwiZ3JhdmF0YXJfaWQi\nOiIiLCJ1cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdp\nbmRlciIsImh0bWxfdXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL3NreXdpbmRl\nciIsImZvbGxvd2Vyc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9mb2xsb3dlcnMiLCJmb2xsb3dpbmdfdXJsIjoiaHR0\ncHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZm9sbG93aW5n\ney9vdGhlcl91c2VyfSIsImdpc3RzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1\nYi5jb20vdXNlcnMvc2t5d2luZGVyL2dpc3Rzey9naXN0X2lkfSIsInN0YXJy\nZWRfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5k\nZXIvc3RhcnJlZHsvb3duZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJs\nIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvc3Vi\nc2NyaXB0aW9ucyIsIm9yZ2FuaXphdGlvbnNfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvb3JncyIsInJlcG9zX3VybCI6\nImh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL3JlcG9z\nIiwiZXZlbnRzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMv\nc2t5d2luZGVyL2V2ZW50c3svcHJpdmFjeX0iLCJyZWNlaXZlZF9ldmVudHNf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIv\ncmVjZWl2ZWRfZXZlbnRzIiwidHlwZSI6IlVzZXIiLCJzaXRlX2FkbWluIjpm\nYWxzZX0sImV2ZW50IjoicmVmZXJlbmNlZCIsImNvbW1pdF9pZCI6ImRlY2Zl\nODQwZDFhMWI4NmUwYzI4NzAwZGU1MzYyZDMzNjVhMjk1NTUiLCJjb21taXRf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS9yZXBvcy9za3l3aW5kZXIv\nY2hhbmdlbG9nX3Rlc3QvY29tbWl0cy9kZWNmZTg0MGQxYTFiODZlMGMyODcw\nMGRlNTM2MmQzMzY1YTI5NTU1IiwiY3JlYXRlZF9hdCI6IjIwMTUtMDctMTZU\nMTI6MjE6MTZaIn0seyJpZCI6MzU3NDYyNTQyLCJ1cmwiOiJodHRwczovL2Fw\naS5naXRodWIuY29tL3JlcG9zL3NreXdpbmRlci9jaGFuZ2Vsb2dfdGVzdC9p\nc3N1ZXMvZXZlbnRzLzM1NzQ2MjU0MiIsImFjdG9yIjp7ImxvZ2luIjoic2t5\nd2luZGVyIiwiaWQiOjMzNTY0NzQsImF2YXRhcl91cmwiOiJodHRwczovL2F2\nYXRhcnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzM1NjQ3ND92PTMiLCJn\ncmF2YXRhcl9pZCI6IiIsInVybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20v\ndXNlcnMvc2t5d2luZGVyIiwiaHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5j\nb20vc2t5d2luZGVyIiwiZm9sbG93ZXJzX3VybCI6Imh0dHBzOi8vYXBpLmdp\ndGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL2ZvbGxvd2VycyIsImZvbGxvd2lu\nZ191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRl\nci9mb2xsb3dpbmd7L290aGVyX3VzZXJ9IiwiZ2lzdHNfdXJsIjoiaHR0cHM6\nLy9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZ2lzdHN7L2dpc3Rf\naWR9Iiwic3RhcnJlZF91cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9zdGFycmVkey9vd25lcn17L3JlcG99Iiwic3Vic2Ny\naXB0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3Nr\neXdpbmRlci9zdWJzY3JpcHRpb25zIiwib3JnYW5pemF0aW9uc191cmwiOiJo\ndHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRlci9vcmdzIiwi\ncmVwb3NfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3\naW5kZXIvcmVwb3MiLCJldmVudHNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHVi\nLmNvbS91c2Vycy9za3l3aW5kZXIvZXZlbnRzey9wcml2YWN5fSIsInJlY2Vp\ndmVkX2V2ZW50c191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJz\nL3NreXdpbmRlci9yZWNlaXZlZF9ldmVudHMiLCJ0eXBlIjoiVXNlciIsInNp\ndGVfYWRtaW4iOmZhbHNlfSwiZXZlbnQiOiJjbG9zZWQiLCJjb21taXRfaWQi\nOiJkZWNmZTg0MGQxYTFiODZlMGMyODcwMGRlNTM2MmQzMzY1YTI5NTU1Iiwi\nY29tbWl0X3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vcmVwb3Mvc2t5\nd2luZGVyL2NoYW5nZWxvZ190ZXN0L2NvbW1pdHMvZGVjZmU4NDBkMWExYjg2\nZTBjMjg3MDBkZTUzNjJkMzM2NWEyOTU1NSIsImNyZWF0ZWRfYXQiOiIyMDE1\nLTA3LTE2VDEyOjIxOjQyWiJ9XQ==\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 06:13:10 GMT"}],"recorded_with":"VCR 3.0.1"}

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1 @@
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 05:47:03 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["42"],"X-Ratelimit-Reset":["1463724861"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["6C2F0F69:1271A:B8980B7:573EA4D6"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 05:47:07 GMT"}],"recorded_with":"VCR 3.0.1"}

View File

@@ -0,0 +1 @@
{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Sat, 02 Jul 2016 14:13:57 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["59"],"X-Ratelimit-Reset":["1467472437"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["54DBAB83:300E:76DBC85:5777CC25"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Sat, 02 Jul 2016 14:13:58 GMT"}],"recorded_with":"VCR 3.0.1"}