Compare commits

...

225 Commits

Author SHA1 Message Date
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
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
28 changed files with 682 additions and 232 deletions

8
.gitignore vendored
View File

@@ -1 +1,9 @@
bin/
!bin/git-generate-changelog
!bin/github_changelog_generator
pkg/
coverage/
.bundle
spec/*.lock
doc
.yardoc

View File

@@ -1,12 +1,23 @@
sudo: false
cache:
- bundler
language: ruby
before_install:
- gem update --system
- gem install bundler
- gem update --system
- gem install bundler
rvm:
- 2.1.0
script:
- bundle exec rake checks
- 2.1
script: bundle exec rake checks
matrix:
include:
# Test install on clean system
- install: true
script:
- gem build github_changelog_generator
- gem install *.gem
- install: true
script:
- gem build github_changelog_generator
- bundle install --gemfile spec/install-gem-in-bundler.gemfile
notifications:
email:
recipients:

2
.yardopts Normal file
View File

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

View File

@@ -1,13 +1,159 @@
# Change Log
## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
## [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)
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...HEAD)
**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)
@@ -370,10 +516,6 @@
- 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)

View File

@@ -3,10 +3,13 @@ source "https://rubygems.org"
gemspec
group :test do
gem "rspec", "~>3.2"
gem "rubocop", "~>0.31"
gem "rake"
gem "bundler"
gem "rubocop"
gem "overcommit"
gem "coveralls", "~>0.8", require: false
gem "simplecov", "~>0.10", require: false
gem "codeclimate-test-reporter", "~>0.4"
gem "overcommit", "~>0.31"
# JSON 2.0.1 is ruby 2.0+
gem "json", "< 2.0"
end

View File

@@ -1,23 +1,24 @@
PATH
remote: .
specs:
github_changelog_generator (1.10.2)
colorize (~> 0.7)
github_api (~> 0.12)
github_changelog_generator (1.13.0)
colorize (>= 0.7)
github_api (>= 0.12)
rake (>= 10.0)
GEM
remote: https://rubygems.org/
specs:
addressable (2.4.0)
ast (2.2.0)
ast (2.3.0)
childprocess (0.5.9)
ffi (~> 1.0, >= 1.0.11)
codeclimate-test-reporter (0.4.8)
codeclimate-test-reporter (0.6.0)
simplecov (>= 0.7.1, < 1.0.0)
colorize (0.7.7)
coveralls (0.8.11)
json (~> 1.8)
simplecov (~> 0.11.0)
colorize (0.8.1)
coveralls (0.8.14)
json (>= 1.8, < 3)
simplecov (~> 0.12.0)
term-ansicolor (~> 1.3)
thor (~> 0.19.1)
tins (~> 1.6.0)
@@ -27,59 +28,58 @@ GEM
docile (1.1.5)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.10)
github_api (0.13.1)
ffi (1.9.14)
github_api (0.14.4)
addressable (~> 2.4.0)
descendants_tracker (~> 0.0.4)
faraday (~> 0.8, < 0.10)
hashie (>= 3.4)
multi_json (>= 1.7.5, < 2.0)
oauth2
hashie (3.4.3)
oauth2 (~> 1.0.0)
hashie (3.4.4)
iniparse (1.4.2)
json (1.8.3)
jwt (1.5.1)
multi_json (1.11.2)
jwt (1.5.4)
multi_json (1.12.1)
multi_xml (0.5.5)
multipart-post (2.0.0)
oauth2 (1.1.0)
oauth2 (1.0.0)
faraday (>= 0.8, < 0.10)
jwt (~> 1.0, < 1.5.2)
jwt (~> 1.0)
multi_json (~> 1.3)
multi_xml (~> 0.5)
rack (>= 1.2, < 3)
overcommit (0.32.0)
rack (~> 1.2)
overcommit (0.34.2)
childprocess (~> 0.5.8)
iniparse (~> 1.4)
parser (2.3.0.6)
parser (2.3.1.2)
ast (~> 2.2)
powerpack (0.1.1)
rack (1.6.4)
rainbow (2.1.0)
rake (10.5.0)
rspec (3.4.0)
rspec-core (~> 3.4.0)
rspec-expectations (~> 3.4.0)
rspec-mocks (~> 3.4.0)
rspec-core (3.4.3)
rspec-support (~> 3.4.0)
rspec-expectations (3.4.0)
rake (11.2.2)
rspec (3.5.0)
rspec-core (~> 3.5.0)
rspec-expectations (~> 3.5.0)
rspec-mocks (~> 3.5.0)
rspec-core (3.5.1)
rspec-support (~> 3.5.0)
rspec-expectations (3.5.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.4.0)
rspec-mocks (3.4.1)
rspec-support (~> 3.5.0)
rspec-mocks (3.5.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.4.0)
rspec-support (3.4.1)
rubocop (0.37.2)
parser (>= 2.3.0.4, < 3.0)
rspec-support (~> 3.5.0)
rspec-support (3.5.0)
rubocop (0.41.2)
parser (>= 2.3.1.1, < 3.0)
powerpack (~> 0.1)
rainbow (>= 1.99.1, < 3.0)
ruby-progressbar (~> 1.7)
unicode-display_width (~> 0.3)
ruby-progressbar (1.7.5)
simplecov (0.11.2)
unicode-display_width (~> 1.0, >= 1.0.1)
ruby-progressbar (1.8.1)
simplecov (0.12.0)
docile (~> 1.1.0)
json (~> 1.8)
json (>= 1.8, < 3)
simplecov-html (~> 0.10.0)
simplecov-html (0.10.0)
term-ansicolor (1.3.2)
@@ -87,21 +87,22 @@ GEM
thor (0.19.1)
thread_safe (0.3.5)
tins (1.6.0)
unicode-display_width (0.3.1)
unicode-display_width (1.1.0)
PLATFORMS
ruby
DEPENDENCIES
bundler (~> 1.7)
bundler
codeclimate-test-reporter (~> 0.4)
coveralls (~> 0.8)
github_changelog_generator!
overcommit (~> 0.31)
rake (~> 10.0)
rspec (~> 3.2)
rubocop (~> 0.31)
json (< 2.0)
overcommit
rake
rspec (>= 3.2)
rubocop
simplecov (~> 0.10)
BUNDLED WITH
1.11.2
1.12.5

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.

View File

@@ -77,6 +77,11 @@ Because software tools are for people. If you dont care, why are you contribu
- `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
@@ -101,7 +106,7 @@ Therefore, it's recommended to run this script with authentication by using a **
Here's how:
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
- [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
@@ -133,6 +138,8 @@ 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'

View File

@@ -9,15 +9,31 @@ require "overcommit"
RuboCop::RakeTask.new
RSpec::Core::RakeTask.new(:rspec)
task :create_man do |_t|
os_prefix = "/usr/local"
man_prefix = Pathname("#{os_prefix}/share/man/man1")
man_pages = "man/git-*"
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: [:checks, :create_man]
task default: [:copy_man_page_to_manpath]

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

View File

@@ -1,5 +1,4 @@
# coding: utf-8
lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "github_changelog_generator/version"
@@ -10,24 +9,26 @@ Gem::Specification.new do |spec|
spec.default_executable = "github_changelog_generator"
spec.required_ruby_version = ">= 1.9.3"
spec.authors = ["Petr Korolev"]
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.extensions = ["Rakefile"]
spec.files = `git ls-files -z`.split("\x0")
spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
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_runtime_dependency("github_api", ["~> 0.12"])
spec.add_runtime_dependency("colorize", ["~> 0.7"])
spec.add_runtime_dependency "rake", ">= 10.0"
spec.add_runtime_dependency "github_api", ">= 0.12"
spec.add_runtime_dependency "colorize", ">= 0.7"
# Development only
spec.add_development_dependency "bundler", "~> 1.7"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "overcommit", ">= 0.31"
spec.add_development_dependency "rspec", ">= 3.2"
spec.add_development_dependency "bundler", ">= 1.7"
spec.add_development_dependency "rubocop", ">= 0.31"
end

View File

@@ -71,7 +71,7 @@ module GitHubChangelogGenerator
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)
tags.concat(page) unless page.nil?
end
print_empty_line

View File

@@ -160,7 +160,7 @@ 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
@@ -168,17 +168,22 @@ module GitHubChangelogGenerator
encapsulated_title = encapsulate_string issue[:title]
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]
title_with_number += if issue.user.nil?
" ({Null user})"
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
" ([#{issue.user.login}](#{issue.user.html_url}))"
"#{line} ([#{user.login}](#{user.html_url}))"
end
end
end
title_with_number
end
end
end

View File

@@ -4,14 +4,13 @@ module GitHubChangelogGenerator
# @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?
return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
issues.reject do |issue|
labels = issue.labels.map(&:name)
(labels & @options[:exclude_labels]).any?
end
end
issues
end
# @return [Array] filtered issues accourding milestone
def filter_by_milestone(filtered_issues, tag_name, all_issues)

View File

@@ -54,13 +54,14 @@ module GitHubChangelogGenerator
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
def detect_since_tag
@since_tag ||= @options[:since_tag]
if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
reader = GitHubChangelogGenerator::Reader.new
content = reader.read(@options[:base])
@since_tag = content[0]["version"] if content.count && content
@since_tag ||= @options.fetch(:since_tag) { version_of_first_item }
end
@since_tag
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
@@ -129,26 +130,34 @@ module GitHubChangelogGenerator
end
# @param [Array] all_tags all tags
# @return [Array] filtered tags according :exclude_tags option
# @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
def filter_excluded_tags(all_tags)
return all_tags unless @options[:exclude_tags]
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)
filter_tags_with_regex(all_tags, @options[:exclude_tags])
else
filter_exact_tags(all_tags)
end
end
def filter_tags_with_regex(all_tags)
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| @options[:exclude_tags] =~ tag.name }
all_tags.reject { |tag| regex =~ tag.name }
end
def filter_exact_tags(all_tags)

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

@@ -14,7 +14,7 @@ module GitHubChangelogGenerator
parser = setup_parser(options)
parser.parse!
user_and_project_from_git(options)
fetch_user_and_project(options)
abort(parser.banner) unless options[:user] && options[:project]
@@ -23,7 +23,12 @@ module GitHubChangelogGenerator
options
end
# @param [Hash] options to display
# 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:"
@@ -56,7 +61,7 @@ module GitHubChangelogGenerator
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
options[:base] = last
end
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
options[:bug_prefix] = v
end
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
@@ -92,6 +97,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
@@ -122,6 +130,9 @@ module GitHubChangelogGenerator
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
@@ -164,7 +175,7 @@ module GitHubChangelogGenerator
parser
end
# just get default options
# @return [Hash] Default options
def self.default_options
{
tag1: nil,
@@ -196,37 +207,54 @@ module GitHubChangelogGenerator
}
end
def self.user_and_project_from_git(options)
# 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?
detect_user_and_project(options, ARGV[0], ARGV[1])
user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
options[:user] ||= user
options[:project] ||= project
end
end
# Detects user and project from git
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
return if options[:user] && options[:project]
# 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/
options[:user] = "skywinder"
options[:project] = "changelog_test"
user = "skywinder"
project = "changelog_test"
else
remote = `git config --get remote.#{options[:git_remote]}.url`
options[:user], options[:project] = user_project_from_remote(remote)
user, project = user_project_from_remote(remote)
end
end
# Try to find user and project name from git remote output
[user, project]
end
# Returns GitHub username and project from CLI arguments
#
# @param [String] output of git remote command
# @return [Array] user and project
# @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
@@ -245,35 +273,40 @@ module GitHubChangelogGenerator
[user, project]
end
# Try to find user and project name from git remote output
# These patterns match these formats:
#
# @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:
# ```
#
# and
#
# ```
# origin https://github.com/skywinder/ChangelogMerger (fetch)
# https://github.com/skywinder/ChangelogMerger
regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
remote_structures = [regex1, regex2]
# ```
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
#
# @return [Array] user and project
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]

View File

@@ -1,33 +1,61 @@
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
def initialize(options)
# @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.exist?(file)
File.readlines(file).each { |line| parse_line!(line) }
return unless @file
@file.each_with_index { |line, i| parse_line!(line, i + 1) }
@file.close
end
private
def file
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
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)
key_sym, value = extract_pair(line)
value = true if value =~ /^(true|t|yes|y|1)$/i
value = false if value =~ /^(false|f|no|n|0)$/i
@options[key_sym] = value
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, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
end
# Returns a the setting as a symbol and its string value sans newlines.
# 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>]
@@ -35,5 +63,41 @@ module GitHubChangelogGenerator
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

@@ -14,7 +14,7 @@ module GitHubChangelogGenerator
unreleased_only unreleased unreleased_label
compare_link include_labels exclude_labels
bug_labels enhancement_labels
between_tags exclude_tags since_tag max_issues
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 )
@@ -46,7 +46,7 @@ module GitHubChangelogGenerator
# mimick parse_options
options = Parser.default_options
Parser.user_and_project_from_git(options)
Parser.fetch_user_and_project(options)
OPTIONS.each do |o|
v = instance_variable_get("@#{o}")

View File

@@ -1,3 +1,3 @@
module GitHubChangelogGenerator
VERSION = "1.10.3"
VERSION = "1.13.1"
end

View File

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

View File

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

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

@@ -23,11 +23,11 @@ require "coveralls"
module SpecHelper
end
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
Coveralls::SimpleCov::Formatter,
SimpleCov::Formatter::HTMLFormatter,
CodeClimate::TestReporter::Formatter
]
])
SimpleCov.start
require "github_changelog_generator"

View File

@@ -0,0 +1,28 @@
module GitHubChangelogGenerator
describe Generator do
context "#exclude_issues_by_labels" do
let(:label) { double("the-bad-label", name: "BAD") }
let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
let(:good_label) { double("a-good-label", name: "GOOD") }
let(:good_issue) { double("an-issue-to-be-kept", 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,19 +1,14 @@
def tag_mash_with_name(tag)
mash_tag = Hashie::Mash.new
mash_tag.name = tag
mash_tag
end
def tags_mash_from_strings(tags_strings)
mash_array = []
tags_strings.each do |tag|
mash_tag = tag_mash_with_name(tag)
mash_array << mash_tag
end
mash_array
end
describe GitHubChangelogGenerator::Generator do
def tag_mash_with_name(tag)
Hashie::Mash.new.tap { |mash_tag| mash_tag.name = tag }
end
def tags_mash_from_strings(tags_strings)
tags_strings.map do |tag|
tag_mash_with_name(tag)
end
end
describe "#filter_between_tags" do
context "when between_tags nil" do
before do
@@ -76,31 +71,47 @@ describe GitHubChangelogGenerator::Generator do
describe "#filter_excluded_tags" do
subject { generator.filter_excluded_tags(tags_mash_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(tags_mash_from_strings(%w(1 2))) }
end
context "with invalid excluded tags" do
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_mash_from_strings(%w(1 2 3))) }
end
context "with regex exclude_tags" do
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_mash_from_strings(%w(1))) }
end
context "with non-matching regex in exclude_tags" do
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_mash_from_strings(%w(1 2 3))) }
end
end
describe "#filter_excluded_tags_regex" do
subject { generator.filter_excluded_tags(tags_mash_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_mash_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_mash_from_strings(%w(1 2 3))) }
end
end
describe "#filter_since_tag" do
context "with filled array" do
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
@@ -190,7 +201,7 @@ describe GitHubChangelogGenerator::Generator do
@generator.instance_variable_set :@fetcher, mock
end
subject do
of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
of_tag = @generator.get_time_of_tag(tag_mash_with_name("valid_tag"))
of_tag
end
it { is_expected.to be_a_kind_of(Time) }
@@ -199,31 +210,32 @@ describe GitHubChangelogGenerator::Generator do
end
describe "#sort_tags_by_date" do
time1 = Time.now
time2 = Time.now
time3 = Time.now
let(:time1) { Time.now }
let(:time2) { Time.now }
let(:time3) { Time.now }
before(:all) do
@generator = GitHubChangelogGenerator::Generator.new
end
context "sort unsorted tags" do
tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
before do
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
@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
@generator.sort_tags_by_date(tags)
end
context "sort unsorted tags" do
let(:tags) { tags_mash_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
tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
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
let(:tags) { tags_mash_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

View File

@@ -1,41 +1,73 @@
describe GitHubChangelogGenerator::ParserFile do
describe ".github_changelog_generator" do
context "when no has file" do
let(:options) { {} }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
subject { parse.parse! }
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(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
it "does not change the options" do
expect { parse.parse! }.to_not change { options }
expect { parser.parse! }.to_not change { options }
end
end
context "when file is incorrect" do
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
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) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
let(:options) { {}.merge(default_options) }
let(:options_before_change) { options.dup }
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
it "changes the options" do
expect { parse.parse! }.to change { options }
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

@@ -56,5 +56,25 @@ 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 :each do
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