Compare commits
201 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e864abd623 | ||
|
|
6710078766 | ||
|
|
f0736e67a5 | ||
|
|
784bd50a8f | ||
|
|
a9eabfc38b | ||
|
|
8123b3e2fa | ||
|
|
2b148f2e69 | ||
|
|
6a7dbeb450 | ||
|
|
8aa5d524b7 | ||
|
|
0a35113a88 | ||
|
|
79a84a14f4 | ||
|
|
6d8dbd16ad | ||
|
|
cf8df992c5 | ||
|
|
b620ad0d1b | ||
|
|
b7980c8900 | ||
|
|
e27fe24a76 | ||
|
|
088c98d0bf | ||
|
|
9ab84ac181 | ||
|
|
f04d581dbc | ||
|
|
911b91c0ab | ||
|
|
26e202d7f0 | ||
|
|
c2e5118cc9 | ||
|
|
b598bd5ba1 | ||
|
|
1673677df0 | ||
|
|
c44be45ce4 | ||
|
|
177b7aa18f | ||
|
|
e495b58682 | ||
|
|
e82a75611c | ||
|
|
38576e23e3 | ||
|
|
79d228c7a0 | ||
|
|
e1161f9d90 | ||
|
|
31c5ac4c55 | ||
|
|
dae68ee3b5 | ||
|
|
2b656c83b6 | ||
|
|
4e9ed5df28 | ||
|
|
47bba9d384 | ||
|
|
ce7f35777b | ||
|
|
115762af82 | ||
|
|
a50ad5b5c9 | ||
|
|
da60c73502 | ||
|
|
b5d073c0af | ||
|
|
6fcd0c95ed | ||
|
|
5c66591d71 | ||
|
|
77941049e6 | ||
|
|
ca334b430c | ||
|
|
1498790a78 | ||
|
|
55001f48c2 | ||
|
|
643b266679 | ||
|
|
2590883c3a | ||
|
|
4b0642cc6d | ||
|
|
f9a58ae079 | ||
|
|
731e9904f5 | ||
|
|
fff7402621 | ||
|
|
51755cbe34 | ||
|
|
d361baaec5 | ||
|
|
ae0d1d16de | ||
|
|
c8584a1749 | ||
|
|
7c29f3ddd2 | ||
|
|
a2cf6810ad | ||
|
|
629a08b890 | ||
|
|
e0cf47e027 | ||
|
|
4f9bb03265 | ||
|
|
46d6b72d45 | ||
|
|
8b5ea42e0d | ||
|
|
2456db0847 | ||
|
|
9010c93dea | ||
|
|
42c1152c8b | ||
|
|
6f1fa05c86 | ||
|
|
19ee2c3968 | ||
|
|
c51d3ef4d0 | ||
|
|
397126c645 | ||
|
|
b2e3f6a2c5 | ||
|
|
eeb92f6ae6 | ||
|
|
c564c9018b | ||
|
|
e7aa1a2042 | ||
|
|
765d995b6d | ||
|
|
420db358bc | ||
|
|
f7c7992a1d | ||
|
|
591927ef6c | ||
|
|
570c1c11e8 | ||
|
|
8de0b330d0 | ||
|
|
48c2f26645 | ||
|
|
c5a01bb24f | ||
|
|
6350cdf39c | ||
|
|
d425ae1a9a | ||
|
|
fb50acca57 | ||
|
|
3bd3dae016 | ||
|
|
fd2beef12a | ||
|
|
c088349bc3 | ||
|
|
1494fcdd8f | ||
|
|
8fa85475eb | ||
|
|
8462f017b7 | ||
|
|
57ef59d76c | ||
|
|
808155ee3a | ||
|
|
d80a6803be | ||
|
|
93291dde7c | ||
|
|
c67909959b | ||
|
|
2c8ba4965b | ||
|
|
eb497471b9 | ||
|
|
9d43384198 | ||
|
|
2e5aec751f | ||
|
|
92735a2fc8 | ||
|
|
8af5c4c6b0 | ||
|
|
0f7fd939bf | ||
|
|
cc6ac05254 | ||
|
|
fb601cf552 | ||
|
|
990b32cf71 | ||
|
|
c5df1c22bb | ||
|
|
6ef182a1fc | ||
|
|
34cd8f75f7 | ||
|
|
9e69a1c853 | ||
|
|
cca8e5d810 | ||
|
|
a09b6affd4 | ||
|
|
3ca25bfff0 | ||
|
|
f48236e47b | ||
|
|
a9baa37c64 | ||
|
|
2576706e9f | ||
|
|
5a2f10a47d | ||
|
|
692a4f156b | ||
|
|
5fd3f51d78 | ||
|
|
2cf62707d7 | ||
|
|
ea89cec43a | ||
|
|
0a3ecbb81b | ||
|
|
61a6e19417 | ||
|
|
6af43b63e1 | ||
|
|
9f06a20741 | ||
|
|
1eee5bffd8 | ||
|
|
0d0a37b653 | ||
|
|
5f6756e8dd | ||
|
|
a1c7ffb765 | ||
|
|
1456ba8913 | ||
|
|
90f6436af6 | ||
|
|
8841583c02 | ||
|
|
d6cbfe3c38 | ||
|
|
5978f35cce | ||
|
|
856ad3a742 | ||
|
|
d43ef05287 | ||
|
|
643f2f9eab | ||
|
|
c428666106 | ||
|
|
6370ee2997 | ||
|
|
9f57a505cc | ||
|
|
5566f6f7f9 | ||
|
|
6406168b15 | ||
|
|
77939c095c | ||
|
|
7b38f0f56a | ||
|
|
7704dc9ecd | ||
|
|
25ee41bc8c | ||
|
|
219f4b9748 | ||
|
|
de33edd3ce | ||
|
|
6db717a5ee | ||
|
|
5fb5832cf5 | ||
|
|
a55b938ccf | ||
|
|
d1b3e09da3 | ||
|
|
4d094ba211 | ||
|
|
3d7aa0b7c5 | ||
|
|
ada6f13de5 | ||
|
|
9479979fed | ||
|
|
30e9ab0ec3 | ||
|
|
8d5bdbcca7 | ||
|
|
a514224625 | ||
|
|
4162bc8659 | ||
|
|
729938b85d | ||
|
|
06d49a1e44 | ||
|
|
30f429f632 | ||
|
|
dbb385d049 | ||
|
|
abe19eedbe | ||
|
|
32149b8a2c | ||
|
|
e5f6670a07 | ||
|
|
83e406ca5f | ||
|
|
8c7f1a7390 | ||
|
|
f248e1c718 | ||
|
|
fdcf5ccf7e | ||
|
|
2b46ba2a11 | ||
|
|
f6388903b7 | ||
|
|
e51bceda05 | ||
|
|
165e8d4e9f | ||
|
|
79f16947b7 | ||
|
|
432f12af70 | ||
|
|
a1b19044c2 | ||
|
|
70e8c287f5 | ||
|
|
78ca34ff7c | ||
|
|
2f3e754a6b | ||
|
|
8c20913af4 | ||
|
|
f14b081126 | ||
|
|
315a92b7b3 | ||
|
|
cca51aa19f | ||
|
|
56b1398081 | ||
|
|
1232f339a0 | ||
|
|
3cc6418048 | ||
|
|
a4f93feb7d | ||
|
|
b0be9f8b06 | ||
|
|
aeaec739f5 | ||
|
|
bf27187dd3 | ||
|
|
0e0295645d | ||
|
|
b2fac89ec1 | ||
|
|
947163426b | ||
|
|
2900025f6f | ||
|
|
802fb44d38 | ||
|
|
8b299a0394 | ||
|
|
111931a958 | ||
|
|
5a47a075e2 |
1
.coveralls.yml
Normal file
1
.coveralls.yml
Normal file
@@ -0,0 +1 @@
|
|||||||
|
service_name: travis-ci
|
||||||
2
.hound.yml
Normal file
2
.hound.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
ruby:
|
||||||
|
config_file: .rubocop.yml
|
||||||
8
.rubocop.yml
Normal file
8
.rubocop.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
inherit_from: .rubocop_todo.yml
|
||||||
|
|
||||||
|
Metrics/LineLength:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
||||||
|
Style/StringLiterals:
|
||||||
|
EnforcedStyle: double_quotes
|
||||||
81
.rubocop_todo.yml
Normal file
81
.rubocop_todo.yml
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
# This configuration was generated by `rubocop --auto-gen-config`
|
||||||
|
# on 2015-04-04 02:29:34 +0300 using RuboCop version 0.29.1.
|
||||||
|
# The point is for the user to remove these configuration records
|
||||||
|
# one by one as the offenses are removed from the code base.
|
||||||
|
# Note that changes in the inspected code, or installation of new
|
||||||
|
# versions of RuboCop, may require this file to be generated again.
|
||||||
|
|
||||||
|
# Offense count: 21
|
||||||
|
Metrics/AbcSize:
|
||||||
|
Max: 71
|
||||||
|
|
||||||
|
# Offense count: 2
|
||||||
|
Metrics/BlockNesting:
|
||||||
|
Max: 4
|
||||||
|
|
||||||
|
# Offense count: 2
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/ClassLength:
|
||||||
|
Max: 457
|
||||||
|
|
||||||
|
# Offense count: 6
|
||||||
|
Metrics/CyclomaticComplexity:
|
||||||
|
Max: 15
|
||||||
|
|
||||||
|
# Offense count: 28
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/MethodLength:
|
||||||
|
Max: 118
|
||||||
|
|
||||||
|
# Offense count: 5
|
||||||
|
Metrics/PerceivedComplexity:
|
||||||
|
Max: 18
|
||||||
|
|
||||||
|
# Offense count: 3
|
||||||
|
Style/AccessorMethodName:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 1
|
||||||
|
# Cop supports --auto-correct.
|
||||||
|
# Configuration parameters: EnforcedStyle, SupportedStyles.
|
||||||
|
Style/AndOr:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 27
|
||||||
|
# Cop supports --auto-correct.
|
||||||
|
Style/Blocks:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 7
|
||||||
|
# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
|
||||||
|
Style/CaseIndentation:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 4
|
||||||
|
Style/Documentation:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 1
|
||||||
|
# Configuration parameters: AllowedVariables.
|
||||||
|
Style/GlobalVars:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 6
|
||||||
|
# Configuration parameters: MinBodyLength.
|
||||||
|
Style/GuardClause:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 17
|
||||||
|
# Configuration parameters: MaxLineLength.
|
||||||
|
Style/IfUnlessModifier:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 2
|
||||||
|
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||||
|
Style/Next:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Offense count: 5
|
||||||
|
# Configuration parameters: MaxSlashes.
|
||||||
|
Style/RegexpLiteral:
|
||||||
|
Enabled: false
|
||||||
20
.travis.yml
20
.travis.yml
@@ -1,15 +1,17 @@
|
|||||||
|
sudo: false
|
||||||
|
cache: bundler
|
||||||
language: ruby
|
language: ruby
|
||||||
before_install:
|
|
||||||
- gem update --system
|
|
||||||
- gem --version
|
|
||||||
rvm:
|
rvm:
|
||||||
- 2.1.0
|
- 2.1.0
|
||||||
gemfile:
|
script:
|
||||||
- Gemfile
|
- bundle exec rake
|
||||||
|
|
||||||
notifications:
|
notifications:
|
||||||
email:
|
email:
|
||||||
recipients:
|
recipients:
|
||||||
- sky4winder+githubchangeloggenerator@gmail.com
|
- sky4winder+githubchangeloggenerator@gmail.com
|
||||||
on_success: never # [always|never|change]
|
on_success: never
|
||||||
on_failure: change # [always|never|change]
|
on_failure: change
|
||||||
|
addons:
|
||||||
|
code_climate:
|
||||||
|
repo_token:
|
||||||
|
secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=
|
||||||
|
|||||||
432
CHANGELOG.md
432
CHANGELOG.md
@@ -1,280 +1,336 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
## [1.3.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.8) (2015-03-05)
|
## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...HEAD)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
|
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
||||||
|
|
||||||
## [1.3.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.6) (2015-03-05)
|
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.5...1.3.6)
|
|
||||||
|
|
||||||
## [1.3.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.5) (2015-03-04)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.4...1.3.5)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/Github-Changelog-Generator/issues/60)
|
|
||||||
|
|
||||||
## [1.3.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.4) (2015-03-03)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/Github-Changelog-Generator/issues/59)
|
|
||||||
|
|
||||||
## [1.3.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.3) (2015-03-03)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
|
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
|
|
||||||
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/Github-Changelog-Generator/issues/58)
|
- Add CodeClimate and Inch CI [\#219](https://github.com/skywinder/github-changelog-generator/issues/219)
|
||||||
|
|
||||||
## [1.3.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.2) (2015-03-03)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/Github-Changelog-Generator/issues/57)
|
|
||||||
|
|
||||||
## [1.3.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.1) (2015-02-27)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.0...1.3.1)
|
|
||||||
|
|
||||||
## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
|
|
||||||
|
|
||||||
- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
|
|
||||||
|
|
||||||
- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
|
|
||||||
|
|
||||||
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
|
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||||
|
|
||||||
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
|
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
|
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||||
|
|
||||||
|
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
||||||
|
|
||||||
|
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
|
||||||
|
|
||||||
|
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/github-changelog-generator/pull/61) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
|
||||||
|
|
||||||
|
## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
|
||||||
|
|
||||||
|
## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
|
||||||
|
|
||||||
|
## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
|
||||||
|
|
||||||
**Closed issues:**
|
**Closed issues:**
|
||||||
|
|
||||||
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
|
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
|
||||||
|
|
||||||
**Merged pull requests:**
|
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
|
||||||
|
|
||||||
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
|
||||||
|
|
||||||
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
|
**Fixed bugs:**
|
||||||
|
|
||||||
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
|
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
|
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
|
||||||
|
|
||||||
**Merged pull requests:**
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
|
||||||
|
|
||||||
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
|
## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
|
||||||
|
|
||||||
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
|
||||||
|
|
||||||
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
|
||||||
|
|
||||||
|
- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
|
||||||
|
|
||||||
|
- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
|
||||||
|
|
||||||
|
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
- Pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/github-changelog-generator/issues/44)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
|
||||||
|
|
||||||
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
|
**Closed issues:**
|
||||||
|
|
||||||
**Fixed bugs:**
|
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/github-changelog-generator/issues/37)
|
||||||
|
|
||||||
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
|
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
|
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
|
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
||||||
|
|
||||||
|
## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||||
|
|
||||||
|
## [1.2.5](https://github.com/skywinder/github-changelog-generator/tree/1.2.5) (2015-01-15)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
|
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
|
||||||
|
|
||||||
- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
|
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
|
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
|
|
||||||
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
|
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
|
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
|
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
|
||||||
|
|
||||||
**Merged pull requests:**
|
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
|
||||||
|
|
||||||
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
|
||||||
|
|
||||||
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
|
||||||
|
|
||||||
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
**Implemented enhancements:**
|
||||||
|
|
||||||
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
|
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
|
||||||
|
|
||||||
**Merged pull requests:**
|
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
|
||||||
|
|
||||||
- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
|
|
||||||
|
|
||||||
**Merged pull requests:**
|
|
||||||
|
|
||||||
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
|
|
||||||
|
|
||||||
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
|
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
|
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/github-changelog-generator/issues/30)
|
||||||
|
|
||||||
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
|
**Merged pull requests:**
|
||||||
|
|
||||||
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
|
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
|
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
|
## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
|
||||||
|
|
||||||
**Implemented enhancements:**
|
|
||||||
|
|
||||||
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
|
|
||||||
|
|
||||||
- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
|
||||||
|
|
||||||
**Fixed bugs:**
|
**Fixed bugs:**
|
||||||
|
|
||||||
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
|
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||||
|
|
||||||
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
|
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
|
||||||
|
|
||||||
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/github-changelog-generator/issues/20)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
|
- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
|
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
|
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
|
||||||
|
|
||||||
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
|
**Merged pull requests:**
|
||||||
|
|
||||||
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
|
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/github-changelog-generator/pull/27) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/github-changelog-generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/github-changelog-generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/github-changelog-generator/issues/19)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/github-changelog-generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/github-changelog-generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Detect username and project form origin [\#11](https://github.com/skywinder/github-changelog-generator/issues/11)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
|
||||||
|
|
||||||
|
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
|
||||||
|
|
||||||
|
## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
|
||||||
|
|
||||||
|
## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
||||||
|
|
||||||
|
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/github-changelog-generator/issues/5)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/github-changelog-generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
|
||||||
|
|
||||||
|
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
18
Gemfile
18
Gemfile
@@ -1,4 +1,14 @@
|
|||||||
source 'https://rubygems.org'
|
source "https://rubygems.org"
|
||||||
gem 'github_api'
|
|
||||||
gem 'colorize'
|
gem "rake"
|
||||||
gem 'rake'
|
|
||||||
|
gem "github_api"
|
||||||
|
gem "colorize"
|
||||||
|
|
||||||
|
group :test do
|
||||||
|
gem "rspec"
|
||||||
|
gem "rubocop"
|
||||||
|
gem "coveralls", require: false
|
||||||
|
gem "simplecov", require: false
|
||||||
|
gem "codeclimate-test-reporter"
|
||||||
|
end
|
||||||
|
|||||||
86
Gemfile.lock
86
Gemfile.lock
@@ -1,13 +1,28 @@
|
|||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.6)
|
addressable (2.3.7)
|
||||||
colorize (0.7.4)
|
ast (2.0.0)
|
||||||
|
astrolabe (1.3.0)
|
||||||
|
parser (>= 2.2.0.pre.3, < 3.0)
|
||||||
|
codeclimate-test-reporter (0.4.7)
|
||||||
|
simplecov (>= 0.7.1, < 1.0.0)
|
||||||
|
colorize (0.7.5)
|
||||||
|
coveralls (0.7.12)
|
||||||
|
multi_json (~> 1.10)
|
||||||
|
rest-client (>= 1.6.8, < 2)
|
||||||
|
simplecov (~> 0.9.1)
|
||||||
|
term-ansicolor (~> 1.3)
|
||||||
|
thor (~> 0.19.1)
|
||||||
descendants_tracker (0.0.4)
|
descendants_tracker (0.0.4)
|
||||||
thread_safe (~> 0.3, >= 0.3.1)
|
thread_safe (~> 0.3, >= 0.3.1)
|
||||||
faraday (0.9.0)
|
diff-lcs (1.2.5)
|
||||||
|
docile (1.1.5)
|
||||||
|
domain_name (0.5.23)
|
||||||
|
unf (>= 0.0.5, < 1.0.0)
|
||||||
|
faraday (0.9.1)
|
||||||
multipart-post (>= 1.2, < 3)
|
multipart-post (>= 1.2, < 3)
|
||||||
github_api (0.12.2)
|
github_api (0.12.3)
|
||||||
addressable (~> 2.3)
|
addressable (~> 2.3)
|
||||||
descendants_tracker (~> 0.0.4)
|
descendants_tracker (~> 0.0.4)
|
||||||
faraday (~> 0.8, < 0.10)
|
faraday (~> 0.8, < 0.10)
|
||||||
@@ -15,13 +30,17 @@ GEM
|
|||||||
multi_json (>= 1.7.5, < 2.0)
|
multi_json (>= 1.7.5, < 2.0)
|
||||||
nokogiri (~> 1.6.3)
|
nokogiri (~> 1.6.3)
|
||||||
oauth2
|
oauth2
|
||||||
hashie (3.3.2)
|
hashie (3.4.0)
|
||||||
jwt (1.2.0)
|
http-cookie (1.0.2)
|
||||||
mini_portile (0.6.1)
|
domain_name (~> 0.5)
|
||||||
multi_json (1.10.1)
|
jwt (1.4.1)
|
||||||
|
mime-types (2.4.3)
|
||||||
|
mini_portile (0.6.2)
|
||||||
|
multi_json (1.11.0)
|
||||||
multi_xml (0.5.5)
|
multi_xml (0.5.5)
|
||||||
multipart-post (2.0.0)
|
multipart-post (2.0.0)
|
||||||
nokogiri (1.6.5)
|
netrc (0.10.3)
|
||||||
|
nokogiri (1.6.6.2)
|
||||||
mini_portile (~> 0.6.0)
|
mini_portile (~> 0.6.0)
|
||||||
oauth2 (1.0.0)
|
oauth2 (1.0.0)
|
||||||
faraday (>= 0.8, < 0.10)
|
faraday (>= 0.8, < 0.10)
|
||||||
@@ -29,14 +48,59 @@ GEM
|
|||||||
multi_json (~> 1.3)
|
multi_json (~> 1.3)
|
||||||
multi_xml (~> 0.5)
|
multi_xml (~> 0.5)
|
||||||
rack (~> 1.2)
|
rack (~> 1.2)
|
||||||
rack (1.5.2)
|
parser (2.2.0.3)
|
||||||
|
ast (>= 1.1, < 3.0)
|
||||||
|
powerpack (0.1.0)
|
||||||
|
rack (1.6.0)
|
||||||
|
rainbow (2.0.0)
|
||||||
rake (10.4.2)
|
rake (10.4.2)
|
||||||
thread_safe (0.3.4)
|
rest-client (1.8.0)
|
||||||
|
http-cookie (>= 1.0.2, < 2.0)
|
||||||
|
mime-types (>= 1.16, < 3.0)
|
||||||
|
netrc (~> 0.7)
|
||||||
|
rspec (3.2.0)
|
||||||
|
rspec-core (~> 3.2.0)
|
||||||
|
rspec-expectations (~> 3.2.0)
|
||||||
|
rspec-mocks (~> 3.2.0)
|
||||||
|
rspec-core (3.2.2)
|
||||||
|
rspec-support (~> 3.2.0)
|
||||||
|
rspec-expectations (3.2.0)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.2.0)
|
||||||
|
rspec-mocks (3.2.1)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.2.0)
|
||||||
|
rspec-support (3.2.2)
|
||||||
|
rubocop (0.29.1)
|
||||||
|
astrolabe (~> 1.3)
|
||||||
|
parser (>= 2.2.0.1, < 3.0)
|
||||||
|
powerpack (~> 0.1)
|
||||||
|
rainbow (>= 1.99.1, < 3.0)
|
||||||
|
ruby-progressbar (~> 1.4)
|
||||||
|
ruby-progressbar (1.7.5)
|
||||||
|
simplecov (0.9.2)
|
||||||
|
docile (~> 1.1.0)
|
||||||
|
multi_json (~> 1.0)
|
||||||
|
simplecov-html (~> 0.9.0)
|
||||||
|
simplecov-html (0.9.0)
|
||||||
|
term-ansicolor (1.3.0)
|
||||||
|
tins (~> 1.0)
|
||||||
|
thor (0.19.1)
|
||||||
|
thread_safe (0.3.5)
|
||||||
|
tins (1.3.5)
|
||||||
|
unf (0.1.4)
|
||||||
|
unf_ext
|
||||||
|
unf_ext (0.0.6)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
|
codeclimate-test-reporter
|
||||||
colorize
|
colorize
|
||||||
|
coveralls
|
||||||
github_api
|
github_api
|
||||||
rake
|
rake
|
||||||
|
rspec
|
||||||
|
rubocop
|
||||||
|
simplecov
|
||||||
|
|||||||
114
README.md
114
README.md
@@ -1,8 +1,11 @@
|
|||||||
|
|
||||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||||
[](https://travis-ci.org/skywinder/Github-Changelog-Generator)
|
[](https://gemnasium.com/skywinder/github-changelog-generator)
|
||||||
|
[](https://travis-ci.org/skywinder/github-changelog-generator)
|
||||||
|
[](http://inch-ci.org/github/skywinder/github-changelog-generator)
|
||||||
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
|
[](https://codeclimate.com/github/skywinder/github-changelog-generator)
|
||||||
|
|
||||||
GitHub Changelog Generator
|
GitHub Changelog Generator 
|
||||||
==================
|
==================
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
@@ -13,14 +16,23 @@ GitHub Changelog Generator
|
|||||||
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
||||||
- [Alternatives](#alternatives)
|
- [Alternatives](#alternatives)
|
||||||
- [Projects using this library](#projects-using-this-library)
|
- [Projects using this library](#projects-using-this-library)
|
||||||
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature)
|
- [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
|
|
||||||
Changelog generation has never been so easy.
|
### Changelog generation has never been so easy:
|
||||||
|
|
||||||
**Fully automate changelog generation** - This gem generate change log file based on tags, issues and merged pull requests from **Github issue tracker**. This generator complies all [change log format guidelines](http://keepachangelog.com/).
|
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
||||||
|
|
||||||
|
Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
|
||||||
|
|
||||||
|
>### *What’s 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 don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
||||||
|
|
||||||
|
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -57,13 +69,13 @@ Changelog generation has never been so easy.
|
|||||||
## Usage
|
## Usage
|
||||||
**It's really simple**:
|
**It's really simple**:
|
||||||
|
|
||||||
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
|
- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
|
||||||
|
|
||||||
github_changelog_generator
|
github_changelog_generator
|
||||||
|
|
||||||
- or from anywhere:
|
- or from anywhere:
|
||||||
|
- `github_changelog_generator -u github_username -p github_project`
|
||||||
github_changelog_generator -u github_username -p github_project
|
- `github_changelog_generator github_username/github_project`
|
||||||
|
|
||||||
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||||
|
|
||||||
@@ -88,6 +100,7 @@ Type `github_changelog_generator --help` for detailed usage.
|
|||||||
--[no-]compare-link Include compare link between older version and newer version. Default is true
|
--[no-]compare-link Include compare link between older version and newer version. Default is true
|
||||||
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
|
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
|
||||||
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
||||||
|
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited.
|
||||||
--github-site [URL] The Enterprise Github site on which your project is hosted.
|
--github-site [URL] The Enterprise Github site on which your project is hosted.
|
||||||
--github-api [URL] The enterprise endpoint to use for your Github API.
|
--github-api [URL] The enterprise endpoint to use for your Github API.
|
||||||
-v, --version Print version number
|
-v, --version Print version number
|
||||||
@@ -96,9 +109,9 @@ Type `github_changelog_generator --help` for detailed usage.
|
|||||||
|
|
||||||
### GitHub token
|
### GitHub token
|
||||||
|
|
||||||
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
|
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||||
|
|
||||||
**You can easily [generate it here](https://github.com/settings/applications)**.
|
**You can easily [generate it here](https://github.com/settings/tokens)**.
|
||||||
|
|
||||||
And:
|
And:
|
||||||
|
|
||||||
@@ -115,23 +128,27 @@ So, if you got error like this:
|
|||||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||||
|
|
||||||
##Features and advantages of this project
|
##Features and advantages of this project
|
||||||
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
|
- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
|
||||||
- Simply add links for all closed issues and merged pull requests
|
- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
||||||
- Possible to generate **Unreleased** changes (closed issues that have not released yet)
|
- **GitHub Enterprise support** via command line options! :factory:
|
||||||
- Flexible format customisation:
|
- Flexible format **customisation**:
|
||||||
- Customize issues, that should be added to changelog
|
- **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
|
||||||
- Custom date format supported
|
- **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
|
||||||
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
|
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version :pushpin:
|
||||||
- Ability to exclude specific issues from change log (by labels)
|
- Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default) :scissors:
|
||||||
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels)
|
- **Distinguish** issues **according labels**. :mag_right:
|
||||||
- Distinguish bug fixes, enchantments, and closed issues according labels.
|
- Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
|
||||||
- **Issues** (closed issues w/o any labels)
|
- Bug fixes (by label `bug` in issue) :beetle:
|
||||||
- **Merged pull-requests** (all merged pull-requests)
|
- Enhancements (by label `enhancement` in issue) :star2:
|
||||||
- **Bug-fixes** (by label `bug` in issue)
|
- Issues (closed issues `w/o any labels`) :non-potable_water:
|
||||||
- **Enhancements** (by label `enhancement` in issue)
|
|
||||||
|
- You can manually set which labels should be included/excluded. :wrench:
|
||||||
|
- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
|
||||||
|
(*look `github_changelog_generator --help` for details)*
|
||||||
|
|
||||||
|
|
||||||
###Alternatives
|
###Alternatives
|
||||||
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements.
|
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
|
||||||
|
|
||||||
*If you know other projects - feel free to edit this Wiki page!*
|
*If you know other projects - feel free to edit this Wiki page!*
|
||||||
|
|
||||||
@@ -139,15 +156,51 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
|
|||||||
### Projects using this library
|
### Projects using this library
|
||||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||||
|
|
||||||
|
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
||||||
|
|
||||||
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||||
|
|
||||||
## Am I missed some essential feature?
|
## Am I missing some essential feature?
|
||||||
|
|
||||||
**Nothing is impossible!**
|
- **Nothing is impossible!**
|
||||||
|
|
||||||
Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
- ***I already use GitHub Releases. Why do I need this?***
|
||||||
|
|
||||||
|
GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
|
||||||
|
|
||||||
|
*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
||||||
|
|
||||||
|
I'm not try to compare quality of auto-generated and manually generated logs.. but:
|
||||||
|
|
||||||
|
The auto generated Changelog really helps even if you manually fill Releases notes!
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
|
||||||
|
|
||||||
|
- it's not so quite easy to find it in manually filled Releases notes.
|
||||||
|
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
||||||
|
|
||||||
|
In the end:
|
||||||
|
|
||||||
|
I think, that GitHub Releases is more for end-users.
|
||||||
|
But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
|
||||||
|
And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
|
||||||
|
|
||||||
|
- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
|
||||||
|
|
||||||
|
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
|
||||||
|
|
||||||
|
If you're seeing this warning:
|
||||||
|
|
||||||
|
1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
|
||||||
|
2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
@@ -157,6 +210,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n
|
|||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
5. Push to the branch (`git push origin my-new-feature`)
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
6. Create a new Pull Request
|
6. Create a new Pull Request
|
||||||
|
7. Profit! :white_check_mark:
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
12
Rakefile
12
Rakefile
@@ -1,9 +1,7 @@
|
|||||||
require "rake/testtask"
|
require "rubocop/rake_task"
|
||||||
|
require "rspec/core/rake_task"
|
||||||
|
|
||||||
task :default => [:test]
|
RuboCop::RakeTask.new
|
||||||
|
RSpec::Core::RakeTask.new(:rspec)
|
||||||
|
|
||||||
Rake::TestTask.new do |t|
|
task default: [:rubocop, :rspec]
|
||||||
t.verbose = true
|
|
||||||
t.libs.push("demo", "test")
|
|
||||||
t.pattern = "test/**/*_test.rb"
|
|
||||||
end
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
#! /usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
|
|
||||||
require 'github_changelog_generator'
|
require_relative "../lib/github_changelog_generator"
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
|
||||||
|
|||||||
@@ -1,30 +1,30 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
require 'optparse'
|
require "optparse"
|
||||||
|
|
||||||
SPEC_TYPE = 'gemspec'
|
SPEC_TYPE = "gemspec"
|
||||||
|
|
||||||
:major
|
:major
|
||||||
:minor
|
:minor
|
||||||
:patch
|
:patch
|
||||||
|
|
||||||
@options = {:dry_run => false, :bump_number => :patch}
|
@options = { dry_run: false, bump_number: :patch }
|
||||||
|
|
||||||
OptionParser.new { |opts|
|
OptionParser.new { |opts|
|
||||||
opts.banner = 'Usage: bump.rb [options]'
|
opts.banner = "Usage: bump.rb [options]"
|
||||||
|
|
||||||
opts.on('-d', '--dry-run', 'Dry run') do |v|
|
opts.on("-d", "--dry-run", "Dry run") do |v|
|
||||||
@options[:dry_run] = v
|
@options[:dry_run] = v
|
||||||
end
|
end
|
||||||
opts.on('-a', '--major', 'Bump major version') do |v|
|
opts.on("-a", "--major", "Bump major version") do |_v|
|
||||||
@options[:bump_number] = :major
|
@options[:bump_number] = :major
|
||||||
end
|
end
|
||||||
opts.on('-m', '--minor', 'Bump minor version') do |v|
|
opts.on("-m", "--minor", "Bump minor version") do |_v|
|
||||||
@options[:bump_number] = :minor
|
@options[:bump_number] = :minor
|
||||||
end
|
end
|
||||||
opts.on('-p', '--patch', 'Bump patch version') do |v|
|
opts.on("-p", "--patch", "Bump patch version") do |_v|
|
||||||
@options[:bump_number] = :patch
|
@options[:bump_number] = :patch
|
||||||
end
|
end
|
||||||
opts.on('-r', '--revert', 'Revert last bump') do |v|
|
opts.on("-r", "--revert", "Revert last bump") do |v|
|
||||||
@options[:revert] = v
|
@options[:revert] = v
|
||||||
end
|
end
|
||||||
}.parse!
|
}.parse!
|
||||||
@@ -32,26 +32,25 @@ OptionParser.new { |opts|
|
|||||||
p @options
|
p @options
|
||||||
|
|
||||||
def check_repo_is_clean_or_dry_run
|
def check_repo_is_clean_or_dry_run
|
||||||
value =%x[#{'git status --porcelain'}]
|
value = `#{"git status --porcelain"}`
|
||||||
|
|
||||||
if value.empty?
|
if value.empty?
|
||||||
puts 'Repo is clean -> continue'
|
puts "Repo is clean -> continue"
|
||||||
else
|
else
|
||||||
if @options[:dry_run]
|
if @options[:dry_run]
|
||||||
puts 'Repo not clean, "Dry run" enabled -> continue'
|
puts 'Repo not clean, "Dry run" enabled -> continue'
|
||||||
else
|
else
|
||||||
puts 'Repository not clean -> exit'
|
puts "Repository not clean -> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def find_spec_file
|
def find_spec_file
|
||||||
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
|
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
|
||||||
arr = list_of_specs.split("\n")
|
arr = list_of_specs.split("\n")
|
||||||
|
|
||||||
spec_file = ''
|
spec_file = ""
|
||||||
|
|
||||||
case arr.count
|
case arr.count
|
||||||
when 0
|
when 0
|
||||||
@@ -60,26 +59,25 @@ def find_spec_file
|
|||||||
when 1
|
when 1
|
||||||
spec_file = arr[0]
|
spec_file = arr[0]
|
||||||
else
|
else
|
||||||
puts 'Which spec should be used?'
|
puts "Which spec should be used?"
|
||||||
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
|
||||||
input_index = Integer(gets.chomp)
|
input_index = Integer(gets.chomp)
|
||||||
spec_file = arr[input_index-1]
|
spec_file = arr[input_index - 1]
|
||||||
end
|
end
|
||||||
|
|
||||||
if spec_file == nil
|
if spec_file.nil?
|
||||||
puts "Can't find specified spec file -> exit"
|
puts "Can't find specified spec file -> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
|
||||||
spec_file.sub('./', '')
|
spec_file.sub("./", "")
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_current_gem_file
|
def find_current_gem_file
|
||||||
list_of_specs = execute_line("find . -name '*.gem'")
|
list_of_specs = execute_line("find . -name '*.gem'")
|
||||||
arr = list_of_specs.split("\n")
|
arr = list_of_specs.split("\n")
|
||||||
|
|
||||||
spec_file = ''
|
spec_file = ""
|
||||||
|
|
||||||
case arr.count
|
case arr.count
|
||||||
when 0
|
when 0
|
||||||
@@ -88,41 +86,40 @@ def find_current_gem_file
|
|||||||
when 1
|
when 1
|
||||||
spec_file = arr[0]
|
spec_file = arr[0]
|
||||||
else
|
else
|
||||||
puts 'Which spec should be used?'
|
puts "Which spec should be used?"
|
||||||
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
|
||||||
input_index = Integer(gets.chomp)
|
input_index = Integer(gets.chomp)
|
||||||
spec_file = arr[input_index-1]
|
spec_file = arr[input_index - 1]
|
||||||
end
|
end
|
||||||
|
|
||||||
if spec_file == nil
|
if spec_file.nil?
|
||||||
puts "Can't find specified spec file -> exit"
|
puts "Can't find specified spec file -> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
|
||||||
spec_file.sub('./', '')
|
spec_file.sub("./", "")
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_version_in_podspec(podspec)
|
def find_version_in_podspec(podspec)
|
||||||
readme = File.read(podspec)
|
readme = File.read(podspec)
|
||||||
|
|
||||||
#try to find version in format 1.22.333
|
# try to find version in format 1.22.333
|
||||||
re = /(\d+)\.(\d+)\.(\d+)/m
|
re = /(\d+)\.(\d+)\.(\d+)/m
|
||||||
|
|
||||||
match_result = re.match(readme)
|
match_result = re.match(readme)
|
||||||
|
|
||||||
unless match_result
|
unless match_result
|
||||||
puts 'Not found any versions'
|
puts "Not found any versions"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
|
||||||
puts "Found version #{match_result[0]}"
|
puts "Found version #{match_result[0]}"
|
||||||
return match_result[0], match_result.captures
|
[match_result[0], match_result.captures]
|
||||||
end
|
end
|
||||||
|
|
||||||
def bump_version(versions_array)
|
def bump_version(versions_array)
|
||||||
bumped_result = versions_array.dup
|
bumped_result = versions_array.dup
|
||||||
bumped_result.map! { |x| x.to_i }
|
bumped_result.map!(&:to_i)
|
||||||
|
|
||||||
case @options[:bump_number]
|
case @options[:bump_number]
|
||||||
when :major
|
when :major
|
||||||
@@ -135,11 +132,10 @@ def bump_version(versions_array)
|
|||||||
when :patch
|
when :patch
|
||||||
bumped_result[2] += 1
|
bumped_result[2] += 1
|
||||||
else
|
else
|
||||||
raise('unknown bump_number')
|
fail("unknown bump_number")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
bumped_version = bumped_result.join(".")
|
||||||
bumped_version = bumped_result.join('.')
|
|
||||||
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
|
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
|
||||||
bumped_version
|
bumped_version
|
||||||
end
|
end
|
||||||
@@ -157,7 +153,7 @@ def execute_line_if_not_dry_run(line)
|
|||||||
nil
|
nil
|
||||||
else
|
else
|
||||||
puts line
|
puts line
|
||||||
value = %x[#{line}]
|
value = `#{line}`
|
||||||
puts value
|
puts value
|
||||||
check_exit_status(value)
|
check_exit_status(value)
|
||||||
value
|
value
|
||||||
@@ -165,24 +161,23 @@ def execute_line_if_not_dry_run(line)
|
|||||||
end
|
end
|
||||||
|
|
||||||
def check_exit_status(output)
|
def check_exit_status(output)
|
||||||
if $?.exitstatus != 0
|
if $CHILD_STATUS.exitstatus != 0
|
||||||
puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
|
puts "Output:\n#{output}\nExit status = #{$CHILD_STATUS.exitstatus} ->Terminate script."
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def run_bumping_script
|
def run_bumping_script
|
||||||
|
|
||||||
check_repo_is_clean_or_dry_run
|
check_repo_is_clean_or_dry_run
|
||||||
spec_file = find_spec_file
|
spec_file = find_spec_file
|
||||||
result, versions_array = find_version_in_podspec(spec_file)
|
result, versions_array = find_version_in_podspec(spec_file)
|
||||||
bumped_version = bump_version(versions_array)
|
bumped_version = bump_version(versions_array)
|
||||||
|
|
||||||
unless @options[:dry_run]
|
unless @options[:dry_run]
|
||||||
puts 'Are you sure? Press Y to continue:'
|
puts "Are you sure? Press Y to continue:"
|
||||||
str = gets.chomp
|
str = gets.chomp
|
||||||
if str != 'Y'
|
if str != "Y"
|
||||||
puts '-> exit'
|
puts "-> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -191,14 +186,13 @@ def run_bumping_script
|
|||||||
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
|
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
|
||||||
execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
|
execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
|
||||||
execute_line_if_not_dry_run("git tag #{bumped_version}")
|
execute_line_if_not_dry_run("git tag #{bumped_version}")
|
||||||
execute_line_if_not_dry_run('git push')
|
execute_line_if_not_dry_run("git push")
|
||||||
execute_line_if_not_dry_run('git push --tags')
|
execute_line_if_not_dry_run("git push --tags")
|
||||||
execute_line_if_not_dry_run("gem build #{spec_file}")
|
execute_line_if_not_dry_run("gem build #{spec_file}")
|
||||||
|
|
||||||
gem = find_current_gem_file
|
gem = find_current_gem_file
|
||||||
execute_line_if_not_dry_run("gem push #{gem}")
|
execute_line_if_not_dry_run("gem push #{gem}")
|
||||||
# execute_line_if_not_dry_run("pod trunk push #{spec_file}")
|
# execute_line_if_not_dry_run("pod trunk push #{spec_file}")
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def revert_last_bump
|
def revert_last_bump
|
||||||
@@ -207,16 +201,16 @@ def revert_last_bump
|
|||||||
|
|
||||||
puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
|
puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
|
||||||
str = gets.chomp
|
str = gets.chomp
|
||||||
if str != 'Y'
|
if str != "Y"
|
||||||
puts '-> exit'
|
puts "-> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
execute_line_if_not_dry_run("git tag -d #{result}")
|
execute_line_if_not_dry_run("git tag -d #{result}")
|
||||||
execute_line_if_not_dry_run('git reset --hard HEAD~1')
|
execute_line_if_not_dry_run("git reset --hard HEAD~1")
|
||||||
execute_line_if_not_dry_run("git push --delete origin #{result}")
|
execute_line_if_not_dry_run("git push --delete origin #{result}")
|
||||||
end
|
end
|
||||||
|
|
||||||
if __FILE__ == $0
|
if __FILE__ == $PROGRAM_NAME
|
||||||
|
|
||||||
if @options[:revert]
|
if @options[:revert]
|
||||||
revert_last_bump
|
revert_last_bump
|
||||||
|
|||||||
@@ -1,21 +1,21 @@
|
|||||||
# coding: utf-8
|
# coding: utf-8
|
||||||
|
|
||||||
lib = File.expand_path('../lib', __FILE__)
|
lib = File.expand_path("../lib", __FILE__)
|
||||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||||
require 'github_changelog_generator/version'
|
require "github_changelog_generator/version"
|
||||||
|
|
||||||
Gem::Specification.new do |spec|
|
Gem::Specification.new do |spec|
|
||||||
spec.name = "github_changelog_generator"
|
spec.name = "github_changelog_generator"
|
||||||
spec.version = GitHubChangelogGenerator::VERSION
|
spec.version = GitHubChangelogGenerator::VERSION
|
||||||
spec.default_executable = "github_changelog_generator"
|
spec.default_executable = "github_changelog_generator"
|
||||||
|
|
||||||
spec.required_ruby_version = '>= 1.9.3'
|
spec.required_ruby_version = ">= 1.9.3"
|
||||||
spec.authors = ["Petr Korolev"]
|
spec.authors = ["Petr Korolev"]
|
||||||
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
spec.email = "sky4winder+github_changelog_generator@gmail.com"
|
||||||
spec.date = `date +"%Y-%m-%d"`.strip!
|
spec.date = `date +"%Y-%m-%d"`.strip!
|
||||||
spec.summary = %q{Script, that automatically generate changelog from your tags, issues, labels and pull requests.}
|
spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
|
||||||
spec.description = %q{Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker.}
|
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
|
||||||
spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
|
||||||
spec.license = "MIT"
|
spec.license = "MIT"
|
||||||
|
|
||||||
spec.files = `git ls-files -z`.split("\x0")
|
spec.files = `git ls-files -z`.split("\x0")
|
||||||
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
|
|||||||
spec.add_development_dependency "bundler", "~> 1.7"
|
spec.add_development_dependency "bundler", "~> 1.7"
|
||||||
spec.add_development_dependency "rake", "~> 10.0"
|
spec.add_development_dependency "rake", "~> 10.0"
|
||||||
|
|
||||||
spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||||
spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
|
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|||||||
BIN
images/logo.jpg
Normal file
BIN
images/logo.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.2 KiB |
@@ -6,6 +6,8 @@
|
|||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- This PR SHOULD NOT appear in change log! [\#6](https://github.com/skywinder/changelog_test/pull/6) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
|
- 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)
|
## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
|
||||||
|
|||||||
@@ -1,59 +1,65 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
|
|
||||||
require 'github_api'
|
require "github_api"
|
||||||
require 'json'
|
require "json"
|
||||||
require 'colorize'
|
require "colorize"
|
||||||
require 'benchmark'
|
require "benchmark"
|
||||||
|
|
||||||
require_relative 'github_changelog_generator/parser'
|
require_relative "github_changelog_generator/parser"
|
||||||
require_relative 'github_changelog_generator/generator'
|
require_relative "github_changelog_generator/generator"
|
||||||
require_relative 'github_changelog_generator/version'
|
require_relative "github_changelog_generator/version"
|
||||||
|
require_relative "github_changelog_generator/reader"
|
||||||
|
require_relative "github_changelog_generator/fetcher"
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class ChangelogGenerator
|
# Default error for ChangelogGenerator
|
||||||
|
class ChangelogGeneratorError < StandardError
|
||||||
|
end
|
||||||
|
|
||||||
|
# Main class and entry point for this script.
|
||||||
|
class ChangelogGenerator
|
||||||
attr_accessor :options, :all_tags, :github
|
attr_accessor :options, :all_tags, :github
|
||||||
|
|
||||||
PER_PAGE_NUMBER = 30
|
# Class, responsible for whole change log generation cycle
|
||||||
|
# @return initialised instance of ChangelogGenerator
|
||||||
def initialize
|
def initialize
|
||||||
|
|
||||||
@options = Parser.parse_options
|
@options = Parser.parse_options
|
||||||
|
|
||||||
fetch_github_token
|
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
||||||
|
|
||||||
github_options = {per_page: PER_PAGE_NUMBER}
|
@generator = Generator.new @options
|
||||||
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 = Github.new github_options
|
# @all_tags = get_filtered_tags
|
||||||
|
@all_tags = @fetcher.get_all_tags
|
||||||
|
|
||||||
@generator = Generator.new(@options)
|
@issues, @pull_requests = @fetcher.fetch_issues_and_pull_requests
|
||||||
|
|
||||||
@all_tags = self.get_all_tags
|
@pull_requests = @options[:pulls] ? get_filtered_pull_requests : []
|
||||||
@issues, @pull_requests = self.fetch_issues_and_pull_requests
|
|
||||||
|
|
||||||
if @options[:pulls]
|
@issues = @options[:issues] ? get_filtered_issues : []
|
||||||
@pull_requests = self.get_filtered_pull_requests
|
|
||||||
self.fetch_merged_at_pull_requests
|
|
||||||
else
|
|
||||||
@pull_requests = []
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:issues]
|
|
||||||
@issues = self.get_filtered_issues
|
|
||||||
else
|
|
||||||
@issues = []
|
|
||||||
end
|
|
||||||
|
|
||||||
fetch_event_for_issues_and_pr
|
fetch_event_for_issues_and_pr
|
||||||
detect_actual_closed_dates
|
detect_actual_closed_dates
|
||||||
@tag_times_hash = {}
|
end
|
||||||
|
|
||||||
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
|
#
|
||||||
|
# @return [Array]
|
||||||
|
def get_filtered_tags
|
||||||
|
all_tags = @fetcher.get_all_tags
|
||||||
|
filtered_tags = []
|
||||||
|
if @options[:between_tags]
|
||||||
|
@options[:between_tags].each do |tag|
|
||||||
|
unless all_tags.include? tag
|
||||||
|
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
|
||||||
|
end
|
||||||
|
end
|
||||||
|
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
|
||||||
|
end
|
||||||
|
filtered_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
def detect_actual_closed_dates
|
def detect_actual_closed_dates
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
print "Fetching closed dates for issues...\r"
|
print "Fetching closed dates for issues...\r"
|
||||||
end
|
end
|
||||||
@@ -71,28 +77,30 @@ module GitHubChangelogGenerator
|
|||||||
find_closed_date_by_commit(pull_request)
|
find_closed_date_by_commit(pull_request)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
threads.each { |thr| thr.join }
|
threads.each(&:join)
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts 'Fetching closed dates for issues: Done!'
|
puts "Fetching closed dates for issues: Done!"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Fill :actual_date parameter of specified issue by closed date of the commit, it it was closed by commit.
|
||||||
|
# @param [Hash] issue
|
||||||
def find_closed_date_by_commit(issue)
|
def find_closed_date_by_commit(issue)
|
||||||
unless issue['events'].nil?
|
unless issue["events"].nil?
|
||||||
#if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
||||||
compare_string = issue[:merged_at].nil? ? 'closed' : 'merged'
|
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
||||||
# reverse! - to find latest closed event. (event goes in date order)
|
# reverse! - to find latest closed event. (event goes in date order)
|
||||||
issue['events'].reverse!.each { |event|
|
issue["events"].reverse!.each { |event|
|
||||||
if event[:event].eql? compare_string
|
if event[:event].eql? compare_string
|
||||||
if event[:commit_id].nil?
|
if event[:commit_id].nil?
|
||||||
issue[:actual_date] = issue[:closed_at]
|
issue[:actual_date] = issue[:closed_at]
|
||||||
else
|
else
|
||||||
begin
|
begin
|
||||||
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
commit = @fetcher.fetch_commit(event)
|
||||||
issue[:actual_date] = commit[:author][:date]
|
issue[:actual_date] = commit[:author][:date]
|
||||||
rescue
|
rescue
|
||||||
puts "Warning: can't fetch commit #{event[:commit_id]} probably it referenced from another repo."
|
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
|
||||||
issue[:actual_date] = issue[:closed_at]
|
issue[:actual_date] = issue[:closed_at]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -100,70 +108,23 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
#TODO: assert issues, that remain without 'actual_date' hash for some reason.
|
# TODO: assert issues, that remain without 'actual_date' hash for some reason.
|
||||||
end
|
end
|
||||||
|
|
||||||
def print_json(json)
|
def print_json(json)
|
||||||
puts JSON.pretty_generate(json)
|
puts JSON.pretty_generate(json)
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_merged_at_pull_requests
|
# This method fetches missing params for PR and filter them by specified options
|
||||||
if @options[:verbose]
|
# It include add all PR's with labels from @options[:include_labels] array
|
||||||
print "Fetching merged dates...\r"
|
# And exclude all from :exclude_labels array.
|
||||||
end
|
# @return [Array] filtered PR's
|
||||||
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
|
||||||
|
|
||||||
pull_requests = []
|
|
||||||
page_i = 0
|
|
||||||
response.each_page do |page|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
count_pages = response.count_pages
|
|
||||||
print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
|
||||||
pull_requests.concat(page)
|
|
||||||
end
|
|
||||||
print " \r"
|
|
||||||
|
|
||||||
@pull_requests.each { |pr|
|
|
||||||
fetched_pr = pull_requests.find { |fpr|
|
|
||||||
fpr.number == pr.number }
|
|
||||||
pr[:merged_at] = fetched_pr[:merged_at]
|
|
||||||
pull_requests.delete(fetched_pr)
|
|
||||||
}
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Fetching merged dates... Done!'
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_filtered_pull_requests
|
def get_filtered_pull_requests
|
||||||
|
fetch_merged_at_pull_requests
|
||||||
|
|
||||||
pull_requests = @pull_requests
|
filtered_pull_requests = include_issues_by_labels(@pull_requests)
|
||||||
filtered_pull_requests = pull_requests
|
|
||||||
|
|
||||||
|
|
||||||
unless @options[:include_labels].nil?
|
|
||||||
filtered_pull_requests = pull_requests.select { |issue|
|
|
||||||
#add all labels from @options[:incluse_labels] array
|
|
||||||
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
unless @options[:exclude_labels].nil?
|
|
||||||
filtered_pull_requests = filtered_pull_requests.select { |issue|
|
|
||||||
#delete all labels from @options[:exclude_labels] array
|
|
||||||
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:add_issues_wo_labels]
|
|
||||||
issues_wo_labels = pull_requests.select {
|
|
||||||
# add issues without any labels
|
|
||||||
|issue| !issue.labels.map { |label| label.name }.any?
|
|
||||||
}
|
|
||||||
filtered_pull_requests |= issues_wo_labels
|
|
||||||
end
|
|
||||||
|
|
||||||
|
filtered_pull_requests = exclude_issues_by_labels(filtered_pull_requests)
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Filtered pull requests: #{filtered_pull_requests.count}"
|
puts "Filtered pull requests: #{filtered_pull_requests.count}"
|
||||||
@@ -172,17 +133,67 @@ module GitHubChangelogGenerator
|
|||||||
filtered_pull_requests
|
filtered_pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
def compund_changelog
|
# This method fetch missing required attributes for pull requests
|
||||||
|
# :merged_at - is a date, when issue PR was merged.
|
||||||
|
# More correct to use this date, not closed date.
|
||||||
|
def fetch_merged_at_pull_requests
|
||||||
|
if @options[:verbose]
|
||||||
|
print "Fetching merged dates...\r"
|
||||||
|
end
|
||||||
|
pull_requests = @fetcher.fetch_pull_requests
|
||||||
|
|
||||||
|
@pull_requests.each { |pr|
|
||||||
|
fetched_pr = pull_requests.find { |fpr|
|
||||||
|
fpr.number == pr.number
|
||||||
|
}
|
||||||
|
pr[:merged_at] = fetched_pr[:merged_at]
|
||||||
|
pull_requests.delete(fetched_pr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Fetching merged dates: Done!"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Include issues with labels, specified in :include_labels
|
||||||
|
# @param [Array] issues to filter
|
||||||
|
# @return [Array] filtered array of issues
|
||||||
|
def include_issues_by_labels(issues)
|
||||||
|
filtered_issues = @options[:include_labels].nil? ? issues : issues.select { |issue| (issue.labels.map(&:name) & @options[:include_labels]).any? }
|
||||||
|
|
||||||
|
if @options[:add_issues_wo_labels]
|
||||||
|
issues_wo_labels = issues.select { |issue|
|
||||||
|
!issue.labels.map(&:name).any?
|
||||||
|
}
|
||||||
|
filtered_issues |= issues_wo_labels
|
||||||
|
end
|
||||||
|
filtered_issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# delete all labels with labels from @options[:exclude_labels] array
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [Array] filtered array
|
||||||
|
def exclude_issues_by_labels(issues)
|
||||||
|
unless @options[:exclude_labels].nil?
|
||||||
|
issues = issues.select { |issue|
|
||||||
|
!(issue.labels.map(&:name) & @options[:exclude_labels]).any?
|
||||||
|
}
|
||||||
|
end
|
||||||
|
issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# The entry point of this script to generate change log
|
||||||
|
# @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
|
||||||
|
def compound_changelog
|
||||||
log = "# Change Log\n\n"
|
log = "# Change Log\n\n"
|
||||||
|
|
||||||
if @options[:unreleased_only]
|
if @options[:unreleased_only]
|
||||||
log += self.generate_log_between_tags(self.all_tags[0], nil)
|
log += generate_log_between_tags(all_tags[0], nil)
|
||||||
elsif @options[:tag1] and @options[:tag2]
|
elsif @options[:tag1] and @options[:tag2]
|
||||||
tag1 = @options[:tag1]
|
tag1 = @options[:tag1]
|
||||||
tag2 = @options[:tag2]
|
tag2 = @options[:tag2]
|
||||||
tags_strings = []
|
tags_strings = []
|
||||||
self.all_tags.each { |x| tags_strings.push(x['name']) }
|
all_tags.each { |x| tags_strings.push(x["name"]) }
|
||||||
|
|
||||||
if tags_strings.include?(tag1)
|
if tags_strings.include?(tag1)
|
||||||
if tags_strings.include?(tag2)
|
if tags_strings.include?(tag2)
|
||||||
@@ -190,65 +201,63 @@ module GitHubChangelogGenerator
|
|||||||
hash = Hash[to_a]
|
hash = Hash[to_a]
|
||||||
index1 = hash[tag1]
|
index1 = hash[tag1]
|
||||||
index2 = hash[tag2]
|
index2 = hash[tag2]
|
||||||
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
|
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag2} -> exit"
|
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag1} -> exit"
|
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
log += self.generate_log_for_all_tags
|
log += generate_log_for_all_tags
|
||||||
end
|
end
|
||||||
|
|
||||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
|
|
||||||
output_filename = "#{@options[:output]}"
|
output_filename = "#{@options[:output]}"
|
||||||
File.open(output_filename, 'w') { |file| file.write(log) }
|
File.open(output_filename, "w") { |file| file.write(log) }
|
||||||
puts 'Done!'
|
puts "Done!"
|
||||||
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
|
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# The full cycle of generation for whole project
|
||||||
|
# @return [String] The complete change log
|
||||||
def generate_log_for_all_tags
|
def generate_log_for_all_tags
|
||||||
|
|
||||||
fetch_tags_dates
|
fetch_tags_dates
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Sorting tags.."
|
puts "Sorting tags..."
|
||||||
end
|
end
|
||||||
|
|
||||||
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
|
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Generating log.."
|
puts "Generating log..."
|
||||||
end
|
end
|
||||||
|
|
||||||
|
log = ""
|
||||||
log = ''
|
|
||||||
|
|
||||||
if @options[:unreleased] && @all_tags.count != 0
|
if @options[:unreleased] && @all_tags.count != 0
|
||||||
unreleased_log = self.generate_log_between_tags(self.all_tags[0], nil)
|
unreleased_log = generate_log_between_tags(all_tags[0], nil)
|
||||||
if unreleased_log
|
if unreleased_log
|
||||||
log += unreleased_log
|
log += unreleased_log
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
(1 ... self.all_tags.size).each { |index|
|
(1...all_tags.size).each { |index|
|
||||||
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
|
||||||
}
|
}
|
||||||
if @all_tags.count != 0
|
if @all_tags.count != 0
|
||||||
log += generate_log_between_tags(nil, self.all_tags.last)
|
log += generate_log_between_tags(nil, all_tags.last)
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Async fetching of all tags dates
|
||||||
def fetch_tags_dates
|
def fetch_tags_dates
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
print "Fetching tags dates..\r"
|
print "Fetching tag dates...\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Async fetching tags:
|
# Async fetching tags:
|
||||||
@@ -256,86 +265,46 @@ module GitHubChangelogGenerator
|
|||||||
i = 0
|
i = 0
|
||||||
all = @all_tags.count
|
all = @all_tags.count
|
||||||
@all_tags.each { |tag|
|
@all_tags.each { |tag|
|
||||||
# explicit set @tag_times_hash to write data safety.
|
|
||||||
threads << Thread.new {
|
threads << Thread.new {
|
||||||
self.get_time_of_tag(tag, @tag_times_hash)
|
@fetcher.get_time_of_tag(tag)
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
print "Fetching tags dates: #{i+1}/#{all}\r"
|
print "Fetching tags dates: #{i + 1}/#{all}\r"
|
||||||
i+=1
|
i += 1
|
||||||
end
|
end
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
print " \r"
|
print " \r"
|
||||||
|
|
||||||
threads.each { |thr| thr.join }
|
threads.each(&:join)
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts 'Fetching tags: Done!'
|
puts "Fetching tags dates: #{i} Done!"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def is_megred(number)
|
# Generate log only between 2 specified tags
|
||||||
@github.pull_requests.merged? @options[:user], @options[:project], number
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
end
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
|
|
||||||
def get_all_tags
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching tags...\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
response = @github.repos.tags @options[:user], @options[:project]
|
|
||||||
|
|
||||||
tags = []
|
|
||||||
page_i = 0
|
|
||||||
count_pages = response.count_pages
|
|
||||||
response.each_page do |page|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
|
||||||
tags.concat(page)
|
|
||||||
end
|
|
||||||
print " \r"
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Found #{tags.count} tags"
|
|
||||||
end
|
|
||||||
|
|
||||||
tags
|
|
||||||
end
|
|
||||||
|
|
||||||
def fetch_github_token
|
|
||||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
|
|
||||||
|
|
||||||
unless env_var
|
|
||||||
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
|
|
||||||
puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
|
|
||||||
end
|
|
||||||
|
|
||||||
@github_token ||= env_var
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
def generate_log_between_tags(older_tag, newer_tag)
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
# older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
|
|
||||||
filtered_pull_requests = delete_by_time(@pull_requests, :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)
|
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
|
||||||
|
|
||||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
|
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
|
||||||
older_tag_name = older_tag.nil? ? nil : older_tag['name']
|
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
||||||
|
|
||||||
if @options[:filter_issues_by_milestone]
|
if @options[:filter_issues_by_milestone]
|
||||||
#delete excess irrelevant issues (according milestones)
|
# delete excess irrelevant issues (according milestones)
|
||||||
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
||||||
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
||||||
end
|
end
|
||||||
|
|
||||||
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
|
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
|
||||||
# do not generate empty unreleased section
|
# do not generate empty unreleased section
|
||||||
return nil
|
return ""
|
||||||
end
|
end
|
||||||
|
|
||||||
self.create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||||
end
|
end
|
||||||
|
|
||||||
def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
|
def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
|
||||||
@@ -344,18 +313,18 @@ module GitHubChangelogGenerator
|
|||||||
if issue.milestone.nil?
|
if issue.milestone.nil?
|
||||||
true
|
true
|
||||||
else
|
else
|
||||||
#check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
unless newer_tag_name.nil?
|
unless newer_tag_name.nil?
|
||||||
|
|
||||||
#add missed issues (according milestones)
|
# add missed issues (according milestones)
|
||||||
issues_to_add = src_array.select { |issue|
|
issues_to_add = src_array.select { |issue|
|
||||||
if issue.milestone.nil?
|
if issue.milestone.nil?
|
||||||
false
|
false
|
||||||
else
|
else
|
||||||
#check, that this milestone in tag list:
|
# check, that this milestone in tag list:
|
||||||
milestone_is_tag = @all_tags.find { |tag|
|
milestone_is_tag = @all_tags.find { |tag|
|
||||||
tag.name == issue.milestone.title
|
tag.name == issue.milestone.title
|
||||||
}
|
}
|
||||||
@@ -373,12 +342,17 @@ module GitHubChangelogGenerator
|
|||||||
filtered_issues
|
filtered_issues
|
||||||
end
|
end
|
||||||
|
|
||||||
def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
|
# Method filter issues, that belong only specified tag range
|
||||||
|
# @param [Array] array of issues to filter
|
||||||
|
# @param [Symbol] hash_key key of date value default is :actual_date
|
||||||
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
|
# @return [Array] filtered issues
|
||||||
|
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||||
|
fail ChangelogGeneratorError, "At least one of the tags should be not nil!".red if older_tag.nil? && newer_tag.nil?
|
||||||
|
|
||||||
raise 'At least one of the tags should be not nil!' if (older_tag.nil? && newer_tag.nil?)
|
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
|
||||||
|
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
|
||||||
newer_tag_time = self.get_time_of_tag(newer_tag)
|
|
||||||
older_tag_time = self.get_time_of_tag(older_tag)
|
|
||||||
|
|
||||||
array.select { |req|
|
array.select { |req|
|
||||||
if req[hash_key]
|
if req[hash_key]
|
||||||
@@ -396,7 +370,6 @@ module GitHubChangelogGenerator
|
|||||||
tag_in_range_new = t <= newer_tag_time
|
tag_in_range_new = t <= newer_tag_time
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||||
|
|
||||||
tag_in_range
|
tag_in_range
|
||||||
@@ -406,45 +379,38 @@ module GitHubChangelogGenerator
|
|||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
# @param [Array] pull_requests
|
# Generates log for section with header and body
|
||||||
# @param [Array] issues
|
#
|
||||||
# @param [String] older_tag_name
|
# @param [Array] pull_requests List or PR's in new section
|
||||||
# @return [String]
|
# @param [Array] issues List of issues in new section
|
||||||
|
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
||||||
|
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
||||||
|
# @return [String] Ready and parsed section
|
||||||
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
|
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
|
||||||
|
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
|
||||||
|
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
|
||||||
|
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
|
||||||
|
|
||||||
newer_tag_time = newer_tag.nil? ? nil : self.get_time_of_tag(newer_tag)
|
github_site = options[:github_site] || "https://github.com"
|
||||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
|
|
||||||
|
|
||||||
github_site = options[:github_site] || 'https://github.com'
|
|
||||||
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||||
|
|
||||||
if newer_tag.nil?
|
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
||||||
newer_tag_name = @options[:unreleased_label]
|
|
||||||
newer_tag_link = 'HEAD'
|
|
||||||
newer_tag_time = Time.new
|
|
||||||
else
|
|
||||||
newer_tag_link = newer_tag_name
|
|
||||||
end
|
|
||||||
|
|
||||||
log = ''
|
|
||||||
|
|
||||||
log += generate_header(log, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
|
||||||
|
|
||||||
if @options[:issues]
|
if @options[:issues]
|
||||||
# Generate issues:
|
# Generate issues:
|
||||||
issues_a = []
|
issues_a = []
|
||||||
enhancement_a = []
|
enhancement_a = []
|
||||||
bugs_a =[]
|
bugs_a = []
|
||||||
|
|
||||||
issues.each { |dict|
|
issues.each { |dict|
|
||||||
added = false
|
added = false
|
||||||
dict.labels.each { |label|
|
dict.labels.each { |label|
|
||||||
if label.name == 'bug'
|
if label.name == "bug"
|
||||||
bugs_a.push dict
|
bugs_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
end
|
end
|
||||||
if label.name == 'enhancement'
|
if label.name == "enhancement"
|
||||||
enhancement_a.push dict
|
enhancement_a.push dict
|
||||||
added = true
|
added = true
|
||||||
next
|
next
|
||||||
@@ -455,22 +421,26 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
}
|
}
|
||||||
|
|
||||||
log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix])
|
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||||
log += generate_log_from_array(bugs_a, @options[:bug_prefix])
|
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||||
log += generate_log_from_array(issues_a, @options[:issue_prefix])
|
log += generate_sub_section(issues_a, @options[:issue_prefix])
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:pulls]
|
if @options[:pulls]
|
||||||
# Generate pull requests:
|
# Generate pull requests:
|
||||||
log += generate_log_from_array(pull_requests, @options[:merge_prefix])
|
log += generate_sub_section(pull_requests, @options[:merge_prefix])
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_log_from_array(issues, prefix)
|
# @param [Array] issues List of issues on sub-section
|
||||||
log = ''
|
# @param [String] prefix Nae of sub-section
|
||||||
if options[:simple_list].nil? && issues.any?
|
# @return [String] Generate ready-to-go sub-section
|
||||||
|
def generate_sub_section(issues, prefix)
|
||||||
|
log = ""
|
||||||
|
|
||||||
|
if options[:simple_list] != true && issues.any?
|
||||||
log += "#{prefix}\n\n"
|
log += "#{prefix}\n\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -483,110 +453,51 @@ module GitHubChangelogGenerator
|
|||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_header(log, newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
|
# It generate one header for section with specific parameters.
|
||||||
|
#
|
||||||
|
# @param [String] newer_tag_name - name of newer tag
|
||||||
|
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
|
||||||
|
# @param [Time] newer_tag_time - time, when newer tag created
|
||||||
|
# @param [String] older_tag_link - tag name, used for links.
|
||||||
|
# @param [String] project_url - url for current project.
|
||||||
|
# @return [String] - Generate one ready-to-add section.
|
||||||
|
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
|
||||||
|
log = ""
|
||||||
|
|
||||||
#Generate date string:
|
# Generate date string:
|
||||||
time_string = newer_tag_time.strftime @options[:format]
|
time_string = newer_tag_time.strftime @options[:dateformat]
|
||||||
|
|
||||||
# Generate tag name and link
|
# Generate tag name and link
|
||||||
if newer_tag_name.equal? @options[:unreleased_label]
|
if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2})\n\n"
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
||||||
else
|
else
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:compare_link] && older_tag_name
|
if @options[:compare_link] && older_tag_link
|
||||||
# Generate compare link
|
# Generate compare link
|
||||||
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name2})\n\n"
|
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
|
# Filter issues according labels
|
||||||
|
# @return [Array] Filtered issues
|
||||||
if tag_name.nil?
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
if tag_times_hash[tag_name['name']]
|
|
||||||
return @tag_times_hash[tag_name['name']]
|
|
||||||
end
|
|
||||||
|
|
||||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
|
|
||||||
time_string = github_git_data_commits_get['committer']['date']
|
|
||||||
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_filtered_issues
|
def get_filtered_issues
|
||||||
|
filtered_issues = include_issues_by_labels(@issues)
|
||||||
|
|
||||||
issues = @issues
|
filtered_issues = exclude_issues_by_labels(filtered_issues)
|
||||||
|
|
||||||
filtered_issues = issues
|
|
||||||
|
|
||||||
unless @options[:include_labels].nil?
|
|
||||||
filtered_issues = issues.select { |issue|
|
|
||||||
#add all labels from @options[:incluse_labels] array
|
|
||||||
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
unless @options[:exclude_labels].nil?
|
|
||||||
filtered_issues = filtered_issues.select { |issue|
|
|
||||||
#delete all labels from @options[:exclude_labels] array
|
|
||||||
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:add_issues_wo_labels]
|
|
||||||
issues_wo_labels = issues.select {
|
|
||||||
# add issues without any labels
|
|
||||||
|issue| !issue.labels.map { |label| label.name }.any?
|
|
||||||
}
|
|
||||||
filtered_issues |= issues_wo_labels
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Filtered issues: #{filtered_issues.count}"
|
puts "Filtered issues: #{filtered_issues.count}"
|
||||||
end
|
end
|
||||||
|
|
||||||
filtered_issues
|
filtered_issues
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
def fetch_issues_and_pull_requests
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching closed issues...\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
|
||||||
|
|
||||||
issues = []
|
|
||||||
page_i = 0
|
|
||||||
count_pages = response.count_pages
|
|
||||||
response.each_page do |page|
|
|
||||||
page_i += PER_PAGE_NUMBER
|
|
||||||
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
|
||||||
issues.concat(page)
|
|
||||||
end
|
|
||||||
|
|
||||||
print " \r"
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Received issues: #{issues.count}"
|
|
||||||
end
|
|
||||||
|
|
||||||
# remove pull request from issues:
|
|
||||||
issues_wo_pr = issues.select { |x|
|
|
||||||
x.pull_request == nil
|
|
||||||
}
|
|
||||||
pull_requests = issues.select { |x|
|
|
||||||
x.pull_request != nil
|
|
||||||
}
|
|
||||||
return issues_wo_pr, pull_requests
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Fetch event for issues and pull requests
|
||||||
|
# @return [Array] array of fetched issues
|
||||||
def fetch_event_for_issues_and_pr
|
def fetch_event_for_issues_and_pr
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
||||||
@@ -594,38 +505,11 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
# Async fetching events:
|
# Async fetching events:
|
||||||
|
|
||||||
fetch_events_async(@issues + @pull_requests)
|
@fetcher.fetch_events_async(@issues + @pull_requests)
|
||||||
|
|
||||||
#to clear line from prev print
|
|
||||||
print " \r"
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Fetching events for issues and PR: Done!'
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_events_async(issues)
|
if __FILE__ == $PROGRAM_NAME
|
||||||
i = 0
|
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
|
||||||
max_thread_number = 50
|
|
||||||
threads = []
|
|
||||||
issues.each_slice(max_thread_number) { |issues_slice|
|
|
||||||
issues_slice.each { |issue|
|
|
||||||
threads << Thread.new {
|
|
||||||
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
|
|
||||||
issue[:events] = obj.body
|
|
||||||
print "Fetching events for issues and PR: #{i+1}/#{@issues.count + @pull_requests.count}\r"
|
|
||||||
i +=1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
threads.each { |thr| thr.join }
|
|
||||||
threads = []
|
|
||||||
}
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
if __FILE__ == $0
|
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|||||||
209
lib/github_changelog_generator/fetcher.rb
Normal file
209
lib/github_changelog_generator/fetcher.rb
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
require "logger"
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
||||||
|
# (such as filtering, validating, e.t.c)
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
||||||
|
class Fetcher
|
||||||
|
PER_PAGE_NUMBER = 30
|
||||||
|
GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be " \
|
||||||
|
"missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
|
||||||
|
|
||||||
|
def initialize(options = {})
|
||||||
|
@options = options
|
||||||
|
|
||||||
|
@user = @options[:user]
|
||||||
|
@project = @options[:project]
|
||||||
|
@github_token = fetch_github_token
|
||||||
|
@tag_times_hash = {}
|
||||||
|
|
||||||
|
@logger = Logger.new(STDOUT)
|
||||||
|
@logger.formatter = proc do |_severity, _datetime, _progname, msg|
|
||||||
|
"#{msg}\n"
|
||||||
|
end
|
||||||
|
github_options = { per_page: PER_PAGE_NUMBER }
|
||||||
|
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||||
|
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
|
||||||
|
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
|
||||||
|
|
||||||
|
begin
|
||||||
|
@github = Github.new github_options
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Returns GitHub token. First try to use variable, provided by --token option,
|
||||||
|
# otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
|
||||||
|
#
|
||||||
|
# @return [String]
|
||||||
|
def fetch_github_token
|
||||||
|
env_var = @options[:token] ? @options[:token] : (ENV.fetch "CHANGELOG_GITHUB_TOKEN", nil)
|
||||||
|
|
||||||
|
unless env_var
|
||||||
|
@logger.warn "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
|
||||||
|
@logger.warn "This script can make only 50 requests to GitHub API per hour without token!".yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
env_var
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch all tags from repo
|
||||||
|
# @return [Array] array of tags
|
||||||
|
def get_all_tags
|
||||||
|
if @options[:verbose]
|
||||||
|
print "Fetching tags...\r"
|
||||||
|
end
|
||||||
|
|
||||||
|
tags = []
|
||||||
|
|
||||||
|
begin
|
||||||
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
|
page_i = 0
|
||||||
|
count_pages = response.count_pages
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||||
|
tags.concat(page)
|
||||||
|
end
|
||||||
|
print " \r"
|
||||||
|
|
||||||
|
if tags.count == 0
|
||||||
|
@logger.warn "Warning: Can't find any tags in repo.\
|
||||||
|
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||||
|
elsif @options[:verbose]
|
||||||
|
@logger.info "Found #{tags.count} tags"
|
||||||
|
end
|
||||||
|
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
tags
|
||||||
|
end
|
||||||
|
|
||||||
|
# This method fetch all closed issues and separate them to pull requests and pure issues
|
||||||
|
# (pull request is kind of issue in term of GitHub)
|
||||||
|
# @return [Tuple] with issues and pull requests
|
||||||
|
def fetch_issues_and_pull_requests
|
||||||
|
if @options[:verbose]
|
||||||
|
print "Fetching closed issues...\r"
|
||||||
|
end
|
||||||
|
issues = []
|
||||||
|
|
||||||
|
begin
|
||||||
|
response = @github.issues.list user: @options[:user],
|
||||||
|
repo: @options[:project],
|
||||||
|
state: "closed",
|
||||||
|
filter: "all",
|
||||||
|
labels: nil
|
||||||
|
page_i = 0
|
||||||
|
count_pages = response.count_pages
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||||
|
issues.concat(page)
|
||||||
|
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
print " \r"
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
@logger.info "Received issues: #{issues.count}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# remove pull request from issues:
|
||||||
|
issues.partition { |x|
|
||||||
|
x[:pull_request].nil?
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch all pull requests. We need them to detect :merged_at parameter
|
||||||
|
# @return [Array] all pull requests
|
||||||
|
def fetch_pull_requests
|
||||||
|
pull_requests = []
|
||||||
|
begin
|
||||||
|
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
|
||||||
|
page_i = 0
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
count_pages = response.count_pages
|
||||||
|
print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||||
|
pull_requests.concat(page)
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
|
||||||
|
print " \r"
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch event for all issues and add them to :events
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [Void]
|
||||||
|
def fetch_events_async(issues)
|
||||||
|
i = 0
|
||||||
|
max_thread_number = 50
|
||||||
|
threads = []
|
||||||
|
issues.each_slice(max_thread_number) { |issues_slice|
|
||||||
|
issues_slice.each { |issue|
|
||||||
|
threads << Thread.new {
|
||||||
|
begin
|
||||||
|
obj = @github.issues.events.list user: @options[:user],
|
||||||
|
repo: @options[:project],
|
||||||
|
issue_number: issue["number"]
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
issue[:events] = obj.body
|
||||||
|
print "Fetching events for issues and PR: #{i + 1}/#{issues.count}\r"
|
||||||
|
i += 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
threads.each(&:join)
|
||||||
|
threads = []
|
||||||
|
}
|
||||||
|
|
||||||
|
# to clear line from prev print
|
||||||
|
print " \r"
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
@logger.info "Fetching events for issues and PR: #{i} Done!"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Try to find tag date in local hash.
|
||||||
|
# Otherwise fFetch tag time and put it to local hash file.
|
||||||
|
# @param [String] tag_name name of the tag
|
||||||
|
# @return [Time] time of specified tag
|
||||||
|
def get_time_of_tag(tag_name)
|
||||||
|
fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
|
||||||
|
|
||||||
|
if @tag_times_hash[tag_name["name"]]
|
||||||
|
return @tag_times_hash[tag_name["name"]]
|
||||||
|
end
|
||||||
|
|
||||||
|
begin
|
||||||
|
github_git_data_commits_get = @github.git_data.commits.get @options[:user],
|
||||||
|
@options[:project],
|
||||||
|
tag_name["commit"]["sha"]
|
||||||
|
rescue
|
||||||
|
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
|
time_string = github_git_data_commits_get["committer"]["date"]
|
||||||
|
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetch commit for specifed event
|
||||||
|
# @return [Hash]
|
||||||
|
def fetch_commit(event)
|
||||||
|
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,12 +1,18 @@
|
|||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Generator
|
class Generator
|
||||||
|
|
||||||
def initialize(options = nil)
|
def initialize(options = nil)
|
||||||
@options = options
|
@options = options
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Parse issue and generate single line formatted issue line.
|
||||||
|
#
|
||||||
|
# Example output:
|
||||||
|
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
#
|
||||||
|
# @param [Hash] issue Fetched issue from GitHub
|
||||||
|
# @return [String] Markdown-formatted single issue
|
||||||
def get_string_for_issue(issue)
|
def get_string_for_issue(issue)
|
||||||
encapsulated_title = self.encapsulate_string issue[:title]
|
encapsulated_title = encapsulate_string issue[:title]
|
||||||
|
|
||||||
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
||||||
|
|
||||||
@@ -23,17 +29,14 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
def encapsulate_string(string)
|
def encapsulate_string(string)
|
||||||
|
|
||||||
string.gsub! '\\', '\\\\'
|
string.gsub! '\\', '\\\\'
|
||||||
|
|
||||||
encpas_chars = %w(> * _ \( \) [ ] #)
|
encpas_chars = %w(> * _ \( \) [ ] #)
|
||||||
encpas_chars.each { |char|
|
encpas_chars.each do |char|
|
||||||
string.gsub! char, "\\#{char}"
|
string.gsub! char, "\\#{char}"
|
||||||
}
|
end
|
||||||
|
|
||||||
string
|
string
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -1,114 +1,142 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
require 'optparse'
|
require "optparse"
|
||||||
require 'pp'
|
require "pp"
|
||||||
require_relative 'version'
|
require_relative "version"
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Parser
|
class Parser
|
||||||
def self.parse_options
|
def self.parse_options
|
||||||
|
|
||||||
options = {
|
options = {
|
||||||
:tag1 => nil,
|
tag1: nil,
|
||||||
:tag2 => nil,
|
tag2: nil,
|
||||||
:format => '%Y-%m-%d',
|
dateformat: "%Y-%m-%d",
|
||||||
:output => 'CHANGELOG.md',
|
output: "CHANGELOG.md",
|
||||||
:exclude_labels => %w(duplicate question invalid wontfix),
|
issues: true,
|
||||||
:pulls => true,
|
add_issues_wo_labels: true,
|
||||||
:issues => true,
|
add_pr_wo_labels: true,
|
||||||
:verbose => true,
|
pulls: true,
|
||||||
:add_issues_wo_labels => true,
|
filter_issues_by_milestone: true,
|
||||||
:add_pr_wo_labels => true,
|
author: true,
|
||||||
:merge_prefix => '**Merged pull requests:**',
|
unreleased: true,
|
||||||
:issue_prefix => '**Closed issues:**',
|
unreleased_label: "Unreleased",
|
||||||
:bug_prefix => '**Fixed bugs:**',
|
compare_link: true,
|
||||||
:enhancement_prefix => '**Implemented enhancements:**',
|
include_labels: %w(bug enhancement),
|
||||||
:author => true,
|
exclude_labels: %w(duplicate question invalid wontfix),
|
||||||
:filter_issues_by_milestone => true,
|
max_issues: nil,
|
||||||
:compare_link => true,
|
simple_list: false,
|
||||||
:unreleased => true,
|
verbose: true,
|
||||||
:unreleased_label => 'Unreleased',
|
|
||||||
:branch => 'origin'
|
merge_prefix: "**Merged pull requests:**",
|
||||||
|
issue_prefix: "**Closed issues:**",
|
||||||
|
bug_prefix: "**Fixed bugs:**",
|
||||||
|
enhancement_prefix: "**Implemented enhancements:**",
|
||||||
|
branch: "origin"
|
||||||
}
|
}
|
||||||
|
|
||||||
parser = OptionParser.new { |opts|
|
parser = OptionParser.new do |opts|
|
||||||
opts.banner = 'Usage: github_changelog_generator [options]'
|
opts.banner = "Usage: github_changelog_generator [options]"
|
||||||
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
|
||||||
options[:user] = last
|
options[:user] = last
|
||||||
end
|
end
|
||||||
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
|
opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
|
||||||
options[:project] = last
|
options[:project] = last
|
||||||
end
|
end
|
||||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
|
opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
|
||||||
options[:token] = last
|
options[:token] = last
|
||||||
end
|
end
|
||||||
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
|
||||||
options[:format] = last
|
options[:dateformat] = last
|
||||||
end
|
end
|
||||||
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||||
options[:output] = last
|
options[:output] = last
|
||||||
end
|
end
|
||||||
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
|
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
||||||
options[:issues] = v
|
options[:issues] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels to changelog. Default is true') do |v|
|
opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
|
||||||
options[:add_issues_wo_labels] = v
|
options[:add_issues_wo_labels] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels to changelog. Default is true') do |v|
|
opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
|
||||||
options[:add_pr_wo_labels] = v
|
options[:add_pr_wo_labels] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
|
||||||
options[:pulls] = v
|
options[:pulls] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
|
opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
|
||||||
options[:filter_issues_by_milestone] = last
|
options[:filter_issues_by_milestone] = last
|
||||||
end
|
end
|
||||||
opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
|
opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
|
||||||
options[:author] = author
|
options[:author] = author
|
||||||
end
|
end
|
||||||
opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
|
opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
|
||||||
options[:unreleased_only] = v
|
options[:unreleased_only] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]unreleased', 'Add to log unreleased closed issues. Default is true') do |v|
|
opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
|
||||||
options[:unreleased] = v
|
options[:unreleased] = v
|
||||||
end
|
end
|
||||||
opts.on('--unreleased-label [label]', 'Add to log unreleased closed issues. Default is true') do |v|
|
opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
|
||||||
options[:unreleased_label] = v
|
options[:unreleased_label] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]compare-link', 'Include compare link (Full Changelog) between older version and newer version. Default is true') do |v|
|
opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
|
||||||
options[:compare_link] = v
|
options[:compare_link] = v
|
||||||
end
|
end
|
||||||
opts.on('--include-labels x,y,z', Array, 'Issues only with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
opts.on("--include-labels x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
|
||||||
options[:include_labels] = list
|
options[:include_labels] = list
|
||||||
end
|
end
|
||||||
opts.on('--exclude-labels x,y,z', Array, 'Issues with that labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
||||||
options[:exclude_labels] = list
|
options[:exclude_labels] = list
|
||||||
end
|
end
|
||||||
opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||||
|
options[:max_issues] = max
|
||||||
|
end
|
||||||
|
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
||||||
options[:github_site] = last
|
options[:github_site] = last
|
||||||
end
|
end
|
||||||
opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
|
opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
|
||||||
options[:github_endpoint] = last
|
options[:github_endpoint] = last
|
||||||
end
|
end
|
||||||
opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
|
opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
|
||||||
options[:simple_list] = v
|
options[:simple_list] = v
|
||||||
end
|
end
|
||||||
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
|
||||||
options[:verbose] = v
|
options[:verbose] = v
|
||||||
end
|
end
|
||||||
opts.on('-v', '--version', 'Print version number') do |v|
|
opts.on("-v", "--version", "Print version number") do |_v|
|
||||||
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
opts.on('-h', '--help', 'Displays Help') do
|
opts.on("-h", "--help", "Displays Help") do
|
||||||
puts opts
|
puts opts
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
}
|
end
|
||||||
|
|
||||||
parser.parse!
|
parser.parse!
|
||||||
|
|
||||||
|
detect_user_and_project(options)
|
||||||
|
|
||||||
|
if !options[:user] || !options[:project]
|
||||||
|
puts parser.banner
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
if ARGV[1]
|
||||||
|
options[:tag1] = ARGV[0]
|
||||||
|
options[:tag2] = ARGV[1]
|
||||||
|
end
|
||||||
|
|
||||||
|
if options[:verbose]
|
||||||
|
puts "Performing task with options:"
|
||||||
|
pp options
|
||||||
|
puts ""
|
||||||
|
end
|
||||||
|
|
||||||
|
options
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.detect_user_and_project(options)
|
||||||
if ARGV[0] && !ARGV[1]
|
if ARGV[0] && !ARGV[1]
|
||||||
github_site = options[:github_site] ? options[:github_site] : 'github.com'
|
github_site = options[:github_site] ? options[:github_site] : "github.com"
|
||||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
||||||
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
|
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
|
||||||
|
|
||||||
@@ -122,13 +150,16 @@ module GitHubChangelogGenerator
|
|||||||
exit
|
exit
|
||||||
else
|
else
|
||||||
options[:user] = match[1]
|
options[:user] = match[1]
|
||||||
options[:project]= match[2]
|
options[:project] = match[2]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if !options[:user] && !options[:project]
|
if !options[:user] && !options[:project]
|
||||||
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
|
options[:user] = "skywinder"
|
||||||
|
options[:project] = "changelog_test"
|
||||||
|
else
|
||||||
remote = `git config --get remote.#{options[:branch]}.url`
|
remote = `git config --get remote.#{options[:branch]}.url`
|
||||||
# try to find repo in format:
|
# try to find repo in format:
|
||||||
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
|
# origin git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
|
||||||
@@ -149,25 +180,7 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
|
||||||
puts parser.banner
|
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if ARGV[1]
|
|
||||||
options[:tag1] = ARGV[0]
|
|
||||||
options[:tag2] = ARGV[1]
|
|
||||||
end
|
|
||||||
|
|
||||||
if options[:verbose]
|
|
||||||
puts 'Performing task with options:'
|
|
||||||
pp options
|
|
||||||
puts ''
|
|
||||||
end
|
|
||||||
|
|
||||||
options
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
87
lib/github_changelog_generator/reader.rb
Normal file
87
lib/github_changelog_generator/reader.rb
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
#
|
||||||
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
|
#
|
||||||
|
# Copyright 2014, Zanui, <engineering@zanui.com.au>
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
# A Reader to read an existing ChangeLog file and return a structured object
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# reader = GitHubChangelogGenerator::Reader.new
|
||||||
|
# content = reader.read('./CHANGELOG.md')
|
||||||
|
class Reader
|
||||||
|
def initialize(options = {})
|
||||||
|
defaults = {
|
||||||
|
heading_level: "##",
|
||||||
|
heading_structures: [
|
||||||
|
/^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
|
||||||
|
/^## (?<version>.+?)( \((?<date>.+?)\))?$/
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
@options = options.merge(defaults)
|
||||||
|
|
||||||
|
@heading_level = @options[:heading_level]
|
||||||
|
@heading_structures = @options[:heading_structures]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Parse a single heading and return a Hash
|
||||||
|
#
|
||||||
|
# The following heading structures are currently valid:
|
||||||
|
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
|
||||||
|
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
|
||||||
|
# - ## v1.0.2 (2015-03-24)
|
||||||
|
# - ## v1.0.2
|
||||||
|
#
|
||||||
|
# @param [String] heading Heading from the ChangeLog File
|
||||||
|
# @return [Hash] Returns a structured Hash with version, url and date
|
||||||
|
def parse_heading(heading)
|
||||||
|
captures = { "version" => nil, "url" => nil, "date" => nil }
|
||||||
|
|
||||||
|
@heading_structures.each do |regexp|
|
||||||
|
matches = Regexp.new(regexp).match(heading)
|
||||||
|
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
|
||||||
|
|
||||||
|
# Try Regular Expressions until you find one that delivers results
|
||||||
|
break unless matches.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
captures
|
||||||
|
end
|
||||||
|
|
||||||
|
# Parse the given ChangeLog data into a Hash
|
||||||
|
#
|
||||||
|
# @param [String] data File data from the ChangeLog.md
|
||||||
|
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||||
|
def parse(data)
|
||||||
|
sections = data.split(/^## .+?$/)
|
||||||
|
headings = data.scan(/^## .+?$/)
|
||||||
|
changelog = []
|
||||||
|
|
||||||
|
headings.each_with_index do |heading, index|
|
||||||
|
captures = parse_heading(heading)
|
||||||
|
captures["content"] = sections.at(index + 1)
|
||||||
|
changelog.push captures
|
||||||
|
end
|
||||||
|
|
||||||
|
changelog
|
||||||
|
end
|
||||||
|
|
||||||
|
def read(file_path)
|
||||||
|
parse File.read(file_path)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = '1.3.9'
|
VERSION = "1.4.0"
|
||||||
end
|
end
|
||||||
|
|||||||
9395
spec/files/angular.js.md
Normal file
9395
spec/files/angular.js.md
Normal file
File diff suppressed because it is too large
Load Diff
1911
spec/files/bundler.md
Normal file
1911
spec/files/bundler.md
Normal file
File diff suppressed because it is too large
Load Diff
305
spec/files/github-changelog-generator.md
Normal file
305
spec/files/github-changelog-generator.md
Normal file
@@ -0,0 +1,305 @@
|
|||||||
|
# Change Log
|
||||||
|
|
||||||
|
## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.9...1.3.10)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Exclude closed PR's from changelog. [\#69](https://github.com/skywinder/Github-Changelog-Generator/issues/69)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/Github-Changelog-Generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.9](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.9) (2015-03-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.8...1.3.9)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/Github-Changelog-Generator/issues/63)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/Github-Changelog-Generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.8) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.6) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.5...1.3.6)
|
||||||
|
|
||||||
|
## [1.3.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.5) (2015-03-04)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.4...1.3.5)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/Github-Changelog-Generator/issues/60)
|
||||||
|
|
||||||
|
## [1.3.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.4) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/Github-Changelog-Generator/issues/59)
|
||||||
|
|
||||||
|
## [1.3.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.3) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/Github-Changelog-Generator/issues/58)
|
||||||
|
|
||||||
|
## [1.3.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.2) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/Github-Changelog-Generator/issues/57)
|
||||||
|
|
||||||
|
## [1.3.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.1) (2015-02-27)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.0...1.3.1)
|
||||||
|
|
||||||
|
## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
|
||||||
|
|
||||||
|
- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
|
||||||
|
|
||||||
|
- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
|
||||||
|
|
||||||
|
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
|
||||||
|
|
||||||
|
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||||
|
|
||||||
|
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
|
|
||||||
|
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
|
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
|
||||||
|
|
||||||
|
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
|
||||||
|
|
||||||
|
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
|
||||||
|
|
||||||
|
- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||||
|
|
||||||
|
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
||||||
|
|
||||||
|
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
|
||||||
|
|
||||||
|
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
|
||||||
|
|
||||||
|
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
|
||||||
|
|
||||||
|
- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
|
||||||
|
|
||||||
|
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
117
spec/spec_helper.rb
Normal file
117
spec/spec_helper.rb
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
#
|
||||||
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
|
#
|
||||||
|
# Copyright 2014, Zanui, <engineering@zanui.com.au>
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
require "codeclimate-test-reporter"
|
||||||
|
require "simplecov"
|
||||||
|
require "coveralls"
|
||||||
|
|
||||||
|
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||||
|
Coveralls::SimpleCov::Formatter,
|
||||||
|
SimpleCov::Formatter::HTMLFormatter,
|
||||||
|
CodeClimate::TestReporter::Formatter
|
||||||
|
]
|
||||||
|
SimpleCov.start
|
||||||
|
|
||||||
|
require "github_changelog_generator"
|
||||||
|
|
||||||
|
# This file was generated by the `rspec --init` command. Conventionally, all
|
||||||
|
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
|
||||||
|
# The generated `.rspec` file contains `--require spec_helper` which will cause
|
||||||
|
# this file to always be loaded, without a need to explicitly require it in any
|
||||||
|
# files.
|
||||||
|
#
|
||||||
|
# Given that it is always loaded, you are encouraged to keep this file as
|
||||||
|
# light-weight as possible. Requiring heavyweight dependencies from this file
|
||||||
|
# will add to the boot time of your test suite on EVERY test run, even for an
|
||||||
|
# individual file that may not need all of that loaded. Instead, consider making
|
||||||
|
# a separate helper file that requires the additional dependencies and performs
|
||||||
|
# the additional setup, and require it from the spec files that actually need
|
||||||
|
# it.
|
||||||
|
#
|
||||||
|
# The `.rspec` file also contains a few flags that are not defaults but that
|
||||||
|
# users commonly want.
|
||||||
|
#
|
||||||
|
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
|
||||||
|
RSpec.configure do |config|
|
||||||
|
# rspec-expectations config goes here. You can use an alternate
|
||||||
|
# assertion/expectation library such as wrong or the stdlib/minitest
|
||||||
|
# assertions if you prefer.
|
||||||
|
config.expect_with :rspec do |expectations|
|
||||||
|
# This option will default to `true` in RSpec 4. It makes the `description`
|
||||||
|
# and `failure_message` of custom matchers include text for helper methods
|
||||||
|
# defined using `chain`, e.g.:
|
||||||
|
# be_bigger_than(2).and_smaller_than(4).description
|
||||||
|
# # => "be bigger than 2 and smaller than 4"
|
||||||
|
# ...rather than:
|
||||||
|
# # => "be bigger than 2"
|
||||||
|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||||
|
end
|
||||||
|
|
||||||
|
# rspec-mocks config goes here. You can use an alternate test double
|
||||||
|
# library (such as bogus or mocha) by changing the `mock_with` option here.
|
||||||
|
config.mock_with :rspec do |mocks|
|
||||||
|
# Prevents you from mocking or stubbing a method that does not exist on
|
||||||
|
# a real object. This is generally recommended, and will default to
|
||||||
|
# `true` in RSpec 4.
|
||||||
|
mocks.verify_partial_doubles = true
|
||||||
|
end
|
||||||
|
|
||||||
|
# These two settings work together to allow you to limit a spec run
|
||||||
|
# to individual examples or groups you care about by tagging them with
|
||||||
|
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
|
||||||
|
# get run.
|
||||||
|
config.filter_run :focus
|
||||||
|
config.run_all_when_everything_filtered = true
|
||||||
|
|
||||||
|
# Limits the available syntax to the non-monkey patched syntax that is
|
||||||
|
# recommended. For more details, see:
|
||||||
|
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
|
||||||
|
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
|
||||||
|
# - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
|
||||||
|
# config.disable_monkey_patching!
|
||||||
|
|
||||||
|
# This setting enables warnings. It's recommended, but in some cases may
|
||||||
|
# be too noisy due to issues in dependencies.
|
||||||
|
config.warnings = true
|
||||||
|
|
||||||
|
# Many RSpec users commonly either run the entire suite or an individual
|
||||||
|
# file, and it's useful to allow more verbose output when running an
|
||||||
|
# individual spec file.
|
||||||
|
if config.files_to_run.one?
|
||||||
|
# Use the documentation formatter for detailed output,
|
||||||
|
# unless a formatter has already been configured
|
||||||
|
# (e.g. via a command-line flag).
|
||||||
|
config.default_formatter = "doc"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Print the 10 slowest examples and example groups at the
|
||||||
|
# end of the spec run, to help surface which specs are running
|
||||||
|
# particularly slow.
|
||||||
|
# config.profile_examples = 10
|
||||||
|
|
||||||
|
# Run specs in random order to surface order dependencies. If you find an
|
||||||
|
# order dependency and want to debug it, you can fix the order by providing
|
||||||
|
# the seed, which is printed after each run.
|
||||||
|
# --seed 1234
|
||||||
|
config.order = :random
|
||||||
|
|
||||||
|
# Seed global randomization in this process using the `--seed` CLI option.
|
||||||
|
# Setting this allows you to use `--seed` to deterministically reproduce
|
||||||
|
# test failures related to randomization by passing the same `--seed` value
|
||||||
|
# as the one that triggered the failure.
|
||||||
|
Kernel.srand config.seed
|
||||||
|
end
|
||||||
113
spec/unit/reader_spec.rb
Normal file
113
spec/unit/reader_spec.rb
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
#
|
||||||
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
|
#
|
||||||
|
# Copyright 2014, Zanui, <engineering@zanui.com.au>
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
describe GitHubChangelogGenerator::Reader do
|
||||||
|
before(:all) do
|
||||||
|
@reader = GitHubChangelogGenerator::Reader.new
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#parse_heading" do
|
||||||
|
context "when heading is empty" do
|
||||||
|
subject { @reader.parse_heading("## ") }
|
||||||
|
it { is_expected.to be_a(Hash) }
|
||||||
|
it { is_expected.to include("version", "url", "date") }
|
||||||
|
it { is_expected.to include("version" => nil, "url" => nil, "date" => nil) }
|
||||||
|
# TODO: Doesn't work?
|
||||||
|
# it { is_expected.to have_all_string_keys }
|
||||||
|
end
|
||||||
|
context "when given version, url and date" do
|
||||||
|
subject { @reader.parse_heading("## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)") }
|
||||||
|
it { is_expected.to include("version" => "1.3.10") }
|
||||||
|
it { is_expected.to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
|
||||||
|
it { is_expected.to include("date" => "2015-03-18") }
|
||||||
|
end
|
||||||
|
context "when no url and date is provided" do
|
||||||
|
subject { @reader.parse_heading("## foobar") }
|
||||||
|
it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#parse" do
|
||||||
|
context "when file is empty" do
|
||||||
|
subject { @reader.parse("") }
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.to be_empty }
|
||||||
|
end
|
||||||
|
context "when file has only the header" do
|
||||||
|
subject { @reader.parse("# Change Log") }
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.to be_empty }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "example CHANGELOG files" do
|
||||||
|
subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "files", self.class.description))) }
|
||||||
|
context "github-changelog-generator.md" do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it { expect(subject.count).to eq(28) }
|
||||||
|
it { expect(subject.first).to include("version" => "1.3.10") }
|
||||||
|
it { expect(subject.first).to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
|
||||||
|
it { expect(subject.first).to include("date" => "2015-03-18") }
|
||||||
|
it { expect(subject.first).to include("content") }
|
||||||
|
it "content should not be empty" do
|
||||||
|
expect(subject.first["content"]).not_to be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
context "bundler.md" do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it { expect(subject.count).to eq(151) }
|
||||||
|
it { expect(subject.first).to include("version" => "1.9.1") }
|
||||||
|
it { expect(subject.first).to include("url" => nil) }
|
||||||
|
it { expect(subject.first).to include("date" => "2015-03-21") }
|
||||||
|
it { expect(subject.first).to include("content") }
|
||||||
|
it "content should not be empty" do
|
||||||
|
expect(subject.first["content"]).not_to be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
context "angular.js.md" do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it do
|
||||||
|
pending("Implement heading_level for parser.")
|
||||||
|
expect(subject.count).to eq(134)
|
||||||
|
end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('url' => nil)
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('date' => '2015-03-17')
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('content')
|
||||||
|
# end
|
||||||
|
# it 'content should not be empty' do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first['content']).not_to be_empty
|
||||||
|
# end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user