Compare commits
98 Commits
1.4.1
...
feature/oc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
348be827f5 | ||
|
|
ea2fe61e94 | ||
|
|
925012049f | ||
|
|
b9593f7c70 | ||
|
|
e6d80b0cf0 | ||
|
|
a4a6e6dedb | ||
|
|
bbbbb092c3 | ||
|
|
f215694ffb | ||
|
|
68a045da22 | ||
|
|
e274f9992a | ||
|
|
4de98a7d16 | ||
|
|
d21651776c | ||
|
|
77d86b1e91 | ||
|
|
df47a88b47 | ||
|
|
8c6b783d6c | ||
|
|
9e84bfbabf | ||
|
|
57b33ae6b9 | ||
|
|
36346b5fc6 | ||
|
|
f24780eb19 | ||
|
|
f77f90a750 | ||
|
|
d33994d595 | ||
|
|
b6f86a8cb6 | ||
|
|
5cd87a44a6 | ||
|
|
243f0cf292 | ||
|
|
fee976df22 | ||
|
|
e735683eaf | ||
|
|
4f21ae7768 | ||
|
|
c480075e8e | ||
|
|
268a8f39b6 | ||
|
|
1fa1cccd2a | ||
|
|
adab012de4 | ||
|
|
e114901157 | ||
|
|
6c6116381b | ||
|
|
f527cfff67 | ||
|
|
92496f7c72 | ||
|
|
082210f49b | ||
|
|
dc67089c21 | ||
|
|
865ddbcacd | ||
|
|
9f2fb5f56c | ||
|
|
44ce94d7a8 | ||
|
|
67ea3159cd | ||
|
|
80a5fdef0c | ||
|
|
f7e9199841 | ||
|
|
19eb03c54e | ||
|
|
22d1657fd4 | ||
|
|
6fdcc0c61d | ||
|
|
dac3be9f7d | ||
|
|
9f1537ab34 | ||
|
|
9055792021 | ||
|
|
9720c96b8c | ||
|
|
8906fe5022 | ||
|
|
a415010e86 | ||
|
|
67fbb04b31 | ||
|
|
ff6115247e | ||
|
|
a0cf2f54ee | ||
|
|
0c8010d854 | ||
|
|
9b46d56a9e | ||
|
|
c3867a89f1 | ||
|
|
5cc3a7c8fd | ||
|
|
160cda50bc | ||
|
|
8e090022f0 | ||
|
|
a94834d57e | ||
|
|
a2b23e0f69 | ||
|
|
f0a22f0378 | ||
|
|
28c81fa487 | ||
|
|
783d8f306e | ||
|
|
957fa0d3a3 | ||
|
|
f498e673d1 | ||
|
|
7e941990c4 | ||
|
|
6f82741154 | ||
|
|
b9e7463c3e | ||
|
|
b06bb635ed | ||
|
|
a72ad326c4 | ||
|
|
da4bc8952d | ||
|
|
c8c633a65d | ||
|
|
d2cd79e710 | ||
|
|
8f4a931256 | ||
|
|
8e5e7de71d | ||
|
|
5aa4352acf | ||
|
|
171e536e76 | ||
|
|
757f6d40b4 | ||
|
|
c3b9455dfd | ||
|
|
134c18ba06 | ||
|
|
4ffb493787 | ||
|
|
b10707b259 | ||
|
|
3f076b3069 | ||
|
|
9a24eb1cb3 | ||
|
|
cf7ae57e3d | ||
|
|
3c289de79b | ||
|
|
4a96a7c0c9 | ||
|
|
7f696b6b09 | ||
|
|
536b39c961 | ||
|
|
944adc92cd | ||
|
|
3fc3e3e143 | ||
|
|
154ac01226 | ||
|
|
e2548e049a | ||
|
|
1ab6f2a5eb | ||
|
|
00d4242fa6 |
@@ -6,3 +6,11 @@ Metrics/LineLength:
|
|||||||
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
#http://viget.com/extend/just-use-double-quoted-ruby-strings
|
||||||
Style/StringLiterals:
|
Style/StringLiterals:
|
||||||
EnforcedStyle: double_quotes
|
EnforcedStyle: double_quotes
|
||||||
|
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/ClassLength:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# Configuration parameters: CountComments.
|
||||||
|
Metrics/MethodLength:
|
||||||
|
Enabled: false
|
||||||
|
|||||||
@@ -1,68 +1,36 @@
|
|||||||
# This configuration was generated by `rubocop --auto-gen-config`
|
# This configuration was generated by `rubocop --auto-gen-config`
|
||||||
# on 2015-05-14 16:51:06 +0300 using RuboCop version 0.31.0.
|
# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
|
||||||
# The point is for the user to remove these configuration records
|
# The point is for the user to remove these configuration records
|
||||||
# one by one as the offenses are removed from the code base.
|
# one by one as the offenses are removed from the code base.
|
||||||
# Note that changes in the inspected code, or installation of new
|
# Note that changes in the inspected code, or installation of new
|
||||||
# versions of RuboCop, may require this file to be generated again.
|
# versions of RuboCop, may require this file to be generated again.
|
||||||
|
|
||||||
# Offense count: 15
|
# Offense count: 13
|
||||||
Metrics/AbcSize:
|
Metrics/AbcSize:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 2
|
# Offense count: 1
|
||||||
Metrics/BlockNesting:
|
|
||||||
Max: 4
|
|
||||||
|
|
||||||
# Offense count: 3
|
|
||||||
# Configuration parameters: CountComments.
|
|
||||||
Metrics/ClassLength:
|
|
||||||
Max: 337
|
|
||||||
|
|
||||||
# Offense count: 5
|
|
||||||
Metrics/CyclomaticComplexity:
|
Metrics/CyclomaticComplexity:
|
||||||
Max: 15
|
Max: 7
|
||||||
|
|
||||||
# Offense count: 22
|
# Offense count: 1
|
||||||
# Configuration parameters: CountComments.
|
|
||||||
Metrics/MethodLength:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 5
|
|
||||||
Metrics/PerceivedComplexity:
|
Metrics/PerceivedComplexity:
|
||||||
Max: 18
|
Max: 8
|
||||||
|
|
||||||
# Offense count: 4
|
# Offense count: 2
|
||||||
Style/AccessorMethodName:
|
Style/AccessorMethodName:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 1
|
# Offense count: 10
|
||||||
# Cop supports --auto-correct.
|
|
||||||
# Configuration parameters: EnforcedStyle, SupportedStyles.
|
|
||||||
Style/AndOr:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 19
|
|
||||||
# Cop supports --auto-correct.
|
|
||||||
# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
|
|
||||||
Style/BlockDelimiters:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 4
|
|
||||||
Style/Documentation:
|
Style/Documentation:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 5
|
# Offense count: 1
|
||||||
# Configuration parameters: MinBodyLength.
|
# Configuration parameters: MinBodyLength.
|
||||||
Style/GuardClause:
|
Style/GuardClause:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|
||||||
# Offense count: 15
|
# Offense count: 1
|
||||||
# Cop supports --auto-correct.
|
|
||||||
# Configuration parameters: MaxLineLength.
|
|
||||||
Style/IfUnlessModifier:
|
|
||||||
Enabled: false
|
|
||||||
|
|
||||||
# Offense count: 2
|
|
||||||
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
||||||
Style/Next:
|
Style/Next:
|
||||||
Enabled: false
|
Enabled: false
|
||||||
|
|||||||
86
CHANGELOG.md
86
CHANGELOG.md
@@ -1,5 +1,83 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
|
||||||
|
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
|
||||||
|
|
||||||
|
## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
|
||||||
|
|
||||||
|
## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Issues with any label except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
|
||||||
|
|
||||||
|
- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
|
||||||
|
|
||||||
|
- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
|
||||||
|
|
||||||
|
## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
|
||||||
|
|
||||||
|
- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
|
||||||
|
|
||||||
|
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
|
||||||
|
|
||||||
|
- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Trees/Archives with missing change log notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
|
||||||
|
|
||||||
|
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
|
||||||
|
|
||||||
|
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
|
||||||
|
|
||||||
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
|
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
|
||||||
@@ -16,12 +94,12 @@
|
|||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
|
||||||
|
|
||||||
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||||
|
|
||||||
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||||
@@ -62,10 +140,6 @@
|
|||||||
|
|
||||||
[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.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)
|
## [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)
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
|
||||||
|
|||||||
15
Gemfile
15
Gemfile
@@ -1,14 +1,11 @@
|
|||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
gem "rake", ">=10.4.2"
|
gemspec
|
||||||
|
|
||||||
gem "github_api", ">=0.12.3"
|
|
||||||
gem "colorize", ">=0.7.7"
|
|
||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem "rspec"
|
gem "rspec", "~>3.2"
|
||||||
gem "rubocop"
|
gem "rubocop", "~>0.31"
|
||||||
gem "coveralls", require: false
|
gem "coveralls", "~>0.8", require: false
|
||||||
gem "simplecov", require: false
|
gem "simplecov", "~>0.10", require: false
|
||||||
gem "codeclimate-test-reporter"
|
gem "codeclimate-test-reporter", "~>0.4"
|
||||||
end
|
end
|
||||||
|
|||||||
79
Gemfile.lock
79
Gemfile.lock
@@ -1,14 +1,22 @@
|
|||||||
|
PATH
|
||||||
|
remote: .
|
||||||
|
specs:
|
||||||
|
github_changelog_generator (1.6.2)
|
||||||
|
colorize (~> 0.7)
|
||||||
|
github_api (~> 0.12)
|
||||||
|
octokit (~> 4.0)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.8)
|
addressable (2.3.8)
|
||||||
ast (2.0.0)
|
ast (2.0.0)
|
||||||
astrolabe (1.3.0)
|
astrolabe (1.3.1)
|
||||||
parser (>= 2.2.0.pre.3, < 3.0)
|
parser (~> 2.2)
|
||||||
codeclimate-test-reporter (0.4.7)
|
codeclimate-test-reporter (0.4.7)
|
||||||
simplecov (>= 0.7.1, < 1.0.0)
|
simplecov (>= 0.7.1, < 1.0.0)
|
||||||
colorize (0.7.7)
|
colorize (0.7.7)
|
||||||
coveralls (0.8.1)
|
coveralls (0.8.2)
|
||||||
json (~> 1.8)
|
json (~> 1.8)
|
||||||
rest-client (>= 1.6.8, < 2)
|
rest-client (>= 1.6.8, < 2)
|
||||||
simplecov (~> 0.10.0)
|
simplecov (~> 0.10.0)
|
||||||
@@ -30,14 +38,14 @@ 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.4.1)
|
hashie (3.4.2)
|
||||||
http-cookie (1.0.2)
|
http-cookie (1.0.2)
|
||||||
domain_name (~> 0.5)
|
domain_name (~> 0.5)
|
||||||
json (1.8.2)
|
json (1.8.3)
|
||||||
jwt (1.5.0)
|
jwt (1.5.1)
|
||||||
mime-types (2.5)
|
mime-types (2.6.1)
|
||||||
mini_portile (0.6.2)
|
mini_portile (0.6.2)
|
||||||
multi_json (1.11.0)
|
multi_json (1.11.2)
|
||||||
multi_xml (0.5.5)
|
multi_xml (0.5.5)
|
||||||
multipart-post (2.0.0)
|
multipart-post (2.0.0)
|
||||||
netrc (0.10.3)
|
netrc (0.10.3)
|
||||||
@@ -49,46 +57,51 @@ GEM
|
|||||||
multi_json (~> 1.3)
|
multi_json (~> 1.3)
|
||||||
multi_xml (~> 0.5)
|
multi_xml (~> 0.5)
|
||||||
rack (~> 1.2)
|
rack (~> 1.2)
|
||||||
parser (2.2.2.2)
|
octokit (4.0.1)
|
||||||
|
sawyer (~> 0.6.0, >= 0.5.3)
|
||||||
|
parser (2.2.2.6)
|
||||||
ast (>= 1.1, < 3.0)
|
ast (>= 1.1, < 3.0)
|
||||||
powerpack (0.1.1)
|
powerpack (0.1.1)
|
||||||
rack (1.6.1)
|
rack (1.6.4)
|
||||||
rainbow (2.0.0)
|
rainbow (2.0.0)
|
||||||
rake (10.4.2)
|
rake (10.4.2)
|
||||||
rest-client (1.8.0)
|
rest-client (1.8.0)
|
||||||
http-cookie (>= 1.0.2, < 2.0)
|
http-cookie (>= 1.0.2, < 2.0)
|
||||||
mime-types (>= 1.16, < 3.0)
|
mime-types (>= 1.16, < 3.0)
|
||||||
netrc (~> 0.7)
|
netrc (~> 0.7)
|
||||||
rspec (3.2.0)
|
rspec (3.3.0)
|
||||||
rspec-core (~> 3.2.0)
|
rspec-core (~> 3.3.0)
|
||||||
rspec-expectations (~> 3.2.0)
|
rspec-expectations (~> 3.3.0)
|
||||||
rspec-mocks (~> 3.2.0)
|
rspec-mocks (~> 3.3.0)
|
||||||
rspec-core (3.2.3)
|
rspec-core (3.3.2)
|
||||||
rspec-support (~> 3.2.0)
|
rspec-support (~> 3.3.0)
|
||||||
rspec-expectations (3.2.1)
|
rspec-expectations (3.3.1)
|
||||||
diff-lcs (>= 1.2.0, < 2.0)
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
rspec-support (~> 3.2.0)
|
rspec-support (~> 3.3.0)
|
||||||
rspec-mocks (3.2.1)
|
rspec-mocks (3.3.2)
|
||||||
diff-lcs (>= 1.2.0, < 2.0)
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
rspec-support (~> 3.2.0)
|
rspec-support (~> 3.3.0)
|
||||||
rspec-support (3.2.2)
|
rspec-support (3.3.0)
|
||||||
rubocop (0.31.0)
|
rubocop (0.32.1)
|
||||||
astrolabe (~> 1.3)
|
astrolabe (~> 1.3)
|
||||||
parser (>= 2.2.2.1, < 3.0)
|
parser (>= 2.2.2.5, < 3.0)
|
||||||
powerpack (~> 0.1)
|
powerpack (~> 0.1)
|
||||||
rainbow (>= 1.99.1, < 3.0)
|
rainbow (>= 1.99.1, < 3.0)
|
||||||
ruby-progressbar (~> 1.4)
|
ruby-progressbar (~> 1.4)
|
||||||
ruby-progressbar (1.7.5)
|
ruby-progressbar (1.7.5)
|
||||||
|
sawyer (0.6.0)
|
||||||
|
addressable (~> 2.3.5)
|
||||||
|
faraday (~> 0.8, < 0.10)
|
||||||
simplecov (0.10.0)
|
simplecov (0.10.0)
|
||||||
docile (~> 1.1.0)
|
docile (~> 1.1.0)
|
||||||
json (~> 1.8)
|
json (~> 1.8)
|
||||||
simplecov-html (~> 0.10.0)
|
simplecov-html (~> 0.10.0)
|
||||||
simplecov-html (0.10.0)
|
simplecov-html (0.10.0)
|
||||||
term-ansicolor (1.3.0)
|
term-ansicolor (1.3.2)
|
||||||
tins (~> 1.0)
|
tins (~> 1.0)
|
||||||
thor (0.19.1)
|
thor (0.19.1)
|
||||||
thread_safe (0.3.5)
|
thread_safe (0.3.5)
|
||||||
tins (1.5.1)
|
tins (1.5.4)
|
||||||
unf (0.1.4)
|
unf (0.1.4)
|
||||||
unf_ext
|
unf_ext
|
||||||
unf_ext (0.0.7.1)
|
unf_ext (0.0.7.1)
|
||||||
@@ -97,11 +110,11 @@ PLATFORMS
|
|||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
codeclimate-test-reporter
|
bundler (~> 1.7)
|
||||||
colorize (>= 0.7.7)
|
codeclimate-test-reporter (~> 0.4)
|
||||||
coveralls
|
coveralls (~> 0.8)
|
||||||
github_api (>= 0.12.3)
|
github_changelog_generator!
|
||||||
rake (>= 10.4.2)
|
rake (~> 10.0)
|
||||||
rspec
|
rspec (~> 3.2)
|
||||||
rubocop
|
rubocop (~> 0.31)
|
||||||
simplecov
|
simplecov (~> 0.10)
|
||||||
|
|||||||
32
README.md
32
README.md
@@ -80,39 +80,15 @@ Because software tools are for people. If you don’t care, why are you contribu
|
|||||||
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.
|
||||||
|
|
||||||
### Params
|
### Params
|
||||||
Type `github_changelog_generator --help` for detailed usage.
|
Type `github_changelog_generator --help` for details.
|
||||||
|
|
||||||
Usage: changelog_generator [options]
|
|
||||||
-u, --user [USER] Username of the owner of target GitHub repo
|
|
||||||
-p, --project [PROJECT] Name of project on GitHub
|
|
||||||
-t, --token [TOKEN] To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
|
|
||||||
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
|
|
||||||
-o, --output [NAME] Output file. Default is CHANGELOG.md
|
|
||||||
--[no-]verbose Run verbosely. Default is true
|
|
||||||
--[no-]issues Include closed issues to changelog. Default is true
|
|
||||||
--[no-]issues-wo-labels Include closed issues without labels to changelog. Default is true
|
|
||||||
--[no-]pr-wo-labels Include pull requests without labels to changelog. Default is true
|
|
||||||
--[no-]pull-requests Include pull-requests to changelog. Default is true
|
|
||||||
--[no-]filter-by-milestone Use milestone to detect when issue was resolved. Default is true
|
|
||||||
--[no-]author Add author of pull-request in the end. Default is true
|
|
||||||
--unreleased-only Generate log from unreleased closed issues only.
|
|
||||||
--[no-]unreleased Add to log unreleased closed issues. Default is true
|
|
||||||
--[no-]compare-link Include compare link between older version and newer version. Default is true
|
|
||||||
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
|
|
||||||
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
|
||||||
--max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited.
|
|
||||||
--github-site [URL] The Enterprise Github site on which your project is hosted.
|
|
||||||
--github-api [URL] The enterprise endpoint to use for your Github API.
|
|
||||||
--future-release [RELEASE-VERSION] Put the unreleased changes in the specified release number.
|
|
||||||
-v, --version Print version number
|
|
||||||
-h, --help Displays Help
|
|
||||||
|
|
||||||
|
More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
||||||
|
|
||||||
### GitHub token
|
### GitHub token
|
||||||
|
|
||||||
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
|
||||||
|
|
||||||
**You can easily [generate it here](https://github.com/settings/tokens)**.
|
**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
|
||||||
|
|
||||||
And:
|
And:
|
||||||
|
|
||||||
@@ -129,7 +105,7 @@ 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, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
|
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
|
||||||
- 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) :dizzy:
|
||||||
- **GitHub Enterprise support** via command line options! :factory:
|
- **GitHub Enterprise support** via command line options! :factory:
|
||||||
- Flexible format **customisation**:
|
- Flexible format **customisation**:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
#! /usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
|
|
||||||
require_relative "../lib/github_changelog_generator"
|
require_relative "../lib/github_changelog_generator"
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
|
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||||
|
|||||||
@@ -23,9 +23,11 @@ Gem::Specification.new do |spec|
|
|||||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||||
spec.require_paths = ["lib"]
|
spec.require_paths = ["lib"]
|
||||||
|
|
||||||
|
spec.add_runtime_dependency("github_api", ["~> 0.12"])
|
||||||
|
spec.add_runtime_dependency("octokit", ["~> 4.0"])
|
||||||
|
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
||||||
|
|
||||||
|
# Development only
|
||||||
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("github_api", ["~> 0.12"])
|
|
||||||
spec.add_runtime_dependency("colorize", ["~> 0.7"])
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,14 +2,40 @@
|
|||||||
|
|
||||||
## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
|
## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...HEAD)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
|
||||||
|
- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
|
||||||
|
- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
|
||||||
|
- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
|
||||||
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Test issue, that should appear in 0.0.4 [\#3](https://github.com/skywinder/changelog_test/issues/3)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
|
|
||||||
- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
|
- Add 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)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -17,7 +43,6 @@
|
|||||||
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
|
- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
|
## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
|
||||||
|
|
||||||
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
|
[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
|
||||||
|
|
||||||
**Merged pull requests:**
|
**Merged pull requests:**
|
||||||
@@ -27,5 +52,4 @@
|
|||||||
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
|
## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
@@ -5,518 +5,36 @@ require "json"
|
|||||||
require "colorize"
|
require "colorize"
|
||||||
require "benchmark"
|
require "benchmark"
|
||||||
|
|
||||||
|
require_relative "github_changelog_generator/helper"
|
||||||
require_relative "github_changelog_generator/parser"
|
require_relative "github_changelog_generator/parser"
|
||||||
require_relative "github_changelog_generator/generator"
|
require_relative "github_changelog_generator/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/reader"
|
||||||
require_relative "github_changelog_generator/fetcher"
|
|
||||||
|
|
||||||
|
# The main module, where placed all classes (now, at least)
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
# Default error for ChangelogGenerator
|
|
||||||
class ChangelogGeneratorError < StandardError
|
|
||||||
end
|
|
||||||
|
|
||||||
# Main class and entry point for this script.
|
# Main class and entry point for this script.
|
||||||
class ChangelogGenerator
|
class ChangelogGenerator
|
||||||
attr_accessor :options, :all_tags, :github
|
|
||||||
|
|
||||||
# Class, responsible for whole change log generation cycle
|
# Class, responsible for whole change log generation cycle
|
||||||
# @return initialised instance of ChangelogGenerator
|
# @return initialised instance of ChangelogGenerator
|
||||||
def initialize
|
def initialize
|
||||||
@options = Parser.parse_options
|
@options = Parser.parse_options
|
||||||
|
|
||||||
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
|
||||||
|
|
||||||
@generator = Generator.new @options
|
@generator = Generator.new @options
|
||||||
|
|
||||||
# @all_tags = get_filtered_tags
|
|
||||||
@all_tags = @fetcher.get_all_tags
|
|
||||||
|
|
||||||
# TODO: refactor this double asssign of @issues and @pull_requests and move all logic in one method
|
|
||||||
@issues, @pull_requests = @fetcher.fetch_closed_issues_and_pr
|
|
||||||
|
|
||||||
@pull_requests = @options[:pulls] ? get_filtered_pull_requests : []
|
|
||||||
|
|
||||||
@issues = @options[:issues] ? get_filtered_issues : []
|
|
||||||
|
|
||||||
fetch_event_for_issues_and_pr
|
|
||||||
detect_actual_closed_dates
|
|
||||||
end
|
|
||||||
|
|
||||||
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
|
||||||
#
|
|
||||||
# @return [Array]
|
|
||||||
def get_filtered_tags
|
|
||||||
all_tags = @fetcher.get_all_tags
|
|
||||||
filtered_tags = []
|
|
||||||
if @options[:between_tags]
|
|
||||||
@options[:between_tags].each do |tag|
|
|
||||||
unless all_tags.include? tag
|
|
||||||
puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
|
|
||||||
end
|
|
||||||
end
|
|
||||||
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
|
|
||||||
end
|
|
||||||
filtered_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
def detect_actual_closed_dates
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching closed dates for issues...\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
threads = []
|
|
||||||
|
|
||||||
@issues.each { |issue|
|
|
||||||
threads << Thread.new {
|
|
||||||
find_closed_date_by_commit(issue)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@pull_requests.each { |pull_request|
|
|
||||||
threads << Thread.new {
|
|
||||||
find_closed_date_by_commit(pull_request)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
threads.each(&:join)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Fetching closed dates for issues: Done!"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fill :actual_date parameter of specified issue by closed date of the commit, it it was closed by commit.
|
|
||||||
# @param [Hash] issue
|
|
||||||
def find_closed_date_by_commit(issue)
|
|
||||||
unless issue["events"].nil?
|
|
||||||
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
|
||||||
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
|
||||||
# reverse! - to find latest closed event. (event goes in date order)
|
|
||||||
issue["events"].reverse!.each { |event|
|
|
||||||
if event[:event].eql? compare_string
|
|
||||||
if event[:commit_id].nil?
|
|
||||||
issue[:actual_date] = issue[:closed_at]
|
|
||||||
else
|
|
||||||
begin
|
|
||||||
commit = @fetcher.fetch_commit(event)
|
|
||||||
issue[:actual_date] = commit[:author][:date]
|
|
||||||
rescue
|
|
||||||
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
|
|
||||||
issue[:actual_date] = issue[:closed_at]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
break
|
|
||||||
end
|
|
||||||
}
|
|
||||||
end
|
|
||||||
# TODO: assert issues, that remain without 'actual_date' hash for some reason.
|
|
||||||
end
|
|
||||||
|
|
||||||
def print_json(json)
|
|
||||||
puts JSON.pretty_generate(json)
|
|
||||||
end
|
|
||||||
|
|
||||||
# This method fetches missing params for PR and filter them by specified options
|
|
||||||
# It include add all PR's with labels from @options[:include_labels] array
|
|
||||||
# And exclude all from :exclude_labels array.
|
|
||||||
# @return [Array] filtered PR's
|
|
||||||
def get_filtered_pull_requests
|
|
||||||
filter_merged_pull_requests
|
|
||||||
|
|
||||||
filtered_pull_requests = include_issues_by_labels(@pull_requests)
|
|
||||||
|
|
||||||
filtered_pull_requests = exclude_issues_by_labels(filtered_pull_requests)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Filtered pull requests: #{filtered_pull_requests.count}"
|
|
||||||
end
|
|
||||||
|
|
||||||
filtered_pull_requests
|
|
||||||
end
|
|
||||||
|
|
||||||
# This method filter only merged PR and
|
|
||||||
# fetch missing required attributes for pull requests
|
|
||||||
# :merged_at - is a date, when issue PR was merged.
|
|
||||||
# More correct to use merged date, rather than closed date.
|
|
||||||
def filter_merged_pull_requests
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching merged dates...\r"
|
|
||||||
end
|
|
||||||
pull_requests = @fetcher.fetch_closed_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)
|
|
||||||
}
|
|
||||||
|
|
||||||
@pull_requests.select! do |pr|
|
|
||||||
!pr[:merged_at].nil?
|
|
||||||
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
|
end
|
||||||
|
|
||||||
# The entry point of this script to generate change log
|
# 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.
|
# @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
|
||||||
def compound_changelog
|
def run
|
||||||
log = "# Change Log\n\n"
|
log = @generator.compound_changelog
|
||||||
|
|
||||||
if @options[:unreleased_only]
|
|
||||||
log += generate_log_between_tags(all_tags[0], nil)
|
|
||||||
elsif @options[:tag1] and @options[:tag2]
|
|
||||||
tag1 = @options[:tag1]
|
|
||||||
tag2 = @options[:tag2]
|
|
||||||
tags_strings = []
|
|
||||||
all_tags.each { |x| tags_strings.push(x["name"]) }
|
|
||||||
|
|
||||||
if tags_strings.include?(tag1)
|
|
||||||
if tags_strings.include?(tag2)
|
|
||||||
to_a = tags_strings.map.with_index.to_a
|
|
||||||
hash = Hash[to_a]
|
|
||||||
index1 = hash[tag1]
|
|
||||||
index2 = hash[tag2]
|
|
||||||
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
|
|
||||||
else
|
|
||||||
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
|
||||||
end
|
|
||||||
else
|
|
||||||
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
|
||||||
end
|
|
||||||
else
|
|
||||||
log += generate_log_for_all_tags
|
|
||||||
end
|
|
||||||
|
|
||||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
|
||||||
|
|
||||||
output_filename = "#{@options[:output]}"
|
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 #{Dir.pwd}/#{output_filename}"
|
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# The full cycle of generation for whole project
|
|
||||||
# @return [String] The complete change log
|
|
||||||
def generate_log_for_all_tags
|
|
||||||
fetch_tags_dates
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Sorting tags..."
|
|
||||||
end
|
|
||||||
|
|
||||||
@all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Generating log..."
|
|
||||||
end
|
|
||||||
|
|
||||||
log = ""
|
|
||||||
|
|
||||||
if @options[:unreleased] && @all_tags.count != 0
|
|
||||||
unreleased_log = generate_log_between_tags(all_tags[0], nil)
|
|
||||||
if unreleased_log
|
|
||||||
log += unreleased_log
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
(1...all_tags.size).each { |index|
|
|
||||||
log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
|
|
||||||
}
|
|
||||||
if @all_tags.count != 0
|
|
||||||
log += generate_log_between_tags(nil, all_tags.last)
|
|
||||||
end
|
|
||||||
|
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
# Async fetching of all tags dates
|
|
||||||
def fetch_tags_dates
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching tag dates...\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Async fetching tags:
|
|
||||||
threads = []
|
|
||||||
i = 0
|
|
||||||
all = @all_tags.count
|
|
||||||
@all_tags.each { |tag|
|
|
||||||
threads << Thread.new {
|
|
||||||
@fetcher.get_time_of_tag(tag)
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching tags dates: #{i + 1}/#{all}\r"
|
|
||||||
i += 1
|
|
||||||
end
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
print " \r"
|
|
||||||
|
|
||||||
threads.each(&:join)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Fetching tags dates: #{i}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Generate log only between 2 specified tags
|
|
||||||
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
|
||||||
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
|
||||||
def generate_log_between_tags(older_tag, newer_tag)
|
|
||||||
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
|
|
||||||
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
|
|
||||||
|
|
||||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
|
|
||||||
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
|
||||||
|
|
||||||
if @options[:filter_issues_by_milestone]
|
|
||||||
# delete excess irrelevant issues (according milestones)
|
|
||||||
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
|
||||||
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
|
||||||
end
|
|
||||||
|
|
||||||
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
|
|
||||||
# do not generate empty unreleased section
|
|
||||||
return ""
|
|
||||||
end
|
|
||||||
|
|
||||||
create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
|
||||||
end
|
|
||||||
|
|
||||||
def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
|
|
||||||
filtered_issues.select! { |issue|
|
|
||||||
# leave issues without milestones
|
|
||||||
if issue.milestone.nil?
|
|
||||||
true
|
|
||||||
else
|
|
||||||
# check, that this milestone in tag list:
|
|
||||||
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
|
||||||
end
|
|
||||||
}
|
|
||||||
unless newer_tag_name.nil?
|
|
||||||
|
|
||||||
# add missed issues (according milestones)
|
|
||||||
issues_to_add = src_array.select { |issue|
|
|
||||||
if issue.milestone.nil?
|
|
||||||
false
|
|
||||||
else
|
|
||||||
# check, that this milestone in tag list:
|
|
||||||
milestone_is_tag = @all_tags.find { |tag|
|
|
||||||
tag.name == issue.milestone.title
|
|
||||||
}
|
|
||||||
|
|
||||||
if milestone_is_tag.nil?
|
|
||||||
false
|
|
||||||
else
|
|
||||||
issue.milestone.title == newer_tag_name
|
|
||||||
end
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
filtered_issues |= issues_to_add
|
|
||||||
end
|
|
||||||
filtered_issues
|
|
||||||
end
|
|
||||||
|
|
||||||
# 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?
|
|
||||||
|
|
||||||
newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
|
|
||||||
older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
|
|
||||||
|
|
||||||
array.select { |req|
|
|
||||||
if req[hash_key]
|
|
||||||
t = Time.parse(req[hash_key]).utc
|
|
||||||
|
|
||||||
if older_tag_time.nil?
|
|
||||||
tag_in_range_old = true
|
|
||||||
else
|
|
||||||
tag_in_range_old = t > older_tag_time
|
|
||||||
end
|
|
||||||
|
|
||||||
if newer_tag_time.nil?
|
|
||||||
tag_in_range_new = true
|
|
||||||
else
|
|
||||||
tag_in_range_new = t <= newer_tag_time
|
|
||||||
end
|
|
||||||
|
|
||||||
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
|
||||||
|
|
||||||
tag_in_range
|
|
||||||
else
|
|
||||||
false
|
|
||||||
end
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
# Generates log for section with header and body
|
|
||||||
#
|
|
||||||
# @param [Array] pull_requests List or PR's in new section
|
|
||||||
# @param [Array] issues List of issues in new section
|
|
||||||
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
|
||||||
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
|
||||||
# @return [String] Ready and parsed section
|
|
||||||
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
|
|
||||||
newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
|
|
||||||
if newer_tag.nil? && @options[:future_release]
|
|
||||||
newer_tag_name = @options[:future_release]
|
|
||||||
newer_tag_link = @options[:future_release]
|
|
||||||
else
|
|
||||||
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
|
|
||||||
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
|
|
||||||
end
|
|
||||||
|
|
||||||
github_site = options[:github_site] || "https://github.com"
|
|
||||||
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
|
||||||
|
|
||||||
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
|
||||||
|
|
||||||
if @options[:issues]
|
|
||||||
# Generate issues:
|
|
||||||
issues_a = []
|
|
||||||
enhancement_a = []
|
|
||||||
bugs_a = []
|
|
||||||
|
|
||||||
issues.each { |dict|
|
|
||||||
added = false
|
|
||||||
dict.labels.each { |label|
|
|
||||||
if label.name == "bug"
|
|
||||||
bugs_a.push dict
|
|
||||||
added = true
|
|
||||||
next
|
|
||||||
end
|
|
||||||
if label.name == "enhancement"
|
|
||||||
enhancement_a.push dict
|
|
||||||
added = true
|
|
||||||
next
|
|
||||||
end
|
|
||||||
}
|
|
||||||
unless added
|
|
||||||
issues_a.push dict
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
|
||||||
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
|
||||||
log += generate_sub_section(issues_a, @options[:issue_prefix])
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:pulls]
|
|
||||||
# Generate pull requests:
|
|
||||||
log += generate_sub_section(pull_requests, @options[:merge_prefix])
|
|
||||||
end
|
|
||||||
|
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param [Array] issues List of issues on sub-section
|
|
||||||
# @param [String] prefix Nae of sub-section
|
|
||||||
# @return [String] Generate ready-to-go sub-section
|
|
||||||
def generate_sub_section(issues, prefix)
|
|
||||||
log = ""
|
|
||||||
|
|
||||||
if options[:simple_list] != true && issues.any?
|
|
||||||
log += "#{prefix}\n\n"
|
|
||||||
end
|
|
||||||
|
|
||||||
if issues.any?
|
|
||||||
issues.each { |issue|
|
|
||||||
merge_string = @generator.get_string_for_issue(issue)
|
|
||||||
log += "- #{merge_string}\n\n"
|
|
||||||
}
|
|
||||||
end
|
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
# It generate one header for section with specific parameters.
|
|
||||||
#
|
|
||||||
# @param [String] newer_tag_name - name of newer tag
|
|
||||||
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
|
|
||||||
# @param [Time] newer_tag_time - time, when newer tag created
|
|
||||||
# @param [String] older_tag_link - tag name, used for links.
|
|
||||||
# @param [String] project_url - url for current project.
|
|
||||||
# @return [String] - Generate one ready-to-add section.
|
|
||||||
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
|
|
||||||
log = ""
|
|
||||||
|
|
||||||
# Generate date string:
|
|
||||||
time_string = newer_tag_time.strftime @options[:dateformat]
|
|
||||||
|
|
||||||
# Generate tag name and link
|
|
||||||
if newer_tag_name.equal? @options[:unreleased_label]
|
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
|
||||||
else
|
|
||||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
|
|
||||||
end
|
|
||||||
|
|
||||||
if @options[:compare_link] && older_tag_link
|
|
||||||
# Generate compare link
|
|
||||||
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
|
|
||||||
end
|
|
||||||
|
|
||||||
log
|
|
||||||
end
|
|
||||||
|
|
||||||
# Filter issues according labels
|
|
||||||
# @return [Array] Filtered issues
|
|
||||||
def get_filtered_issues
|
|
||||||
filtered_issues = include_issues_by_labels(@issues)
|
|
||||||
|
|
||||||
filtered_issues = exclude_issues_by_labels(filtered_issues)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Filtered issues: #{filtered_issues.count}"
|
|
||||||
end
|
|
||||||
|
|
||||||
filtered_issues
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetch event for issues and pull requests
|
|
||||||
# @return [Array] array of fetched issues
|
|
||||||
def fetch_event_for_issues_and_pr
|
|
||||||
if @options[:verbose]
|
|
||||||
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Async fetching events:
|
|
||||||
|
|
||||||
@fetcher.fetch_events_async(@issues + @pull_requests)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if __FILE__ == $PROGRAM_NAME
|
if __FILE__ == $PROGRAM_NAME
|
||||||
GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
|
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,11 +1,10 @@
|
|||||||
require "logger"
|
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
# A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
|
||||||
# (such as filtering, validating, e.t.c)
|
# (such as filtering, validating, e.t.c)
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
# fetcher = GitHubChangelogGenerator::Fetcher.new options
|
||||||
|
|
||||||
class Fetcher
|
class Fetcher
|
||||||
PER_PAGE_NUMBER = 30
|
PER_PAGE_NUMBER = 30
|
||||||
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
|
||||||
@@ -15,21 +14,14 @@ module GitHubChangelogGenerator
|
|||||||
"This script can make only 50 requests to GitHub API per hour without token!"
|
"This script can make only 50 requests to GitHub API per hour without token!"
|
||||||
|
|
||||||
def initialize(options = {})
|
def initialize(options = {})
|
||||||
@options = options
|
@options = options || {}
|
||||||
|
|
||||||
@logger = Logger.new(STDOUT)
|
|
||||||
@logger.formatter = proc do |_severity, _datetime, _progname, msg|
|
|
||||||
"#{msg}\n"
|
|
||||||
end
|
|
||||||
|
|
||||||
@user = @options[:user]
|
@user = @options[:user]
|
||||||
@project = @options[:project]
|
@project = @options[:project]
|
||||||
@github_token = fetch_github_token
|
@github_token = fetch_github_token
|
||||||
@tag_times_hash = {}
|
|
||||||
github_options = { per_page: PER_PAGE_NUMBER }
|
github_options = { per_page: PER_PAGE_NUMBER }
|
||||||
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||||
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
|
github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
||||||
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
|
github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
|
||||||
|
|
||||||
@github = check_github_response { Github.new github_options }
|
@github = check_github_response { Github.new github_options }
|
||||||
end
|
end
|
||||||
@@ -41,9 +33,7 @@ module GitHubChangelogGenerator
|
|||||||
def fetch_github_token
|
def fetch_github_token
|
||||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
|
||||||
|
|
||||||
unless env_var
|
Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
|
||||||
@logger.warn NO_TOKEN_PROVIDED.yellow
|
|
||||||
end
|
|
||||||
|
|
||||||
env_var
|
env_var
|
||||||
end
|
end
|
||||||
@@ -51,31 +41,30 @@ module GitHubChangelogGenerator
|
|||||||
# Fetch all tags from repo
|
# Fetch all tags from repo
|
||||||
# @return [Array] array of tags
|
# @return [Array] array of tags
|
||||||
def get_all_tags
|
def get_all_tags
|
||||||
if @options[:verbose]
|
print "Fetching tags...\r" if @options[:verbose]
|
||||||
print "Fetching tags...\r"
|
|
||||||
end
|
check_github_response { github_fetch_tags }
|
||||||
|
|
||||||
tags = []
|
|
||||||
|
|
||||||
check_github_response { github_fetch_tags(tags) }
|
|
||||||
|
|
||||||
tags
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This is wrapper with rescue block
|
||||||
|
# @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
|
||||||
def check_github_response
|
def check_github_response
|
||||||
begin
|
begin
|
||||||
value = yield
|
value = yield
|
||||||
rescue Github::Error::Unauthorized => e
|
rescue Github::Error::Unauthorized => e
|
||||||
@logger.error e.body.red
|
Helper.log.error e.body.red
|
||||||
abort "Error: wrong GitHub token"
|
abort "Error: wrong GitHub token"
|
||||||
rescue Github::Error::Forbidden => e
|
rescue Github::Error::Forbidden => e
|
||||||
@logger.warn e.body.red
|
Helper.log.warn e.body.red
|
||||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
value
|
value
|
||||||
end
|
end
|
||||||
|
|
||||||
def github_fetch_tags(tags)
|
# Fill input array with tags
|
||||||
|
# @return [Array] array of tags in repo
|
||||||
|
def github_fetch_tags
|
||||||
|
tags = []
|
||||||
response = @github.repos.tags @options[:user], @options[:project]
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
page_i = 0
|
page_i = 0
|
||||||
count_pages = response.count_pages
|
count_pages = response.count_pages
|
||||||
@@ -87,20 +76,19 @@ module GitHubChangelogGenerator
|
|||||||
print_empty_line
|
print_empty_line
|
||||||
|
|
||||||
if tags.count == 0
|
if tags.count == 0
|
||||||
@logger.warn "Warning: Can't find any tags in repo.\
|
Helper.log.warn "Warning: Can't find any tags in repo.\
|
||||||
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||||
else
|
else
|
||||||
@logger.info "Found #{tags.count} tags"
|
Helper.log.info "Found #{tags.count} tags"
|
||||||
end
|
end
|
||||||
|
tags
|
||||||
end
|
end
|
||||||
|
|
||||||
# This method fetch all closed issues and separate them to pull requests and pure issues
|
# 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)
|
# (pull request is kind of issue in term of GitHub)
|
||||||
# @return [Tuple] with (issues, pull-requests)
|
# @return [Tuple] with (issues, pull-requests)
|
||||||
def fetch_closed_issues_and_pr
|
def fetch_closed_issues_and_pr
|
||||||
if @options[:verbose]
|
print "Fetching closed issues...\r" if @options[:verbose]
|
||||||
print "Fetching closed issues...\r"
|
|
||||||
end
|
|
||||||
issues = []
|
issues = []
|
||||||
|
|
||||||
begin
|
begin
|
||||||
@@ -118,10 +106,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
break if @options[:max_issues] && issues.length >= @options[:max_issues]
|
||||||
end
|
end
|
||||||
print_empty_line
|
print_empty_line
|
||||||
@logger.info "Received issues: #{issues.count}"
|
Helper.log.info "Received issues: #{issues.count}"
|
||||||
|
|
||||||
rescue
|
rescue
|
||||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
|
|
||||||
# separate arrays of issues and pull requests:
|
# separate arrays of issues and pull requests:
|
||||||
@@ -146,17 +134,20 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
end
|
end
|
||||||
print_empty_line
|
print_empty_line
|
||||||
rescue
|
rescue
|
||||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
|
|
||||||
@logger.info "Fetching merged dates: #{pull_requests.count}"
|
Helper.log.info "Fetching merged dates: #{pull_requests.count}"
|
||||||
pull_requests
|
pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Print specified line on the same string
|
||||||
|
# @param [String] log_string
|
||||||
def print_in_same_line(log_string)
|
def print_in_same_line(log_string)
|
||||||
print log_string + "\r"
|
print log_string + "\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Print long line with spaces on same line to clear prev message
|
||||||
def print_empty_line
|
def print_empty_line
|
||||||
print_in_same_line(" ")
|
print_in_same_line(" ")
|
||||||
end
|
end
|
||||||
@@ -175,10 +166,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
obj = @github.issues.events.list user: @options[:user],
|
obj = @github.issues.events.list user: @options[:user],
|
||||||
repo: @options[:project],
|
repo: @options[:project],
|
||||||
issue_number: issue["number"]
|
issue_number: issue["number"]
|
||||||
rescue
|
|
||||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
|
||||||
end
|
|
||||||
issue[:events] = obj.body
|
issue[:events] = obj.body
|
||||||
|
rescue
|
||||||
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
|
end
|
||||||
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
|
||||||
i += 1
|
i += 1
|
||||||
end
|
end
|
||||||
@@ -190,32 +181,26 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
|||||||
# to clear line from prev print
|
# to clear line from prev print
|
||||||
print_empty_line
|
print_empty_line
|
||||||
|
|
||||||
@logger.info "Fetching events for issues and PR: #{i}"
|
Helper.log.info "Fetching events for issues and PR: #{i}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Try to find tag date in local hash.
|
# Fetch tag time from repo
|
||||||
# Otherwise fFetch tag time and put it to local hash file.
|
#
|
||||||
# @param [String] tag_name name of the tag
|
# @param [Hash] tag
|
||||||
# @return [Time] time of specified tag
|
# @return [Time] time of specified tag
|
||||||
def get_time_of_tag(tag_name)
|
def fetch_date_of_tag(tag)
|
||||||
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
|
begin
|
||||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user],
|
commit_data = @github.git_data.commits.get @options[:user],
|
||||||
@options[:project],
|
@options[:project],
|
||||||
tag_name["commit"]["sha"]
|
tag["commit"]["sha"]
|
||||||
rescue
|
rescue
|
||||||
@logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||||
end
|
end
|
||||||
time_string = github_git_data_commits_get["committer"]["date"]
|
time_string = commit_data["committer"]["date"]
|
||||||
@tag_times_hash[tag_name["name"]] = Time.parse(time_string)
|
Time.parse(time_string)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fetch commit for specifed event
|
# Fetch commit for specified event
|
||||||
# @return [Hash]
|
# @return [Hash]
|
||||||
def fetch_commit(event)
|
def fetch_commit(event)
|
||||||
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
@github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
module GitHubChangelogGenerator
|
|
||||||
class Generator
|
|
||||||
def initialize(options = nil)
|
|
||||||
@options = options
|
|
||||||
end
|
|
||||||
|
|
||||||
# Parse issue and generate single line formatted issue line.
|
|
||||||
#
|
|
||||||
# Example output:
|
|
||||||
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
|
||||||
#
|
|
||||||
# @param [Hash] issue Fetched issue from GitHub
|
|
||||||
# @return [String] Markdown-formatted single issue
|
|
||||||
def get_string_for_issue(issue)
|
|
||||||
encapsulated_title = encapsulate_string issue[:title]
|
|
||||||
|
|
||||||
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
|
||||||
|
|
||||||
unless issue.pull_request.nil?
|
|
||||||
if @options[:author]
|
|
||||||
if issue.user.nil?
|
|
||||||
title_with_number += " ({Null user})"
|
|
||||||
else
|
|
||||||
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
title_with_number
|
|
||||||
end
|
|
||||||
|
|
||||||
def encapsulate_string(string)
|
|
||||||
string.gsub! '\\', '\\\\'
|
|
||||||
|
|
||||||
encpas_chars = %w(> * _ \( \) [ ] #)
|
|
||||||
encpas_chars.each do |char|
|
|
||||||
string.gsub! char, "\\#{char}"
|
|
||||||
end
|
|
||||||
|
|
||||||
string
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
123
lib/github_changelog_generator/generator/generator.rb
Normal file
123
lib/github_changelog_generator/generator/generator.rb
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
require_relative "../fetcher"
|
||||||
|
require_relative "generator_generation"
|
||||||
|
require_relative "generator_fetcher"
|
||||||
|
require_relative "generator_processor"
|
||||||
|
require_relative "generator_tags"
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
# Default error for ChangelogGenerator
|
||||||
|
class ChangelogGeneratorError < StandardError
|
||||||
|
end
|
||||||
|
|
||||||
|
class Generator
|
||||||
|
attr_accessor :options, :filtered_tags, :github
|
||||||
|
|
||||||
|
# A Generator responsible for all logic, related with change log generation from ready-to-parse issues
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# generator = GitHubChangelogGenerator::Generator.new
|
||||||
|
# content = generator.compound_changelog
|
||||||
|
def initialize(options = nil)
|
||||||
|
@options = options || {}
|
||||||
|
@tag_times_hash = {}
|
||||||
|
@fetcher = GitHubChangelogGenerator::Fetcher.new @options
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_issues_and_pr
|
||||||
|
issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
|
||||||
|
|
||||||
|
@pull_requests = @options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
|
||||||
|
|
||||||
|
@issues = @options[:issues] ? get_filtered_issues(issues) : []
|
||||||
|
|
||||||
|
fetch_events_for_issues_and_pr
|
||||||
|
detect_actual_closed_dates(@issues + @pull_requests)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Encapsulate characters to make markdown look as expected.
|
||||||
|
#
|
||||||
|
# @param [String] string
|
||||||
|
# @return [String] encapsulated input string
|
||||||
|
def encapsulate_string(string)
|
||||||
|
string.gsub! '\\', '\\\\'
|
||||||
|
|
||||||
|
encpas_chars = %w(< > * _ \( \) [ ] #)
|
||||||
|
encpas_chars.each do |char|
|
||||||
|
string.gsub! char, "\\#{char}"
|
||||||
|
end
|
||||||
|
|
||||||
|
string
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generates log for section with header and body
|
||||||
|
#
|
||||||
|
# @param [Array] pull_requests List or PR's in new section
|
||||||
|
# @param [Array] issues List of issues in new section
|
||||||
|
# @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
|
||||||
|
# @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
|
||||||
|
# @return [String] Ready and parsed section
|
||||||
|
def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
|
||||||
|
newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
|
||||||
|
|
||||||
|
github_site = options[:github_site] || "https://github.com"
|
||||||
|
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||||
|
|
||||||
|
log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
||||||
|
|
||||||
|
if @options[:issues]
|
||||||
|
# Generate issues:
|
||||||
|
log += issues_to_log(issues)
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:pulls]
|
||||||
|
# Generate pull requests:
|
||||||
|
log += generate_sub_section(pull_requests, @options[:merge_prefix])
|
||||||
|
end
|
||||||
|
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generate ready-to-paste log from list of issues.
|
||||||
|
#
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [String] generated log for issues
|
||||||
|
def issues_to_log(issues)
|
||||||
|
log = ""
|
||||||
|
bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
|
||||||
|
|
||||||
|
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||||
|
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||||
|
log += generate_sub_section(issues_a, @options[:issue_prefix])
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# This method sort issues by types
|
||||||
|
# (bugs, features, or just closed issues) by labels
|
||||||
|
#
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
||||||
|
def parse_by_sections(issues)
|
||||||
|
issues_a = []
|
||||||
|
enhancement_a = []
|
||||||
|
bugs_a = []
|
||||||
|
|
||||||
|
issues.each do |dict|
|
||||||
|
added = false
|
||||||
|
dict.labels.each do |label|
|
||||||
|
if @options[:bug_labels].include? label.name
|
||||||
|
bugs_a.push dict
|
||||||
|
added = true
|
||||||
|
next
|
||||||
|
end
|
||||||
|
if @options[:enhancement_labels].include? label.name
|
||||||
|
enhancement_a.push dict
|
||||||
|
added = true
|
||||||
|
next
|
||||||
|
end
|
||||||
|
end
|
||||||
|
issues_a.push dict unless added
|
||||||
|
end
|
||||||
|
[bugs_a, enhancement_a, issues_a]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
class Generator
|
||||||
|
# Fetch event for issues and pull requests
|
||||||
|
# @return [Array] array of fetched issues
|
||||||
|
def fetch_events_for_issues_and_pr
|
||||||
|
if @options[:verbose]
|
||||||
|
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Async fetching events:
|
||||||
|
@fetcher.fetch_events_async(@issues + @pull_requests)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Async fetching of all tags dates
|
||||||
|
def fetch_tags_dates
|
||||||
|
print "Fetching tag dates...\r" if @options[:verbose]
|
||||||
|
# Async fetching tags:
|
||||||
|
threads = []
|
||||||
|
i = 0
|
||||||
|
all = @filtered_tags.count
|
||||||
|
@filtered_tags.each do |tag|
|
||||||
|
print " \r"
|
||||||
|
threads << Thread.new do
|
||||||
|
get_time_of_tag(tag)
|
||||||
|
print "Fetching tags dates: #{i + 1}/#{all}\r" if @options[:verbose]
|
||||||
|
i += 1
|
||||||
|
end
|
||||||
|
end
|
||||||
|
threads.each(&:join)
|
||||||
|
puts "Fetching tags dates: #{i}" if @options[:verbose]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Find correct closed dates, if issues was closed by commits
|
||||||
|
def detect_actual_closed_dates(issues)
|
||||||
|
print "Fetching closed dates for issues...\r" if @options[:verbose]
|
||||||
|
|
||||||
|
max_thread_number = 50
|
||||||
|
issues.each_slice(max_thread_number) do |issues_slice|
|
||||||
|
threads = []
|
||||||
|
issues_slice.each do |issue|
|
||||||
|
threads << Thread.new { find_closed_date_by_commit(issue) }
|
||||||
|
end
|
||||||
|
threads.each(&:join)
|
||||||
|
end
|
||||||
|
puts "Fetching closed dates for issues: Done!" if @options[:verbose]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
|
||||||
|
# @param [Hash] issue
|
||||||
|
def find_closed_date_by_commit(issue)
|
||||||
|
unless issue["events"].nil?
|
||||||
|
# if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
||||||
|
compare_string = issue[:merged_at].nil? ? "closed" : "merged"
|
||||||
|
# reverse! - to find latest closed event. (event goes in date order)
|
||||||
|
issue["events"].reverse!.each do |event|
|
||||||
|
if event[:event].eql? compare_string
|
||||||
|
set_date_from_event(event, issue)
|
||||||
|
break
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
# TODO: assert issues, that remain without 'actual_date' hash for some reason.
|
||||||
|
end
|
||||||
|
|
||||||
|
# Set closed date from this issue
|
||||||
|
#
|
||||||
|
# @param [Hash] event
|
||||||
|
# @param [Hash] issue
|
||||||
|
def set_date_from_event(event, issue)
|
||||||
|
if event[:commit_id].nil?
|
||||||
|
issue[:actual_date] = issue[:closed_at]
|
||||||
|
else
|
||||||
|
begin
|
||||||
|
commit = @fetcher.fetch_commit(event)
|
||||||
|
issue[:actual_date] = commit[:author][:date]
|
||||||
|
rescue
|
||||||
|
puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
|
||||||
|
issue[:actual_date] = issue[:closed_at]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
176
lib/github_changelog_generator/generator/generator_generation.rb
Normal file
176
lib/github_changelog_generator/generator/generator_generation.rb
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
class Generator
|
||||||
|
# Main function to start change log generation
|
||||||
|
#
|
||||||
|
# @return [String] Generated change log file
|
||||||
|
def compound_changelog
|
||||||
|
fetch_and_filter_tags
|
||||||
|
sort_tags_by_date(@filtered_tags)
|
||||||
|
fetch_issues_and_pr
|
||||||
|
|
||||||
|
log = "#{@options[:header]}\n\n"
|
||||||
|
|
||||||
|
if @options[:unreleased_only]
|
||||||
|
log += generate_log_between_tags(filtered_tags[0], nil)
|
||||||
|
else
|
||||||
|
log += generate_log_for_all_tags
|
||||||
|
end
|
||||||
|
|
||||||
|
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||||
|
@log = log
|
||||||
|
end
|
||||||
|
|
||||||
|
# @return [String] temp method should be removed soon
|
||||||
|
def generate_for_2_tags(log)
|
||||||
|
tag1 = @options[:tag1]
|
||||||
|
tag2 = @options[:tag2]
|
||||||
|
tags_strings = []
|
||||||
|
filtered_tags.each { |x| tags_strings.push(x["name"]) }
|
||||||
|
|
||||||
|
if tags_strings.include?(tag1)
|
||||||
|
if tags_strings.include?(tag2)
|
||||||
|
to_a = tags_strings.map.with_index.to_a
|
||||||
|
hash = Hash[to_a]
|
||||||
|
index1 = hash[tag1]
|
||||||
|
index2 = hash[tag2]
|
||||||
|
log += generate_log_between_tags(all_tags[index1], all_tags[index2])
|
||||||
|
else
|
||||||
|
fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
|
||||||
|
end
|
||||||
|
else
|
||||||
|
fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
|
||||||
|
end
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# @param [Array] issues List of issues on sub-section
|
||||||
|
# @param [String] prefix Nae of sub-section
|
||||||
|
# @return [String] Generate ready-to-go sub-section
|
||||||
|
def generate_sub_section(issues, prefix)
|
||||||
|
log = ""
|
||||||
|
|
||||||
|
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
|
||||||
|
|
||||||
|
if issues.any?
|
||||||
|
issues.each do |issue|
|
||||||
|
merge_string = get_string_for_issue(issue)
|
||||||
|
log += "- #{merge_string}\n"
|
||||||
|
end
|
||||||
|
log += "\n"
|
||||||
|
end
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# It generate one header for section with specific parameters.
|
||||||
|
#
|
||||||
|
# @param [String] newer_tag_name - name of newer tag
|
||||||
|
# @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
|
||||||
|
# @param [Time] newer_tag_time - time, when newer tag created
|
||||||
|
# @param [String] older_tag_link - tag name, used for links.
|
||||||
|
# @param [String] project_url - url for current project.
|
||||||
|
# @return [String] - Generate one ready-to-add section.
|
||||||
|
def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
|
||||||
|
log = ""
|
||||||
|
|
||||||
|
# Generate date string:
|
||||||
|
time_string = newer_tag_time.strftime @options[:date_format]
|
||||||
|
|
||||||
|
# Generate tag name and link
|
||||||
|
if newer_tag_name.equal? @options[:unreleased_label]
|
||||||
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
|
||||||
|
else
|
||||||
|
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n"
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:compare_link] && older_tag_link
|
||||||
|
# Generate compare link
|
||||||
|
log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
|
||||||
|
end
|
||||||
|
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generate log only between 2 specified tags
|
||||||
|
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||||
|
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||||
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
|
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
||||||
|
|
||||||
|
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
||||||
|
|
||||||
|
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
||||||
|
# do not generate empty unreleased section
|
||||||
|
return ""
|
||||||
|
end
|
||||||
|
|
||||||
|
create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Apply all filters to issues and pull requests
|
||||||
|
#
|
||||||
|
# @return [Array] filtered issues and pull requests
|
||||||
|
def filter_issues_for_tags(newer_tag, older_tag)
|
||||||
|
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
|
||||||
|
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
|
||||||
|
|
||||||
|
newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
|
||||||
|
|
||||||
|
if @options[:filter_issues_by_milestone]
|
||||||
|
# delete excess irrelevant issues (according milestones). Issue #22.
|
||||||
|
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
||||||
|
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
||||||
|
end
|
||||||
|
[filtered_issues, filtered_pull_requests]
|
||||||
|
end
|
||||||
|
|
||||||
|
# The full cycle of generation for whole project
|
||||||
|
# @return [String] The complete change log
|
||||||
|
def generate_log_for_all_tags
|
||||||
|
puts "Generating log..." if @options[:verbose]
|
||||||
|
|
||||||
|
log = generate_unreleased_section
|
||||||
|
|
||||||
|
(1...filtered_tags.size).each do |index|
|
||||||
|
log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
|
||||||
|
end
|
||||||
|
if @filtered_tags.count != 0
|
||||||
|
log += generate_log_between_tags(nil, filtered_tags.last)
|
||||||
|
end
|
||||||
|
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
def generate_unreleased_section
|
||||||
|
log = ""
|
||||||
|
if @options[:unreleased]
|
||||||
|
unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
|
||||||
|
log += unreleased_log if unreleased_log
|
||||||
|
end
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
# Parse issue and generate single line formatted issue line.
|
||||||
|
#
|
||||||
|
# Example output:
|
||||||
|
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
|
||||||
|
#
|
||||||
|
# @param [Hash] issue Fetched issue from GitHub
|
||||||
|
# @return [String] Markdown-formatted single issue
|
||||||
|
def get_string_for_issue(issue)
|
||||||
|
encapsulated_title = encapsulate_string issue[:title]
|
||||||
|
|
||||||
|
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
||||||
|
|
||||||
|
unless issue.pull_request.nil?
|
||||||
|
if @options[:author]
|
||||||
|
if issue.user.nil?
|
||||||
|
title_with_number += " ({Null user})"
|
||||||
|
else
|
||||||
|
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
title_with_number
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
192
lib/github_changelog_generator/generator/generator_processor.rb
Normal file
192
lib/github_changelog_generator/generator/generator_processor.rb
Normal file
@@ -0,0 +1,192 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
class Generator
|
||||||
|
# delete all labels with labels from @options[:exclude_labels] array
|
||||||
|
# @param [Array] issues
|
||||||
|
# @return [Array] filtered array
|
||||||
|
def exclude_issues_by_labels(issues)
|
||||||
|
unless @options[:exclude_labels].nil?
|
||||||
|
issues = issues.select do |issue|
|
||||||
|
var = issue.labels.map(&:name) & @options[:exclude_labels]
|
||||||
|
!(var).any?
|
||||||
|
end
|
||||||
|
end
|
||||||
|
issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# @return [Array] filtered issues accourding milestone
|
||||||
|
def filter_by_milestone(filtered_issues, tag_name, all_issues)
|
||||||
|
remove_issues_in_milestones(filtered_issues)
|
||||||
|
unless tag_name.nil?
|
||||||
|
# add missed issues (according milestones)
|
||||||
|
issues_to_add = find_issues_to_add(all_issues, tag_name)
|
||||||
|
|
||||||
|
filtered_issues |= issues_to_add
|
||||||
|
end
|
||||||
|
filtered_issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# Add all issues, that should be in that tag, according milestone
|
||||||
|
#
|
||||||
|
# @param [Array] all_issues
|
||||||
|
# @param [String] tag_name
|
||||||
|
# @return [Array] issues with milestone #tag_name
|
||||||
|
def find_issues_to_add(all_issues, tag_name)
|
||||||
|
all_issues.select do |issue|
|
||||||
|
if issue.milestone.nil?
|
||||||
|
false
|
||||||
|
else
|
||||||
|
# check, that this milestone in tag list:
|
||||||
|
milestone_is_tag = @filtered_tags.find do |tag|
|
||||||
|
tag.name == issue.milestone.title
|
||||||
|
end
|
||||||
|
|
||||||
|
if milestone_is_tag.nil?
|
||||||
|
false
|
||||||
|
else
|
||||||
|
issue.milestone.title == tag_name
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# @return [Array] array with removed issues, that contain milestones with same name as a tag
|
||||||
|
def remove_issues_in_milestones(filtered_issues)
|
||||||
|
filtered_issues.select! do |issue|
|
||||||
|
# leave issues without milestones
|
||||||
|
if issue.milestone.nil?
|
||||||
|
true
|
||||||
|
else
|
||||||
|
# check, that this milestone in tag list:
|
||||||
|
@filtered_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Method filter issues, that belong only specified tag range
|
||||||
|
# @param [Array] array of issues to filter
|
||||||
|
# @param [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)
|
||||||
|
# in case if not tags specified - return unchanged array
|
||||||
|
return array if older_tag.nil? && newer_tag.nil?
|
||||||
|
|
||||||
|
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
||||||
|
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
||||||
|
|
||||||
|
array.select do |req|
|
||||||
|
if req[hash_key]
|
||||||
|
time = Time.parse(req[hash_key]).utc
|
||||||
|
|
||||||
|
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
||||||
|
|
||||||
|
tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
|
||||||
|
|
||||||
|
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||||
|
|
||||||
|
tag_in_range
|
||||||
|
else
|
||||||
|
false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def tag_older_new_tag?(newer_tag_time, time)
|
||||||
|
if newer_tag_time.nil?
|
||||||
|
tag_in_range_new = true
|
||||||
|
else
|
||||||
|
tag_in_range_new = time <= newer_tag_time
|
||||||
|
end
|
||||||
|
tag_in_range_new
|
||||||
|
end
|
||||||
|
|
||||||
|
def tag_newer_old_tag?(older_tag_time, t)
|
||||||
|
if older_tag_time.nil?
|
||||||
|
tag_in_range_old = true
|
||||||
|
else
|
||||||
|
tag_in_range_old = t > older_tag_time
|
||||||
|
end
|
||||||
|
tag_in_range_old
|
||||||
|
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 = filter_by_include_labels(issues)
|
||||||
|
filtered_issues |= filter_wo_labels(issues)
|
||||||
|
filtered_issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# @return [Array] issues without labels or empty array if add_issues_wo_labels is false
|
||||||
|
def filter_wo_labels(issues)
|
||||||
|
if @options[:add_issues_wo_labels]
|
||||||
|
issues_wo_labels = issues.select do |issue|
|
||||||
|
!issue.labels.map(&:name).any?
|
||||||
|
end
|
||||||
|
return issues_wo_labels
|
||||||
|
end
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
|
||||||
|
def filter_by_include_labels(issues)
|
||||||
|
filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
|
||||||
|
labels = issue.labels.map(&:name) & @options[:include_labels]
|
||||||
|
(labels).any?
|
||||||
|
end
|
||||||
|
filtered_issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# General filtered function
|
||||||
|
#
|
||||||
|
# @param [Array] all_issues
|
||||||
|
# @return [Array] filtered issues
|
||||||
|
def filter_array_by_labels(all_issues)
|
||||||
|
filtered_issues = include_issues_by_labels(all_issues)
|
||||||
|
exclude_issues_by_labels(filtered_issues)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Filter issues according labels
|
||||||
|
# @return [Array] Filtered issues
|
||||||
|
def get_filtered_issues(issues)
|
||||||
|
issues = filter_array_by_labels(issues)
|
||||||
|
puts "Filtered issues: #{issues.count}" if @options[:verbose]
|
||||||
|
issues
|
||||||
|
end
|
||||||
|
|
||||||
|
# This method fetches missing params for PR and filter them by specified options
|
||||||
|
# It include add all PR's with labels from @options[:include_labels] array
|
||||||
|
# And exclude all from :exclude_labels array.
|
||||||
|
# @return [Array] filtered PR's
|
||||||
|
def get_filtered_pull_requests(pull_requests)
|
||||||
|
pull_requests = filter_array_by_labels(pull_requests)
|
||||||
|
pull_requests = filter_merged_pull_requests(pull_requests)
|
||||||
|
puts "Filtered pull requests: #{pull_requests.count}" if @options[:verbose]
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
# This method filter only merged PR and
|
||||||
|
# fetch missing required attributes for pull requests
|
||||||
|
# :merged_at - is a date, when issue PR was merged.
|
||||||
|
# More correct to use merged date, rather than closed date.
|
||||||
|
def filter_merged_pull_requests(pull_requests)
|
||||||
|
print "Fetching merged dates...\r" if @options[:verbose]
|
||||||
|
closed_pull_requests = @fetcher.fetch_closed_pull_requests
|
||||||
|
|
||||||
|
pull_requests.each do |pr|
|
||||||
|
fetched_pr = closed_pull_requests.find do |fpr|
|
||||||
|
fpr.number == pr.number
|
||||||
|
end
|
||||||
|
pr[:merged_at] = fetched_pr[:merged_at]
|
||||||
|
closed_pull_requests.delete(fetched_pr)
|
||||||
|
end
|
||||||
|
|
||||||
|
pull_requests.select! do |pr|
|
||||||
|
!pr[:merged_at].nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
89
lib/github_changelog_generator/generator/generator_tags.rb
Normal file
89
lib/github_changelog_generator/generator/generator_tags.rb
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
class Generator
|
||||||
|
# fetch, filter tags, fetch dates and sort them in time order
|
||||||
|
def fetch_and_filter_tags
|
||||||
|
@filtered_tags = get_filtered_tags(@fetcher.get_all_tags)
|
||||||
|
fetch_tags_dates
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sort all tags by date
|
||||||
|
def sort_tags_by_date(tags)
|
||||||
|
puts "Sorting tags..." if @options[:verbose]
|
||||||
|
tags.sort_by! do |x|
|
||||||
|
get_time_of_tag(x)
|
||||||
|
end.reverse!
|
||||||
|
end
|
||||||
|
|
||||||
|
# Try to find tag date in local hash.
|
||||||
|
# Otherwise fFetch tag time and put it to local hash file.
|
||||||
|
# @param [Hash] 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?
|
||||||
|
|
||||||
|
name_of_tag = tag_name["name"]
|
||||||
|
time_for_name = @tag_times_hash[name_of_tag]
|
||||||
|
if !time_for_name.nil?
|
||||||
|
time_for_name
|
||||||
|
else
|
||||||
|
time_string = @fetcher.fetch_date_of_tag tag_name
|
||||||
|
@tag_times_hash[name_of_tag] = time_string
|
||||||
|
time_string
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Detect link, name and time for specified tag.
|
||||||
|
#
|
||||||
|
# @param [Hash] newer_tag newer tag. Can be nil, if it's Unreleased section.
|
||||||
|
# @return [Array] link, name and time of the tag
|
||||||
|
def detect_link_tag_time(newer_tag)
|
||||||
|
# if tag is nil - set current time
|
||||||
|
newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
|
||||||
|
|
||||||
|
# if it's future release tag - set this value
|
||||||
|
if newer_tag.nil? && @options[:future_release]
|
||||||
|
newer_tag_name = @options[:future_release]
|
||||||
|
newer_tag_link = @options[:future_release]
|
||||||
|
else
|
||||||
|
# put unreleased label if there is no name for the tag
|
||||||
|
newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
|
||||||
|
newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
|
||||||
|
end
|
||||||
|
[newer_tag_link, newer_tag_name, newer_tag_time]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
|
||||||
|
#
|
||||||
|
# @return [Array]
|
||||||
|
def get_filtered_tags(all_tags)
|
||||||
|
filtered_tags = filter_between_tags(all_tags)
|
||||||
|
filter_excluded_tags(filtered_tags)
|
||||||
|
end
|
||||||
|
|
||||||
|
def filter_between_tags(all_tags)
|
||||||
|
filtered_tags = all_tags
|
||||||
|
if @options[:between_tags]
|
||||||
|
@options[:between_tags].each do |tag|
|
||||||
|
unless all_tags.map(&:name).include? tag
|
||||||
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
|
||||||
|
end
|
||||||
|
end
|
||||||
|
filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag.name }
|
||||||
|
end
|
||||||
|
filtered_tags
|
||||||
|
end
|
||||||
|
|
||||||
|
def filter_excluded_tags(all_tags)
|
||||||
|
filtered_tags = all_tags
|
||||||
|
if @options[:exclude_tags]
|
||||||
|
@options[:exclude_tags].each do |tag|
|
||||||
|
unless all_tags.map(&:name).include? tag
|
||||||
|
Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
|
||||||
|
end
|
||||||
|
end
|
||||||
|
filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
||||||
|
end
|
||||||
|
filtered_tags
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
37
lib/github_changelog_generator/helper.rb
Normal file
37
lib/github_changelog_generator/helper.rb
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
require "logger"
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
module Helper
|
||||||
|
# @return true if the currently running program is a unit test
|
||||||
|
def self.test?
|
||||||
|
defined?SpecHelper
|
||||||
|
end
|
||||||
|
|
||||||
|
if test?
|
||||||
|
@log ||= Logger.new(nil) # don't show any logs when running tests
|
||||||
|
else
|
||||||
|
@log ||= Logger.new(STDOUT)
|
||||||
|
end
|
||||||
|
@log.formatter = proc do |severity, _datetime, _progname, msg|
|
||||||
|
string = "#{msg}\n"
|
||||||
|
|
||||||
|
if severity == "DEBUG"
|
||||||
|
string = string.magenta
|
||||||
|
elsif severity == "INFO"
|
||||||
|
string = string.white
|
||||||
|
elsif severity == "WARN"
|
||||||
|
string = string.yellow
|
||||||
|
elsif severity == "ERROR"
|
||||||
|
string = string.red
|
||||||
|
elsif severity == "FATAL"
|
||||||
|
string = string.red.bold
|
||||||
|
end
|
||||||
|
|
||||||
|
string
|
||||||
|
end
|
||||||
|
|
||||||
|
# Logging happens using this method
|
||||||
|
class << self
|
||||||
|
attr_reader :log
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -2,37 +2,37 @@
|
|||||||
require "optparse"
|
require "optparse"
|
||||||
require "pp"
|
require "pp"
|
||||||
require_relative "version"
|
require_relative "version"
|
||||||
|
require_relative "helper"
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Parser
|
class Parser
|
||||||
|
# parse options with optparse
|
||||||
def self.parse_options
|
def self.parse_options
|
||||||
options = {
|
options = get_default_options
|
||||||
tag1: nil,
|
|
||||||
tag2: nil,
|
|
||||||
dateformat: "%Y-%m-%d",
|
|
||||||
output: "CHANGELOG.md",
|
|
||||||
issues: true,
|
|
||||||
add_issues_wo_labels: true,
|
|
||||||
add_pr_wo_labels: true,
|
|
||||||
pulls: true,
|
|
||||||
filter_issues_by_milestone: true,
|
|
||||||
author: true,
|
|
||||||
unreleased: true,
|
|
||||||
unreleased_label: "Unreleased",
|
|
||||||
compare_link: true,
|
|
||||||
include_labels: %w(bug enhancement),
|
|
||||||
exclude_labels: %w(duplicate question invalid wontfix),
|
|
||||||
max_issues: nil,
|
|
||||||
simple_list: false,
|
|
||||||
verbose: true,
|
|
||||||
|
|
||||||
merge_prefix: "**Merged pull requests:**",
|
parser = setup_parser(options)
|
||||||
issue_prefix: "**Closed issues:**",
|
|
||||||
bug_prefix: "**Fixed bugs:**",
|
|
||||||
enhancement_prefix: "**Implemented enhancements:**",
|
|
||||||
branch: "origin"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
parser.parse!
|
||||||
|
|
||||||
|
if options[:user].nil? || options[:project].nil?
|
||||||
|
detect_user_and_project(options)
|
||||||
|
end
|
||||||
|
|
||||||
|
if !options[:user] || !options[:project]
|
||||||
|
puts parser.banner
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
if options[:verbose]
|
||||||
|
Helper.log.info "Performing task with options:"
|
||||||
|
pp options
|
||||||
|
puts ""
|
||||||
|
end
|
||||||
|
|
||||||
|
options
|
||||||
|
end
|
||||||
|
|
||||||
|
# setup parsing options
|
||||||
|
def self.setup_parser(options)
|
||||||
parser = OptionParser.new do |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|
|
||||||
@@ -45,11 +45,26 @@ module GitHubChangelogGenerator
|
|||||||
options[:token] = last
|
options[:token] = last
|
||||||
end
|
end
|
||||||
opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
|
opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
|
||||||
options[:dateformat] = last
|
options[:date_format] = 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("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
||||||
|
options[:bug_prefix] = v
|
||||||
|
end
|
||||||
|
opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
|
||||||
|
options[:enhancement_prefix] = v
|
||||||
|
end
|
||||||
|
opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
|
||||||
|
options[:issue_prefix] = v
|
||||||
|
end
|
||||||
|
opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
|
||||||
|
options[:header] = v
|
||||||
|
end
|
||||||
|
opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
|
||||||
|
options[:merge_prefix] = v
|
||||||
|
end
|
||||||
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
|
||||||
options[:issues] = v
|
options[:issues] = v
|
||||||
end
|
end
|
||||||
@@ -80,12 +95,24 @@ module GitHubChangelogGenerator
|
|||||||
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, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
|
opts.on("--include-labels x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
|
||||||
options[:include_labels] = list
|
options[:include_labels] = list
|
||||||
end
|
end
|
||||||
opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
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("--bug-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
|
||||||
|
options[:bug_labels] = list
|
||||||
|
end
|
||||||
|
opts.on("--enhancement-labels x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
|
||||||
|
options[:enhancement_labels] = list
|
||||||
|
end
|
||||||
|
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
||||||
|
options[:between_tags] = list
|
||||||
|
end
|
||||||
|
opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list|
|
||||||
|
options[:exclude_tags] = list
|
||||||
|
end
|
||||||
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||||
options[:max_issues] = max
|
options[:max_issues] = max
|
||||||
end
|
end
|
||||||
@@ -113,79 +140,122 @@ module GitHubChangelogGenerator
|
|||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
parser
|
||||||
parser.parse!
|
|
||||||
|
|
||||||
detect_user_and_project(options)
|
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
|
||||||
puts parser.banner
|
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if ARGV[1]
|
# just get default options
|
||||||
options[:tag1] = ARGV[0]
|
def self.get_default_options
|
||||||
options[:tag2] = ARGV[1]
|
options = {
|
||||||
end
|
tag1: nil,
|
||||||
|
tag2: nil,
|
||||||
if options[:verbose]
|
date_format: "%Y-%m-%d",
|
||||||
puts "Performing task with options:"
|
output: "CHANGELOG.md",
|
||||||
pp options
|
issues: true,
|
||||||
puts ""
|
add_issues_wo_labels: true,
|
||||||
end
|
add_pr_wo_labels: true,
|
||||||
|
pulls: true,
|
||||||
|
filter_issues_by_milestone: true,
|
||||||
|
author: true,
|
||||||
|
unreleased: true,
|
||||||
|
unreleased_label: "Unreleased",
|
||||||
|
compare_link: true,
|
||||||
|
enhancement_labels: %w(enhancement Enhancement),
|
||||||
|
bug_labels: %w(bug Bug),
|
||||||
|
exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
|
||||||
|
max_issues: nil,
|
||||||
|
simple_list: false,
|
||||||
|
verbose: true,
|
||||||
|
header: "# Change Log",
|
||||||
|
merge_prefix: "**Merged pull requests:**",
|
||||||
|
issue_prefix: "**Closed issues:**",
|
||||||
|
bug_prefix: "**Fixed bugs:**",
|
||||||
|
enhancement_prefix: "**Implemented enhancements:**",
|
||||||
|
git_remote: "origin"
|
||||||
|
}
|
||||||
|
|
||||||
options
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Detects user and project from git
|
||||||
def self.detect_user_and_project(options)
|
def self.detect_user_and_project(options)
|
||||||
if ARGV[0] && !ARGV[1]
|
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
|
||||||
github_site = options[:github_site] ? options[:github_site] : "github.com"
|
if !options[:user] || !options[:project]
|
||||||
|
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||||
|
options[:user] = "skywinder"
|
||||||
|
options[:project] = "changelog_test"
|
||||||
|
else
|
||||||
|
remote = `git config --get remote.#{options[:git_remote]}.url`
|
||||||
|
options[:user], options[:project] = user_project_from_remote(remote)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Try to find user and project name from git remote output
|
||||||
|
#
|
||||||
|
# @param [String] output of git remote command
|
||||||
|
# @return [Array] user and project
|
||||||
|
def self.user_project_from_option(arg0, arg1, github_site = nil)
|
||||||
|
user = nil
|
||||||
|
project = nil
|
||||||
|
github_site ||= "github.com"
|
||||||
|
if arg0 && !arg1
|
||||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
# 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])
|
puts arg0
|
||||||
|
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
|
||||||
|
|
||||||
begin
|
begin
|
||||||
param = match[2].nil?
|
param = match[2].nil?
|
||||||
rescue
|
rescue
|
||||||
puts "Can't detect user and name from first parameter: '#{ARGV[0]}' -> exit'"
|
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
if param
|
if param
|
||||||
exit
|
exit
|
||||||
else
|
else
|
||||||
options[:user] = match[1]
|
user = match[1]
|
||||||
options[:project] = match[2]
|
project = match[2]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
[user, project]
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
# Try to find user and project name from git remote output
|
||||||
|
#
|
||||||
if !options[:user] && !options[:project]
|
# @param [String] output of git remote command
|
||||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
# @return [Array] user and project
|
||||||
options[:user] = "skywinder"
|
def self.user_project_from_remote(remote)
|
||||||
options[:project] = "changelog_test"
|
|
||||||
else
|
|
||||||
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)
|
||||||
# git@github.com:skywinder/Github-Changelog-Generator.git
|
# git@github.com:skywinder/Github-Changelog-Generator.git
|
||||||
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
|
regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
|
||||||
|
|
||||||
if match && match[1] && match[2]
|
|
||||||
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
|
||||||
options[:user] = match[1]
|
|
||||||
options[:project] = match[2]
|
|
||||||
else
|
|
||||||
# try to find repo in format:
|
# try to find repo in format:
|
||||||
# origin https://github.com/skywinder/ChangelogMerger (fetch)
|
# origin https://github.com/skywinder/ChangelogMerger (fetch)
|
||||||
# https://github.com/skywinder/ChangelogMerger
|
# https://github.com/skywinder/ChangelogMerger
|
||||||
match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
|
regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
|
||||||
if match && match[1] && match[2]
|
|
||||||
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
remote_structures = [regex1, regex2]
|
||||||
options[:user] = match[1]
|
|
||||||
options[:project] = match[2]
|
user = nil
|
||||||
end
|
project = nil
|
||||||
end
|
remote_structures.each do |regex|
|
||||||
end
|
matches = Regexp.new(regex).match(remote)
|
||||||
|
|
||||||
|
if matches && matches[1] && matches[2]
|
||||||
|
puts "Detected user:#{matches[1]}, project:#{matches[2]}"
|
||||||
|
user = matches[1]
|
||||||
|
project = matches[2]
|
||||||
|
end
|
||||||
|
|
||||||
|
break unless matches.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
[user, project]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if __FILE__ == $PROGRAM_NAME
|
||||||
|
remote = "invalid reference to project"
|
||||||
|
p user_project_from_option(ARGV[0], ARGV[1], remote)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = "1.4.1"
|
VERSION = "1.6.2"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -19,6 +19,10 @@ require "codeclimate-test-reporter"
|
|||||||
require "simplecov"
|
require "simplecov"
|
||||||
require "coveralls"
|
require "coveralls"
|
||||||
|
|
||||||
|
# This module is only used to check the environment is currently a testing env
|
||||||
|
module SpecHelper
|
||||||
|
end
|
||||||
|
|
||||||
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||||
Coveralls::SimpleCov::Formatter,
|
Coveralls::SimpleCov::Formatter,
|
||||||
SimpleCov::Formatter::HTMLFormatter,
|
SimpleCov::Formatter::HTMLFormatter,
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ describe GitHubChangelogGenerator::Fetcher do
|
|||||||
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
@fetcher = GitHubChangelogGenerator::Fetcher.new(options)
|
||||||
end
|
end
|
||||||
it "should raise Unauthorized error" do
|
it "should raise Unauthorized error" do
|
||||||
expect { @fetcher.github_fetch_tags [] }.to raise_error Github::Error::Unauthorized
|
expect { @fetcher.github_fetch_tags }.to raise_error Github::Error::Unauthorized
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
151
spec/unit/generator/generator_tags_spec.rb
Normal file
151
spec/unit/generator/generator_tags_spec.rb
Normal file
@@ -0,0 +1,151 @@
|
|||||||
|
def tag_mash_with_name(tag)
|
||||||
|
mash_tag = Hashie::Mash.new
|
||||||
|
mash_tag.name = tag
|
||||||
|
mash_tag
|
||||||
|
end
|
||||||
|
|
||||||
|
def tags_mash_from_strings(tags_strings)
|
||||||
|
mash_array = []
|
||||||
|
tags_strings.each do |tag|
|
||||||
|
mash_tag = tag_mash_with_name(tag)
|
||||||
|
mash_array << mash_tag
|
||||||
|
end
|
||||||
|
mash_array
|
||||||
|
end
|
||||||
|
|
||||||
|
describe GitHubChangelogGenerator::Generator do
|
||||||
|
describe "#filter_between_tags" do
|
||||||
|
context "when between_tags nil" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
|
||||||
|
end
|
||||||
|
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
context "when between_tags same as input array" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "when between_tags filled with correct values" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "when between_tags filled with invalid values" do
|
||||||
|
before do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
|
||||||
|
end
|
||||||
|
|
||||||
|
subject do
|
||||||
|
@generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#get_filtered_tags" do
|
||||||
|
subject do
|
||||||
|
generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
|
||||||
|
end
|
||||||
|
|
||||||
|
context "with excluded and between tags" do
|
||||||
|
let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#filter_excluded_tags" do
|
||||||
|
subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
|
||||||
|
context "with valid excluded tags" do
|
||||||
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "with invalid excluded tags" do
|
||||||
|
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
|
||||||
|
it { is_expected.to be_a Array }
|
||||||
|
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#get_time_of_tag" do
|
||||||
|
current_time = Time.now
|
||||||
|
before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
|
||||||
|
context "run with nil parameter" do
|
||||||
|
it "should raise ChangelogGeneratorError" do
|
||||||
|
expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
context "fetch already filled tag" do
|
||||||
|
before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
|
||||||
|
subject { @generator.get_time_of_tag tag_mash_with_name("valid_tag") }
|
||||||
|
it { is_expected.to be_a_kind_of(Time) }
|
||||||
|
it { is_expected.to eq(current_time) }
|
||||||
|
end
|
||||||
|
context "fetch not filled tag" do
|
||||||
|
before do
|
||||||
|
mock = double("fake fetcher")
|
||||||
|
allow(mock).to receive_messages(fetch_date_of_tag: current_time)
|
||||||
|
@generator.instance_variable_set :@fetcher, mock
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
|
||||||
|
of_tag
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a_kind_of(Time) }
|
||||||
|
it { is_expected.to eq(current_time) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#sort_tags_by_date" do
|
||||||
|
time1 = Time.now
|
||||||
|
time2 = Time.now
|
||||||
|
time3 = Time.now
|
||||||
|
before(:all) do
|
||||||
|
@generator = GitHubChangelogGenerator::Generator.new
|
||||||
|
end
|
||||||
|
context "sort unsorted tags" do
|
||||||
|
tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
|
||||||
|
before do
|
||||||
|
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.sort_tags_by_date tags
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a_kind_of(Array) }
|
||||||
|
it { is_expected.to match_array(tags.reverse!) }
|
||||||
|
end
|
||||||
|
context "sort sorted tags" do
|
||||||
|
tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
|
||||||
|
before do
|
||||||
|
@generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
|
||||||
|
end
|
||||||
|
subject do
|
||||||
|
@generator.sort_tags_by_date tags
|
||||||
|
end
|
||||||
|
it { is_expected.to be_a_kind_of(Array) }
|
||||||
|
it { is_expected.to match_array(tags) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
60
spec/unit/parser_spec.rb
Normal file
60
spec/unit/parser_spec.rb
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
describe GitHubChangelogGenerator::Parser do
|
||||||
|
describe ".user_project_from_remote" do
|
||||||
|
context "when remote is type 1" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when remote is type 2" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when remote is type 3" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when remote is type 4" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when remote is invalid" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
describe ".user_project_from_option" do
|
||||||
|
context "when option is invalid" do
|
||||||
|
it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
|
||||||
|
end
|
||||||
|
|
||||||
|
context "when option is valid" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when option nil" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
|
end
|
||||||
|
context "when site is nil" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when site is valid" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||||
|
end
|
||||||
|
context "when second arg is not nil" do
|
||||||
|
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
|
||||||
|
it { is_expected.to be_a(Array) }
|
||||||
|
it { is_expected.to match_array([nil, nil]) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user