Compare commits
131 Commits
1.7.0
...
dlanileona
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
930372b572 | ||
|
|
6a1b4f553f | ||
|
|
23f4a79462 | ||
|
|
99ffa3692b | ||
|
|
8acfcd934f | ||
|
|
fdb89ea805 | ||
|
|
b7fff7b764 | ||
|
|
6d36d007ad | ||
|
|
693f5ee2ee | ||
|
|
e6eb9f5bb6 | ||
|
|
916df554af | ||
|
|
8f61c7fc7e | ||
|
|
d79e70b267 | ||
|
|
ba7c565374 | ||
|
|
31b4294ed6 | ||
|
|
55a1c6933c | ||
|
|
125960a3a3 | ||
|
|
9feecf98b8 | ||
|
|
4b88f02f97 | ||
|
|
eccecd6875 | ||
|
|
0862e54f42 | ||
|
|
1c578fec91 | ||
|
|
29c33fec60 | ||
|
|
6c71cf439a | ||
|
|
2d7f6bf174 | ||
|
|
1e4a3db0a2 | ||
|
|
b0fc03f38c | ||
|
|
a2658f9af9 | ||
|
|
48a49a67ec | ||
|
|
93b69a511f | ||
|
|
ef97e7f950 | ||
|
|
fbd8207ff4 | ||
|
|
ff4e5612af | ||
|
|
6bace8a582 | ||
|
|
a6b0d0cb83 | ||
|
|
91176e9174 | ||
|
|
494c8afff0 | ||
|
|
d14694a6d6 | ||
|
|
aa64fa131c | ||
|
|
fe0eab1c90 | ||
|
|
14d7c29808 | ||
|
|
1bf758480f | ||
|
|
12ea21c00b | ||
|
|
6411ba6b81 | ||
|
|
302eb9c66f | ||
|
|
4bd88a3fcb | ||
|
|
61b026a60c | ||
|
|
72f993fab5 | ||
|
|
0a7c4886ec | ||
|
|
b902897a22 | ||
|
|
0df2687b93 | ||
|
|
60ddebbe1a | ||
|
|
e91b8cc535 | ||
|
|
f718a82af1 | ||
|
|
606f193ff6 | ||
|
|
5df78f22d1 | ||
|
|
b0f264a928 | ||
|
|
ea4a604bcb | ||
|
|
1ec72afe32 | ||
|
|
127ffee93f | ||
|
|
6a732ceb99 | ||
|
|
0140986091 | ||
|
|
312fe3d45a | ||
|
|
be2340ddcb | ||
|
|
f29061e75a | ||
|
|
de531262c8 | ||
|
|
35d520d251 | ||
|
|
1589df3959 | ||
|
|
a0779a5811 | ||
|
|
c611e907e0 | ||
|
|
42c94c4dd2 | ||
|
|
16f01dbda1 | ||
|
|
f285176e25 | ||
|
|
ca1ae124af | ||
|
|
672c89dcc8 | ||
|
|
5a5de9ee4a | ||
|
|
7e21aacecc | ||
|
|
a9f50cd82e | ||
|
|
0b0a762a80 | ||
|
|
0fae7e0f9e | ||
|
|
953d2813fb | ||
|
|
abd7175eef | ||
|
|
8fab94702f | ||
|
|
ef332dd02b | ||
|
|
83ae430dd8 | ||
|
|
8c0974200c | ||
|
|
28e3ed2500 | ||
|
|
1bf5644a72 | ||
|
|
bc37d0277b | ||
|
|
c4846b7ef9 | ||
|
|
d09dad30f4 | ||
|
|
31e98fbc41 | ||
|
|
82dd0b3cce | ||
|
|
1ae86e3cb2 | ||
|
|
b3eea83ae1 | ||
|
|
7e4d546f60 | ||
|
|
be62b92fa9 | ||
|
|
0b6d751388 | ||
|
|
410921f673 | ||
|
|
8b49b5ac0c | ||
|
|
d7b5d77bbf | ||
|
|
ddf2624bf9 | ||
|
|
80b40d1b36 | ||
|
|
e8e4628261 | ||
|
|
4261c3494e | ||
|
|
d138644925 | ||
|
|
0301dcb672 | ||
|
|
73d4415e14 | ||
|
|
ed179ed7be | ||
|
|
0930cfdd88 | ||
|
|
c140349a73 | ||
|
|
8c35215697 | ||
|
|
840b6666e0 | ||
|
|
7b7c6fc793 | ||
|
|
2357875c13 | ||
|
|
cac840c57d | ||
|
|
9acca33bc2 | ||
|
|
4aa9c61520 | ||
|
|
f49949147c | ||
|
|
bfae7b9a45 | ||
|
|
4202b95076 | ||
|
|
4856a3c8e9 | ||
|
|
5d9b44eac3 | ||
|
|
295cfbc767 | ||
|
|
32f4df5742 | ||
|
|
0190d417c2 | ||
|
|
b6efcfced8 | ||
|
|
b74b457ad0 | ||
|
|
83cc36959a | ||
|
|
2dbf975c06 | ||
|
|
63e91d8e72 |
@@ -14,3 +14,7 @@ Metrics/ClassLength:
|
||||
# Configuration parameters: CountComments.
|
||||
Metrics/MethodLength:
|
||||
Enabled: false
|
||||
|
||||
Style/FileName:
|
||||
Exclude:
|
||||
- 'bin/git-generate-changelog'
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
sudo: false
|
||||
cache: bundler
|
||||
language: ruby
|
||||
before_install: gem update --system
|
||||
rvm:
|
||||
- 2.1.0
|
||||
script:
|
||||
|
||||
161
CHANGELOG.md
161
CHANGELOG.md
@@ -1,7 +1,82 @@
|
||||
# Change Log
|
||||
|
||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
|
||||
|
||||
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
|
||||
|
||||
## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
|
||||
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
|
||||
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
|
||||
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
|
||||
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
|
||||
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
|
||||
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
|
||||
- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
|
||||
|
||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -9,7 +84,6 @@
|
||||
- --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:**
|
||||
@@ -21,33 +95,26 @@
|
||||
- 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:**
|
||||
@@ -55,7 +122,6 @@
|
||||
- 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:**
|
||||
@@ -65,28 +131,23 @@
|
||||
**Fixed bugs:**
|
||||
|
||||
- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
|
||||
|
||||
- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
|
||||
|
||||
- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
|
||||
|
||||
## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
|
||||
|
||||
- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
|
||||
- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
@@ -95,21 +156,13 @@
|
||||
**Merged pull requests:**
|
||||
|
||||
- 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))
|
||||
|
||||
- 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))
|
||||
|
||||
- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
|
||||
|
||||
- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
|
||||
|
||||
- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
|
||||
|
||||
## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
|
||||
|
||||
**Merged pull requests:**
|
||||
@@ -117,35 +170,30 @@
|
||||
- Add fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
|
||||
|
||||
**Merged pull requests:**
|
||||
**Fixed bugs:**
|
||||
|
||||
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
|
||||
|
||||
**Merged pull requests:**
|
||||
**Fixed bugs:**
|
||||
|
||||
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
|
||||
|
||||
## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
|
||||
|
||||
## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -153,7 +201,6 @@
|
||||
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
|
||||
|
||||
## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -161,7 +208,6 @@
|
||||
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
|
||||
|
||||
## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
|
||||
|
||||
**Closed issues:**
|
||||
@@ -169,7 +215,6 @@
|
||||
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
|
||||
|
||||
## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -177,21 +222,16 @@
|
||||
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
|
||||
|
||||
## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
|
||||
|
||||
## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
|
||||
|
||||
- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
|
||||
|
||||
- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
|
||||
|
||||
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -203,7 +243,6 @@
|
||||
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8)
|
||||
|
||||
**Closed issues:**
|
||||
@@ -213,19 +252,16 @@
|
||||
**Merged pull requests:**
|
||||
|
||||
- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
|
||||
|
||||
**Merged pull requests:**
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
|
||||
|
||||
## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
|
||||
|
||||
**Merged pull requests:**
|
||||
@@ -233,41 +269,32 @@
|
||||
- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||
|
||||
## [1.2.5](https://github.com/skywinder/github-changelog-generator/tree/1.2.5) (2015-01-15)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
|
||||
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
|
||||
|
||||
- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||
|
||||
## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
|
||||
|
||||
- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
|
||||
|
||||
## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
|
||||
|
||||
- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -277,11 +304,9 @@
|
||||
**Merged pull requests:**
|
||||
|
||||
- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -293,7 +318,6 @@
|
||||
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||
|
||||
## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -303,23 +327,18 @@
|
||||
**Merged pull requests:**
|
||||
|
||||
- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/github-changelog-generator/pull/27) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/github-changelog-generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/github-changelog-generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
|
||||
|
||||
**Implemented enhancements:**
|
||||
@@ -331,29 +350,23 @@
|
||||
- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/github-changelog-generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/github-changelog-generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
@@ -363,22 +376,19 @@
|
||||
**Fixed bugs:**
|
||||
|
||||
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
|
||||
|
||||
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
|
||||
|
||||
## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
|
||||
|
||||
## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
|
||||
|
||||
- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
|
||||
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
@@ -386,28 +396,21 @@
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/github-changelog-generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
|
||||
|
||||
## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
|
||||
|
||||
|
||||
|
||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||
11
Gemfile.lock
11
Gemfile.lock
@@ -1,7 +1,7 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
github_changelog_generator (1.6.2)
|
||||
github_changelog_generator (1.9.0)
|
||||
colorize (~> 0.7)
|
||||
github_api (~> 0.12)
|
||||
|
||||
@@ -29,13 +29,13 @@ GEM
|
||||
unf (>= 0.0.5, < 1.0.0)
|
||||
faraday (0.9.1)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
github_api (0.12.3)
|
||||
github_api (0.12.4)
|
||||
addressable (~> 2.3)
|
||||
descendants_tracker (~> 0.0.4)
|
||||
faraday (~> 0.8, < 0.10)
|
||||
hashie (>= 3.3)
|
||||
hashie (>= 3.4)
|
||||
multi_json (>= 1.7.5, < 2.0)
|
||||
nokogiri (~> 1.6.3)
|
||||
nokogiri (~> 1.6.6)
|
||||
oauth2
|
||||
hashie (3.4.2)
|
||||
http-cookie (1.0.2)
|
||||
@@ -112,3 +112,6 @@ DEPENDENCIES
|
||||
rspec (~> 3.2)
|
||||
rubocop (~> 0.31)
|
||||
simplecov (~> 0.10)
|
||||
|
||||
BUNDLED WITH
|
||||
1.10.6
|
||||
|
||||
36
README.md
36
README.md
@@ -84,6 +84,16 @@ Type `github_changelog_generator --help` for details.
|
||||
|
||||
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)
|
||||
|
||||
### Params File
|
||||
You can put Params in a .github_changelog_generator file in Project Root to override default params:
|
||||
|
||||
Example:
|
||||
```
|
||||
unreleased=false
|
||||
future-release=5.0.0
|
||||
since-tag=1.0.0
|
||||
```
|
||||
|
||||
### 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)
|
||||
@@ -92,7 +102,7 @@ Since GitHub allows you to make only 50 requests without authentication it's rec
|
||||
|
||||
And:
|
||||
|
||||
- Run with key `-t [your-16-digit-token]`
|
||||
- Run with key `-t [your-40-digit-token]`
|
||||
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||
|
||||
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||
@@ -104,6 +114,28 @@ 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.
|
||||
|
||||
## Migrating from a manual changelog
|
||||
|
||||
Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
|
||||
but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
|
||||
|
||||
That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
|
||||
|
||||
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
||||
|
||||
### Rake task
|
||||
|
||||
You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
|
||||
|
||||
```ruby
|
||||
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
||||
config.since_tag = '0.1.14'
|
||||
config.future_release = '0.2.0'
|
||||
end
|
||||
```
|
||||
|
||||
All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
|
||||
|
||||
##Features and advantages of this project
|
||||
- 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:
|
||||
@@ -189,6 +221,8 @@ If you're seeing this warning:
|
||||
6. Create a new Pull Request
|
||||
7. Profit! :white_check_mark:
|
||||
|
||||
*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
|
||||
|
||||
## License
|
||||
|
||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||
|
||||
4
bin/git-generate-changelog
Executable file
4
bin/git-generate-changelog
Executable file
@@ -0,0 +1,4 @@
|
||||
#! /usr/bin/env ruby
|
||||
|
||||
require_relative "../lib/github_changelog_generator"
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.run
|
||||
10
ext/mkrf_conf.rb
Normal file
10
ext/mkrf_conf.rb
Normal file
@@ -0,0 +1,10 @@
|
||||
PREFIX = "/usr/local"
|
||||
MANPREFIX = "#{PREFIX}/share/man/man1"
|
||||
MAN_PAGES = "man/git-*"
|
||||
|
||||
require "fileutils"
|
||||
|
||||
Dir.glob(MAN_PAGES).each do |f|
|
||||
filename = File.basename(f)
|
||||
FileUtils.cp(f, "#{MANPREFIX}/#{filename}")
|
||||
end
|
||||
@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
|
||||
spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
|
||||
spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
|
||||
spec.license = "MIT"
|
||||
spec.extensions = "ext/mkrf_conf.rb"
|
||||
|
||||
spec.files = `git ls-files -z`.split("\x0")
|
||||
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
|
||||
- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
@@ -21,6 +22,7 @@
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
|
||||
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
|
||||
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@ require "benchmark"
|
||||
|
||||
require_relative "github_changelog_generator/helper"
|
||||
require_relative "github_changelog_generator/parser"
|
||||
require_relative "github_changelog_generator/parser_file"
|
||||
require_relative "github_changelog_generator/generator/generator"
|
||||
require_relative "github_changelog_generator/version"
|
||||
require_relative "github_changelog_generator/reader"
|
||||
|
||||
@@ -163,10 +163,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
issues_slice.each do |issue|
|
||||
threads << Thread.new do
|
||||
begin
|
||||
obj = @github.issues.events.list user: @options[:user],
|
||||
response = @github.issues.events.list user: @options[:user],
|
||||
repo: @options[:project],
|
||||
issue_number: issue["number"]
|
||||
issue[:events] = obj.body
|
||||
issue[:events] = []
|
||||
response.each_page do |page|
|
||||
issue[:events].concat(page)
|
||||
end
|
||||
rescue
|
||||
Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
|
||||
end
|
||||
|
||||
@@ -66,7 +66,7 @@ module GitHubChangelogGenerator
|
||||
|
||||
if @options[:issues]
|
||||
# Generate issues:
|
||||
log += issues_to_log(issues)
|
||||
log += issues_to_log(issues, pull_requests)
|
||||
end
|
||||
|
||||
if @options[:pulls]
|
||||
@@ -77,13 +77,14 @@ module GitHubChangelogGenerator
|
||||
log
|
||||
end
|
||||
|
||||
# Generate ready-to-paste log from list of issues.
|
||||
# Generate ready-to-paste log from list of issues and pull requests.
|
||||
#
|
||||
# @param [Array] issues
|
||||
# @param [Array] pull_requests
|
||||
# @return [String] generated log for issues
|
||||
def issues_to_log(issues)
|
||||
def issues_to_log(issues, pull_requests)
|
||||
log = ""
|
||||
bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
|
||||
bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
|
||||
|
||||
log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
|
||||
log += generate_sub_section(bugs_a, @options[:bug_prefix])
|
||||
@@ -95,8 +96,9 @@ module GitHubChangelogGenerator
|
||||
# (bugs, features, or just closed issues) by labels
|
||||
#
|
||||
# @param [Array] issues
|
||||
# @param [Array] pull_requests
|
||||
# @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
|
||||
def parse_by_sections(issues)
|
||||
def parse_by_sections(issues, pull_requests)
|
||||
issues_a = []
|
||||
enhancement_a = []
|
||||
bugs_a = []
|
||||
@@ -117,6 +119,24 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
issues_a.push dict unless added
|
||||
end
|
||||
|
||||
added_pull_requests = []
|
||||
pull_requests.each do |dict|
|
||||
dict.labels.each do |label|
|
||||
if @options[:bug_labels].include? label.name
|
||||
bugs_a.push dict
|
||||
added_pull_requests.push dict
|
||||
next
|
||||
end
|
||||
if @options[:enhancement_labels].include? label.name
|
||||
enhancement_a.push dict
|
||||
added_pull_requests.push dict
|
||||
next
|
||||
end
|
||||
end
|
||||
end
|
||||
added_pull_requests.each { |p| pull_requests.delete(p) }
|
||||
|
||||
[bugs_a, enhancement_a, issues_a]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -48,11 +48,11 @@ module GitHubChangelogGenerator
|
||||
# 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?
|
||||
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|
|
||||
issue[:events].reverse!.each do |event|
|
||||
if event[:event].eql? compare_string
|
||||
set_date_from_event(event, issue)
|
||||
break
|
||||
|
||||
@@ -16,6 +16,8 @@ module GitHubChangelogGenerator
|
||||
log += generate_log_for_all_tags
|
||||
end
|
||||
|
||||
log += File.read(@options[:base]) if File.file?(@options[:base])
|
||||
|
||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||
@log = log
|
||||
end
|
||||
@@ -49,9 +51,8 @@ module GitHubChangelogGenerator
|
||||
def generate_sub_section(issues, prefix)
|
||||
log = ""
|
||||
|
||||
log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
|
||||
|
||||
if issues.any?
|
||||
log += "#{prefix}\n\n" unless options[:simple_list]
|
||||
issues.each do |issue|
|
||||
merge_string = get_string_for_issue(issue)
|
||||
log += "- #{merge_string}\n"
|
||||
@@ -76,10 +77,15 @@ module GitHubChangelogGenerator
|
||||
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"
|
||||
if @options[:release_url]
|
||||
release_url = format(@options[:release_url], newer_tag_link)
|
||||
else
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n"
|
||||
release_url = "#{project_url}/tree/#{newer_tag_link}"
|
||||
end
|
||||
if newer_tag_name.equal? @options[:unreleased_label]
|
||||
log += "## [#{newer_tag_name}](#{release_url})\n\n"
|
||||
else
|
||||
log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
|
||||
end
|
||||
|
||||
if @options[:compare_link] && older_tag_link
|
||||
@@ -96,7 +102,7 @@ module GitHubChangelogGenerator
|
||||
def generate_log_between_tags(older_tag, newer_tag)
|
||||
filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
|
||||
|
||||
older_tag_name = older_tag.nil? ? nil : older_tag["name"]
|
||||
older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
|
||||
|
||||
if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
|
||||
# do not generate empty unreleased section
|
||||
|
||||
@@ -63,21 +63,21 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
# Method filter issues, that belong only specified tag range
|
||||
# @param [Array] array of issues to filter
|
||||
# @param [Array] issues issues to filter
|
||||
# @param [Symbol] hash_key key of date value default is :actual_date
|
||||
# @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
|
||||
# @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
|
||||
# @return [Array] filtered issues
|
||||
def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||
def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
|
||||
# in case if not tags specified - return unchanged array
|
||||
return array if older_tag.nil? && newer_tag.nil?
|
||||
return issues if older_tag.nil? && newer_tag.nil?
|
||||
|
||||
newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
|
||||
older_tag_time = older_tag && get_time_of_tag(older_tag)
|
||||
|
||||
array.select do |req|
|
||||
if req[hash_key]
|
||||
time = Time.parse(req[hash_key]).utc
|
||||
issues.select do |issue|
|
||||
if issue[hash_key]
|
||||
time = Time.parse(issue[hash_key]).utc
|
||||
|
||||
tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
|
||||
|
||||
|
||||
@@ -52,14 +52,69 @@ module GitHubChangelogGenerator
|
||||
[newer_tag_link, newer_tag_name, newer_tag_time]
|
||||
end
|
||||
|
||||
# @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
|
||||
def detect_since_tag
|
||||
@since_tag ||= @options[:since_tag]
|
||||
if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
|
||||
reader = GitHubChangelogGenerator::Reader.new
|
||||
content = reader.read(@options[:base])
|
||||
@since_tag = content[0]["version"] if content
|
||||
end
|
||||
@since_tag
|
||||
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)
|
||||
filtered_tags = filter_since_tag(all_tags)
|
||||
filtered_tags = filter_between_tags(filtered_tags)
|
||||
filter_excluded_tags(filtered_tags)
|
||||
end
|
||||
|
||||
# @param [Array] all_tags all tags
|
||||
# @return [Array] filtered tags according :since_tag option
|
||||
def filter_since_tag(all_tags)
|
||||
filtered_tags = all_tags
|
||||
tag = detect_since_tag
|
||||
if tag
|
||||
if all_tags.map(&:name).include? tag
|
||||
idx = all_tags.index { |t| t.name == tag }
|
||||
if idx > 0
|
||||
filtered_tags = all_tags[0..idx - 1]
|
||||
else
|
||||
filtered_tags = []
|
||||
end
|
||||
else
|
||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
|
||||
end
|
||||
end
|
||||
filtered_tags
|
||||
end
|
||||
|
||||
# @param [Array] all_tags all tags
|
||||
# @return [Array] filtered tags according :due_tag option
|
||||
def filter_due_tag(all_tags)
|
||||
filtered_tags = all_tags
|
||||
tag = @options[:due_tag]
|
||||
if tag
|
||||
if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
|
||||
idx = all_tags.index { |t| t.name == tag }
|
||||
last_index = all_tags.count - 1
|
||||
if idx > 0 && idx < last_index
|
||||
filtered_tags = all_tags[idx + 1..last_index]
|
||||
else
|
||||
filtered_tags = []
|
||||
end
|
||||
else
|
||||
Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
|
||||
end
|
||||
end
|
||||
filtered_tags
|
||||
end
|
||||
|
||||
# @param [Array] all_tags all tags
|
||||
# @return [Array] filtered tags according :between_tags option
|
||||
def filter_between_tags(all_tags)
|
||||
filtered_tags = all_tags
|
||||
if @options[:between_tags]
|
||||
@@ -73,17 +128,48 @@ module GitHubChangelogGenerator
|
||||
filtered_tags
|
||||
end
|
||||
|
||||
# @param [Array] all_tags all tags
|
||||
# @return [Array] filtered tags according :exclude_tags option
|
||||
def filter_excluded_tags(all_tags)
|
||||
filtered_tags = all_tags
|
||||
if @options[:exclude_tags]
|
||||
return all_tags unless @options[:exclude_tags]
|
||||
|
||||
apply_exclude_tags(all_tags)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def apply_exclude_tags(all_tags)
|
||||
if @options[:exclude_tags].is_a?(Regexp)
|
||||
filter_tags_with_regex(all_tags)
|
||||
else
|
||||
filter_exact_tags(all_tags)
|
||||
end
|
||||
end
|
||||
|
||||
def filter_tags_with_regex(all_tags)
|
||||
warn_if_nonmatching_regex(all_tags)
|
||||
all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
|
||||
end
|
||||
|
||||
def filter_exact_tags(all_tags)
|
||||
@options[:exclude_tags].each do |tag|
|
||||
warn_if_tag_not_found(all_tags, tag)
|
||||
end
|
||||
all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
|
||||
end
|
||||
|
||||
def warn_if_nonmatching_regex(all_tags)
|
||||
unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
|
||||
Helper.log.warn "Warning: unable to reject any tag, using regex "\
|
||||
"#{@options[:exclude_tags].inspect} in --exclude-tags "\
|
||||
"option."
|
||||
end
|
||||
end
|
||||
|
||||
def warn_if_tag_not_found(all_tags, tag)
|
||||
unless all_tags.map(&: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
|
||||
|
||||
@@ -9,12 +9,14 @@ module GitHubChangelogGenerator
|
||||
def self.parse_options
|
||||
options = get_default_options
|
||||
|
||||
parser = setup_parser(options)
|
||||
parser_file = ParserFile.new options
|
||||
parser_file.parse!
|
||||
|
||||
parser = setup_parser(options)
|
||||
parser.parse!
|
||||
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
detect_user_and_project(options)
|
||||
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||
end
|
||||
|
||||
if !options[:user] || !options[:project]
|
||||
@@ -22,15 +24,22 @@ module GitHubChangelogGenerator
|
||||
exit
|
||||
end
|
||||
|
||||
if options[:verbose]
|
||||
Helper.log.info "Performing task with options:"
|
||||
pp options
|
||||
puts ""
|
||||
end
|
||||
print_options(options)
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
# @param [Hash] options to display
|
||||
def self.print_options(options)
|
||||
if options[:verbose]
|
||||
Helper.log.info "Performing task with options:"
|
||||
options_to_display = options.clone
|
||||
options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
|
||||
pp options_to_display
|
||||
puts ""
|
||||
end
|
||||
end
|
||||
|
||||
# setup parsing options
|
||||
def self.setup_parser(options)
|
||||
parser = OptionParser.new do |opts|
|
||||
@@ -50,6 +59,9 @@ module GitHubChangelogGenerator
|
||||
opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
|
||||
options[:output] = last
|
||||
end
|
||||
opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
|
||||
options[:base] = last
|
||||
end
|
||||
opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
|
||||
options[:bug_prefix] = v
|
||||
end
|
||||
@@ -110,12 +122,21 @@ module GitHubChangelogGenerator
|
||||
opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list|
|
||||
options[:between_tags] = list
|
||||
end
|
||||
opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list|
|
||||
opts.on("--exclude-tags x,y,z", Array, "Change log will exclude specified tags") do |list|
|
||||
options[:exclude_tags] = list
|
||||
end
|
||||
opts.on("--since-tag x", "Change log will start after specified tag") do |v|
|
||||
options[:since_tag] = v
|
||||
end
|
||||
opts.on("--due-tag x", "Change log will end before specified tag") do |v|
|
||||
options[:due_tag] = v
|
||||
end
|
||||
opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
|
||||
options[:max_issues] = max
|
||||
end
|
||||
opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
|
||||
options[:release_url] = url
|
||||
end
|
||||
opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
|
||||
options[:github_site] = last
|
||||
end
|
||||
@@ -150,6 +171,7 @@ module GitHubChangelogGenerator
|
||||
tag2: nil,
|
||||
date_format: "%Y-%m-%d",
|
||||
output: "CHANGELOG.md",
|
||||
base: "HISTORY.md",
|
||||
issues: true,
|
||||
add_issues_wo_labels: true,
|
||||
add_pr_wo_labels: true,
|
||||
@@ -177,8 +199,8 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
# Detects user and project from git
|
||||
def self.detect_user_and_project(options)
|
||||
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
|
||||
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||
if !options[:user] || !options[:project]
|
||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||
options[:user] = "skywinder"
|
||||
|
||||
37
lib/github_changelog_generator/parser_file.rb
Normal file
37
lib/github_changelog_generator/parser_file.rb
Normal file
@@ -0,0 +1,37 @@
|
||||
module GitHubChangelogGenerator
|
||||
class ParserFile
|
||||
def initialize(options)
|
||||
@options = options
|
||||
end
|
||||
|
||||
def parse!
|
||||
return unless File.exist?(file)
|
||||
|
||||
File.readlines(file).each { |line| parse_line!(line) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def file
|
||||
@file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
|
||||
end
|
||||
|
||||
def parse_line!(line)
|
||||
key_sym, value = extract_pair(line)
|
||||
value = true if value =~ (/^(true|t|yes|y|1)$/i)
|
||||
value = false if value =~ (/^(false|f|no|n|0)$/i)
|
||||
@options[key_sym] = value
|
||||
rescue
|
||||
raise "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
|
||||
end
|
||||
|
||||
# Returns a the setting as a symbol and its string value sans newlines.
|
||||
#
|
||||
# @param line [String] unparsed line from config file
|
||||
# @return [Array<Symbol, String>]
|
||||
def extract_pair(line)
|
||||
key, value = line.split("=", 2)
|
||||
[key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
|
||||
end
|
||||
end
|
||||
end
|
||||
68
lib/github_changelog_generator/task.rb
Normal file
68
lib/github_changelog_generator/task.rb
Normal file
@@ -0,0 +1,68 @@
|
||||
require "rake"
|
||||
require "rake/tasklib"
|
||||
require "github_changelog_generator"
|
||||
|
||||
module GitHubChangelogGenerator
|
||||
class RakeTask < ::Rake::TaskLib
|
||||
include ::Rake::DSL if defined?(::Rake::DSL)
|
||||
|
||||
OPTIONS = %w( user project token date_format output
|
||||
bug_prefix enhancement_prefix issue_prefix
|
||||
header merge_prefix issues
|
||||
add_issues_wo_labels add_pr_wo_labels
|
||||
pulls filter_issues_by_milestone author
|
||||
unreleased_only unreleased unreleased_label
|
||||
compare_link include_labels exclude_labels
|
||||
bug_labels enhancement_labels
|
||||
between_tags exclude_tags since_tag max_issues
|
||||
github_site github_endpoint simple_list
|
||||
future_release verbose release_url base )
|
||||
|
||||
OPTIONS.each do |o|
|
||||
attr_accessor o.to_sym
|
||||
end
|
||||
|
||||
# Public: Initialise a new GitHubChangelogGenerator::RakeTask.
|
||||
#
|
||||
# Example
|
||||
#
|
||||
# GitHubChangelogGenerator::RakeTask.new
|
||||
def initialize(*args, &task_block)
|
||||
@name = args.shift || :changelog
|
||||
|
||||
define(args, &task_block)
|
||||
end
|
||||
|
||||
def define(args, &task_block)
|
||||
desc "Generate a Change log from GitHub"
|
||||
|
||||
task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
|
||||
|
||||
# clear any (auto-)pre-existing task
|
||||
Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
|
||||
|
||||
task @name do
|
||||
# mimick parse_options
|
||||
options = Parser.get_default_options
|
||||
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
Parser.detect_user_and_project(options)
|
||||
end
|
||||
|
||||
OPTIONS.each do |o|
|
||||
v = instance_variable_get("@#{o}")
|
||||
options[o.to_sym] = v unless v.nil?
|
||||
end
|
||||
|
||||
generator = Generator.new options
|
||||
|
||||
log = generator.compound_changelog
|
||||
|
||||
output_filename = "#{options[:output]}"
|
||||
File.open(output_filename, "w") { |file| file.write(log) }
|
||||
puts "Done!"
|
||||
puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,3 +1,3 @@
|
||||
module GitHubChangelogGenerator
|
||||
VERSION = "1.7.0"
|
||||
VERSION = "1.9.0"
|
||||
end
|
||||
|
||||
252
man/git-generate-changelog.1
Normal file
252
man/git-generate-changelog.1
Normal file
@@ -0,0 +1,252 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBgit\-generate\-changelog\fR \- Generate changelog from github
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
\-u, \-\-user [USER]
|
||||
.
|
||||
.P
|
||||
Username of the owner of target GitHub repo
|
||||
.
|
||||
.P
|
||||
\-p, \-\-project [PROJECT]
|
||||
.
|
||||
.P
|
||||
Name of project on GitHub
|
||||
.
|
||||
.P
|
||||
\-t, \-\-token [TOKEN]
|
||||
.
|
||||
.P
|
||||
To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
|
||||
.
|
||||
.P
|
||||
\-f, \-\-date\-format [FORMAT]
|
||||
.
|
||||
.P
|
||||
Date format\. Default is %Y\-%m\-%d
|
||||
.
|
||||
.P
|
||||
\-o, \-\-output [NAME]
|
||||
.
|
||||
.P
|
||||
Output file\. Default is CHANGELOG\.md
|
||||
.
|
||||
.P
|
||||
\-b, \-\-base [NAME]
|
||||
.
|
||||
.P
|
||||
Optional base file to append generated changes to\.
|
||||
.
|
||||
.P
|
||||
\-\-bugs\-label [LABEL]
|
||||
.
|
||||
.P
|
||||
Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
|
||||
.
|
||||
.P
|
||||
\-\-enhancement\-label [LABEL]
|
||||
.
|
||||
.P
|
||||
Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
|
||||
.
|
||||
.P
|
||||
\-\-issues\-label [LABEL]
|
||||
.
|
||||
.P
|
||||
Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
|
||||
.
|
||||
.P
|
||||
\-\-header\-label [LABEL]
|
||||
.
|
||||
.P
|
||||
Setup custom header label\. Default is "# Change Log"
|
||||
.
|
||||
.P
|
||||
\-\-pr\-label [LABEL]
|
||||
.
|
||||
.P
|
||||
Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]issues
|
||||
.
|
||||
.P
|
||||
Include closed issues in changelog\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]issues\-wo\-labels
|
||||
.
|
||||
.P
|
||||
Include closed issues without labels in changelog\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]pr\-wo\-labels
|
||||
.
|
||||
.P
|
||||
Include pull requests without labels in changelog\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]pull\-requests
|
||||
.
|
||||
.P
|
||||
Include pull\-requests in changelog\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]filter\-by\-milestone
|
||||
.
|
||||
.P
|
||||
Use milestone to detect when issue was resolved\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]author
|
||||
.
|
||||
.P
|
||||
Add author of pull\-request in the end\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-unreleased\-only
|
||||
.
|
||||
.P
|
||||
Generate log from unreleased closed issues only\.
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]unreleased
|
||||
.
|
||||
.P
|
||||
Add to log unreleased closed issues\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-unreleased\-label [label]
|
||||
.
|
||||
.P
|
||||
Add to log unreleased closed issues\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]compare\-link
|
||||
.
|
||||
.P
|
||||
Include compare link (Full Changelog) between older version and newer version\. Default is true
|
||||
.
|
||||
.P
|
||||
\-\-include\-labels x,y,z
|
||||
.
|
||||
.P
|
||||
Only issues with the specified labels will be included in the changelog\.
|
||||
.
|
||||
.P
|
||||
\-\-exclude\-labels x,y,z
|
||||
.
|
||||
.P
|
||||
Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
|
||||
.
|
||||
.P
|
||||
\-\-bug\-labels x,y,z
|
||||
.
|
||||
.P
|
||||
Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
|
||||
.
|
||||
.P
|
||||
\-\-enhancement\-labels x,y,z
|
||||
.
|
||||
.P
|
||||
Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
|
||||
.
|
||||
.P
|
||||
\-\-between\-tags x,y,z
|
||||
.
|
||||
.P
|
||||
Change log will be filled only between specified tags
|
||||
.
|
||||
.P
|
||||
\-\-exclude\-tags x,y,z
|
||||
.
|
||||
.P
|
||||
Change log will exclude specified tags
|
||||
.
|
||||
.P
|
||||
\-\-since\-tag x
|
||||
.
|
||||
.P
|
||||
Change log will start after specified tag
|
||||
.
|
||||
.P
|
||||
\-\-due\-tag x
|
||||
.
|
||||
.P
|
||||
Change log will end before specified tag
|
||||
.
|
||||
.P
|
||||
\-\-max\-issues [NUMBER]
|
||||
.
|
||||
.P
|
||||
Max number of issues to fetch from GitHub\. Default is unlimited
|
||||
.
|
||||
.P
|
||||
\-\-release\-url [URL]
|
||||
.
|
||||
.P
|
||||
The URL to point to for release links, in printf format (with the tag as variable)\.
|
||||
.
|
||||
.P
|
||||
\-\-github\-site [URL]
|
||||
.
|
||||
.P
|
||||
The Enterprise Github site on which your project is hosted\.
|
||||
.
|
||||
.P
|
||||
\-\-github\-api [URL]
|
||||
.
|
||||
.P
|
||||
The enterprise endpoint to use for your Github API\.
|
||||
.
|
||||
.P
|
||||
\-\-simple\-list
|
||||
.
|
||||
.P
|
||||
Create simple list from issues and pull requests\. Default is false\.
|
||||
.
|
||||
.P
|
||||
\-\-future\-release [RELEASE\-VERSION]
|
||||
.
|
||||
.P
|
||||
Put the unreleased changes in the specified release number\.
|
||||
.
|
||||
.P
|
||||
\-\-[no\-]verbose
|
||||
.
|
||||
.P
|
||||
Run verbosely\. Default is true
|
||||
.
|
||||
.P
|
||||
\-v, \-\-version
|
||||
.
|
||||
.P
|
||||
Print version number
|
||||
.
|
||||
.P
|
||||
\-h, \-\-help
|
||||
.
|
||||
.P
|
||||
Displays Help
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
.
|
||||
.SH "AUTHOR"
|
||||
Written by Petr Korolev sky4winder@gmail\.com
|
||||
.
|
||||
.SH "REPORTING BUGS"
|
||||
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>
|
||||
262
man/git-generate-changelog.html
Normal file
262
man/git-generate-changelog.html
Normal file
@@ -0,0 +1,262 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
||||
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
||||
<title>git-generate-changelog(1) - Generate changelog from github</title>
|
||||
<style type='text/css' media='all'>
|
||||
/* style: man */
|
||||
body#manpage {margin:0}
|
||||
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
||||
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
||||
.mp h2 {margin:10px 0 0 0}
|
||||
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
||||
.mp h3 {margin:0 0 0 4ex}
|
||||
.mp dt {margin:0;clear:left}
|
||||
.mp dt.flush {float:left;width:8ex}
|
||||
.mp dd {margin:0 0 0 9ex}
|
||||
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
||||
.mp pre {margin-bottom:20px}
|
||||
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
||||
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
||||
.mp img {display:block;margin:auto}
|
||||
.mp h1.man-title {display:none}
|
||||
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
||||
.mp h2 {font-size:16px;line-height:1.25}
|
||||
.mp h1 {font-size:20px;line-height:2}
|
||||
.mp {text-align:justify;background:#fff}
|
||||
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
||||
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
||||
.mp u {text-decoration:underline}
|
||||
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
||||
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
||||
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
||||
.mp b.man-ref {font-weight:normal;color:#434241}
|
||||
.mp pre {padding:0 4ex}
|
||||
.mp pre code {font-weight:normal;color:#434241}
|
||||
.mp h2+pre,h3+pre {padding-left:0}
|
||||
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
||||
ol.man-decor {width:100%}
|
||||
ol.man-decor li.tl {text-align:left}
|
||||
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
||||
ol.man-decor li.tr {text-align:right;float:right}
|
||||
</style>
|
||||
</head>
|
||||
<!--
|
||||
The following styles are deprecated and will be removed at some point:
|
||||
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
||||
|
||||
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
||||
.man-navigation should be used instead.
|
||||
-->
|
||||
<body id='manpage'>
|
||||
<div class='mp' id='man'>
|
||||
|
||||
<div class='man-navigation' style='display:none'>
|
||||
<a href="#NAME">NAME</a>
|
||||
<a href="#SYNOPSIS">SYNOPSIS</a>
|
||||
<a href="#DESCRIPTION">DESCRIPTION</a>
|
||||
<a href="#OPTIONS">OPTIONS</a>
|
||||
<a href="#EXAMPLES">EXAMPLES</a>
|
||||
<a href="#AUTHOR">AUTHOR</a>
|
||||
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
|
||||
<a href="#SEE-ALSO">SEE ALSO</a>
|
||||
</div>
|
||||
|
||||
<ol class='man-decor man-head man head'>
|
||||
<li class='tl'>git-generate-changelog(1)</li>
|
||||
<li class='tc'></li>
|
||||
<li class='tr'>git-generate-changelog(1)</li>
|
||||
</ol>
|
||||
|
||||
<h2 id="NAME">NAME</h2>
|
||||
<p class="man-name">
|
||||
<code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
|
||||
</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
|
||||
|
||||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<p> -u, --user [USER]</p>
|
||||
|
||||
<p> Username of the owner of target GitHub repo</p>
|
||||
|
||||
<p> -p, --project [PROJECT]</p>
|
||||
|
||||
<p> Name of project on GitHub</p>
|
||||
|
||||
<p> -t, --token [TOKEN]</p>
|
||||
|
||||
<p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
|
||||
|
||||
<p> -f, --date-format [FORMAT]</p>
|
||||
|
||||
<p> Date format. Default is %Y-%m-%d</p>
|
||||
|
||||
<p> -o, --output [NAME]</p>
|
||||
|
||||
<p> Output file. Default is CHANGELOG.md</p>
|
||||
|
||||
<p> -b, --base [NAME]</p>
|
||||
|
||||
<p> Optional base file to append generated changes to.</p>
|
||||
|
||||
<p> --bugs-label [LABEL]</p>
|
||||
|
||||
<p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
|
||||
|
||||
<p> --enhancement-label [LABEL]</p>
|
||||
|
||||
<p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
|
||||
|
||||
<p> --issues-label [LABEL]</p>
|
||||
|
||||
<p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
|
||||
|
||||
<p> --header-label [LABEL]</p>
|
||||
|
||||
<p> Setup custom header label. Default is "# Change Log"</p>
|
||||
|
||||
<p> --pr-label [LABEL]</p>
|
||||
|
||||
<p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
|
||||
|
||||
<p> --[no-]issues</p>
|
||||
|
||||
<p> Include closed issues in changelog. Default is true</p>
|
||||
|
||||
<p> --[no-]issues-wo-labels</p>
|
||||
|
||||
<p> Include closed issues without labels in changelog. Default is true</p>
|
||||
|
||||
<p> --[no-]pr-wo-labels</p>
|
||||
|
||||
<p> Include pull requests without labels in changelog. Default is true</p>
|
||||
|
||||
<p> --[no-]pull-requests</p>
|
||||
|
||||
<p> Include pull-requests in changelog. Default is true</p>
|
||||
|
||||
<p> --[no-]filter-by-milestone</p>
|
||||
|
||||
<p> Use milestone to detect when issue was resolved. Default is true</p>
|
||||
|
||||
<p> --[no-]author</p>
|
||||
|
||||
<p> Add author of pull-request in the end. Default is true</p>
|
||||
|
||||
<p> --unreleased-only</p>
|
||||
|
||||
<p> Generate log from unreleased closed issues only.</p>
|
||||
|
||||
<p> --[no-]unreleased</p>
|
||||
|
||||
<p> Add to log unreleased closed issues. Default is true</p>
|
||||
|
||||
<p> --unreleased-label [label]</p>
|
||||
|
||||
<p> Add to log unreleased closed issues. Default is true</p>
|
||||
|
||||
<p> --[no-]compare-link</p>
|
||||
|
||||
<p> Include compare link (Full Changelog) between older version and newer version. Default is true</p>
|
||||
|
||||
<p> --include-labels x,y,z</p>
|
||||
|
||||
<p> Only issues with the specified labels will be included in the changelog.</p>
|
||||
|
||||
<p> --exclude-labels x,y,z</p>
|
||||
|
||||
<p> Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
|
||||
|
||||
<p> --bug-labels x,y,z</p>
|
||||
|
||||
<p> Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
|
||||
|
||||
<p> --enhancement-labels x,y,z</p>
|
||||
|
||||
<p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
|
||||
|
||||
<p> --between-tags x,y,z</p>
|
||||
|
||||
<p> Change log will be filled only between specified tags</p>
|
||||
|
||||
<p> --exclude-tags x,y,z</p>
|
||||
|
||||
<p> Change log will exclude specified tags</p>
|
||||
|
||||
<p> --since-tag x</p>
|
||||
|
||||
<p> Change log will start after specified tag</p>
|
||||
|
||||
<p> --due-tag x</p>
|
||||
|
||||
<p> Change log will end before specified tag</p>
|
||||
|
||||
<p> --max-issues [NUMBER]</p>
|
||||
|
||||
<p> Max number of issues to fetch from GitHub. Default is unlimited</p>
|
||||
|
||||
<p> --release-url [URL]</p>
|
||||
|
||||
<p> The URL to point to for release links, in printf format (with the tag as variable).</p>
|
||||
|
||||
<p> --github-site [URL]</p>
|
||||
|
||||
<p> The Enterprise Github site on which your project is hosted.</p>
|
||||
|
||||
<p> --github-api [URL]</p>
|
||||
|
||||
<p> The enterprise endpoint to use for your Github API.</p>
|
||||
|
||||
<p> --simple-list</p>
|
||||
|
||||
<p> Create simple list from issues and pull requests. Default is false.</p>
|
||||
|
||||
<p> --future-release [RELEASE-VERSION]</p>
|
||||
|
||||
<p> Put the unreleased changes in the specified release number.</p>
|
||||
|
||||
<p> --[no-]verbose</p>
|
||||
|
||||
<p> Run verbosely. Default is true</p>
|
||||
|
||||
<p> -v, --version</p>
|
||||
|
||||
<p> Print version number</p>
|
||||
|
||||
<p> -h, --help</p>
|
||||
|
||||
<p> Displays Help</p>
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<p>Written by Petr Korolev sky4winder@gmail.com</p>
|
||||
|
||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
||||
|
||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>></p>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<p><<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>></p>
|
||||
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>October 2015</li>
|
||||
<li class='tr'>git-generate-changelog(1)</li>
|
||||
</ol>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
179
man/git-generate-changelog.md
Normal file
179
man/git-generate-changelog.md
Normal file
@@ -0,0 +1,179 @@
|
||||
git-generate-changelog(1) - Generate changelog from github
|
||||
================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
-u, --user [USER]
|
||||
|
||||
Username of the owner of target GitHub repo
|
||||
|
||||
-p, --project [PROJECT]
|
||||
|
||||
Name of project on GitHub
|
||||
|
||||
-t, --token [TOKEN]
|
||||
|
||||
To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
|
||||
|
||||
-f, --date-format [FORMAT]
|
||||
|
||||
Date format. Default is %Y-%m-%d
|
||||
|
||||
-o, --output [NAME]
|
||||
|
||||
Output file. Default is CHANGELOG.md
|
||||
|
||||
-b, --base [NAME]
|
||||
|
||||
Optional base file to append generated changes to.
|
||||
|
||||
--bugs-label [LABEL]
|
||||
|
||||
Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
|
||||
|
||||
--enhancement-label [LABEL]
|
||||
|
||||
Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
|
||||
|
||||
--issues-label [LABEL]
|
||||
|
||||
Setup custom label for closed-issues section. Default is "**Closed issues:**"
|
||||
|
||||
--header-label [LABEL]
|
||||
|
||||
Setup custom header label. Default is "# Change Log"
|
||||
|
||||
--pr-label [LABEL]
|
||||
|
||||
Setup custom label for pull requests section. Default is "**Merged pull requests:**"
|
||||
|
||||
--[no-]issues
|
||||
|
||||
Include closed issues in changelog. Default is true
|
||||
|
||||
--[no-]issues-wo-labels
|
||||
|
||||
Include closed issues without labels in changelog. Default is true
|
||||
|
||||
--[no-]pr-wo-labels
|
||||
|
||||
Include pull requests without labels in changelog. Default is true
|
||||
|
||||
--[no-]pull-requests
|
||||
|
||||
Include pull-requests in changelog. Default is true
|
||||
|
||||
--[no-]filter-by-milestone
|
||||
|
||||
Use milestone to detect when issue was resolved. Default is true
|
||||
|
||||
--[no-]author
|
||||
|
||||
Add author of pull-request in the end. Default is true
|
||||
|
||||
--unreleased-only
|
||||
|
||||
Generate log from unreleased closed issues only.
|
||||
|
||||
--[no-]unreleased
|
||||
|
||||
Add to log unreleased closed issues. Default is true
|
||||
|
||||
--unreleased-label [label]
|
||||
|
||||
Add to log unreleased closed issues. Default is true
|
||||
|
||||
--[no-]compare-link
|
||||
|
||||
Include compare link (Full Changelog) between older version and newer version. Default is true
|
||||
|
||||
--include-labels x,y,z
|
||||
|
||||
Only issues with the specified labels will be included in the changelog.
|
||||
|
||||
--exclude-labels x,y,z
|
||||
|
||||
Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
||||
|
||||
--bug-labels x,y,z
|
||||
|
||||
Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
|
||||
|
||||
--enhancement-labels x,y,z
|
||||
|
||||
Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
|
||||
|
||||
--between-tags x,y,z
|
||||
|
||||
Change log will be filled only between specified tags
|
||||
|
||||
--exclude-tags x,y,z
|
||||
|
||||
Change log will exclude specified tags
|
||||
|
||||
--since-tag x
|
||||
|
||||
Change log will start after specified tag
|
||||
|
||||
--due-tag x
|
||||
|
||||
Change log will end before specified tag
|
||||
|
||||
--max-issues [NUMBER]
|
||||
|
||||
Max number of issues to fetch from GitHub. Default is unlimited
|
||||
|
||||
--release-url [URL]
|
||||
|
||||
The URL to point to for release links, in printf format (with the tag as variable).
|
||||
|
||||
--github-site [URL]
|
||||
|
||||
The Enterprise Github site on which your project is hosted.
|
||||
|
||||
--github-api [URL]
|
||||
|
||||
The enterprise endpoint to use for your Github API.
|
||||
|
||||
--simple-list
|
||||
|
||||
Create simple list from issues and pull requests. Default is false.
|
||||
|
||||
--future-release [RELEASE-VERSION]
|
||||
|
||||
Put the unreleased changes in the specified release number.
|
||||
|
||||
--[no-]verbose
|
||||
|
||||
Run verbosely. Default is true
|
||||
|
||||
-v, --version
|
||||
|
||||
Print version number
|
||||
|
||||
-h, --help
|
||||
|
||||
Displays Help
|
||||
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
## AUTHOR
|
||||
|
||||
Written by Petr Korolev sky4winder@gmail.com
|
||||
|
||||
## REPORTING BUGS
|
||||
|
||||
<<https://github.com/skywinder/github-changelog-generator/issues>>
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
<<https://github.com/skywinder/github-changelog-generator/>>
|
||||
0
spec/files/github_changelog_params_empty
Normal file
0
spec/files/github_changelog_params_empty
Normal file
2
spec/files/github_changelog_params_incorrect
Normal file
2
spec/files/github_changelog_params_incorrect
Normal file
@@ -0,0 +1,2 @@
|
||||
unreleased_label: staging
|
||||
unreleased: false
|
||||
3
spec/files/github_changelog_params_override
Normal file
3
spec/files/github_changelog_params_override
Normal file
@@ -0,0 +1,3 @@
|
||||
unreleased_label=staging
|
||||
unreleased=false
|
||||
header==== Changelog ===
|
||||
@@ -31,91 +31,25 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
||||
SimpleCov.start
|
||||
|
||||
require "github_changelog_generator"
|
||||
require "github_changelog_generator/task"
|
||||
|
||||
# This file was generated by the `rspec --init` command. Conventionally, all
|
||||
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
|
||||
# The generated `.rspec` file contains `--require spec_helper` which will cause
|
||||
# this file to always be loaded, without a need to explicitly require it in any
|
||||
# files.
|
||||
#
|
||||
# Given that it is always loaded, you are encouraged to keep this file as
|
||||
# light-weight as possible. Requiring heavyweight dependencies from this file
|
||||
# will add to the boot time of your test suite on EVERY test run, even for an
|
||||
# individual file that may not need all of that loaded. Instead, consider making
|
||||
# a separate helper file that requires the additional dependencies and performs
|
||||
# the additional setup, and require it from the spec files that actually need
|
||||
# it.
|
||||
#
|
||||
# The `.rspec` file also contains a few flags that are not defaults but that
|
||||
# users commonly want.
|
||||
#
|
||||
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
|
||||
RSpec.configure do |config|
|
||||
# rspec-expectations config goes here. You can use an alternate
|
||||
# assertion/expectation library such as wrong or the stdlib/minitest
|
||||
# assertions if you prefer.
|
||||
config.expect_with :rspec do |expectations|
|
||||
# This option will default to `true` in RSpec 4. It makes the `description`
|
||||
# and `failure_message` of custom matchers include text for helper methods
|
||||
# defined using `chain`, e.g.:
|
||||
# be_bigger_than(2).and_smaller_than(4).description
|
||||
# # => "be bigger than 2 and smaller than 4"
|
||||
# ...rather than:
|
||||
# # => "be bigger than 2"
|
||||
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||
end
|
||||
|
||||
# rspec-mocks config goes here. You can use an alternate test double
|
||||
# library (such as bogus or mocha) by changing the `mock_with` option here.
|
||||
config.mock_with :rspec do |mocks|
|
||||
# Prevents you from mocking or stubbing a method that does not exist on
|
||||
# a real object. This is generally recommended, and will default to
|
||||
# `true` in RSpec 4.
|
||||
mocks.verify_partial_doubles = true
|
||||
end
|
||||
|
||||
# These two settings work together to allow you to limit a spec run
|
||||
# to individual examples or groups you care about by tagging them with
|
||||
# `:focus` metadata. When nothing is tagged with `:focus`, all examples
|
||||
# get run.
|
||||
config.filter_run :focus
|
||||
config.run_all_when_everything_filtered = true
|
||||
|
||||
# Limits the available syntax to the non-monkey patched syntax that is
|
||||
# recommended. For more details, see:
|
||||
# - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
|
||||
# - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
|
||||
# - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
|
||||
# config.disable_monkey_patching!
|
||||
|
||||
# This setting enables warnings. It's recommended, but in some cases may
|
||||
# be too noisy due to issues in dependencies.
|
||||
config.warnings = true
|
||||
|
||||
# Many RSpec users commonly either run the entire suite or an individual
|
||||
# file, and it's useful to allow more verbose output when running an
|
||||
# individual spec file.
|
||||
if config.files_to_run.one?
|
||||
# Use the documentation formatter for detailed output,
|
||||
# unless a formatter has already been configured
|
||||
# (e.g. via a command-line flag).
|
||||
config.default_formatter = "doc"
|
||||
end
|
||||
config.default_formatter = "doc" if config.files_to_run.one?
|
||||
|
||||
# Print the 10 slowest examples and example groups at the
|
||||
# end of the spec run, to help surface which specs are running
|
||||
# particularly slow.
|
||||
# config.profile_examples = 10
|
||||
|
||||
# Run specs in random order to surface order dependencies. If you find an
|
||||
# order dependency and want to debug it, you can fix the order by providing
|
||||
# the seed, which is printed after each run.
|
||||
# --seed 1234
|
||||
config.order = :random
|
||||
|
||||
# Seed global randomization in this process using the `--seed` CLI option.
|
||||
# Setting this allows you to use `--seed` to deterministically reproduce
|
||||
# test failures related to randomization by passing the same `--seed` value
|
||||
# as the one that triggered the failure.
|
||||
Kernel.srand config.seed
|
||||
end
|
||||
|
||||
@@ -87,6 +87,86 @@ describe GitHubChangelogGenerator::Generator do
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
|
||||
context "with regex exclude_tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||
end
|
||||
|
||||
context "with non-matching regex in exclude_tags" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
describe "#filter_since_tag" do
|
||||
context "with filled array" do
|
||||
subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||
|
||||
context "with valid since tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
|
||||
end
|
||||
|
||||
context "with invalid since tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
context "with empty array" do
|
||||
subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
|
||||
|
||||
context "with valid since tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||
end
|
||||
|
||||
context "with invalid since tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#filter_due_tag" do
|
||||
context "with filled array" do
|
||||
subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
|
||||
|
||||
context "with valid due tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
|
||||
end
|
||||
|
||||
context "with invalid due tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
|
||||
end
|
||||
end
|
||||
|
||||
context "with empty array" do
|
||||
subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
|
||||
|
||||
context "with valid due tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||
end
|
||||
|
||||
context "with invalid due tag" do
|
||||
let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
|
||||
it { is_expected.to be_a Array }
|
||||
it { is_expected.to match_array(tags_mash_from_strings(%w())) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#get_time_of_tag" do
|
||||
|
||||
41
spec/unit/parse_file_spec.rb
Normal file
41
spec/unit/parse_file_spec.rb
Normal file
@@ -0,0 +1,41 @@
|
||||
describe GitHubChangelogGenerator::ParserFile do
|
||||
describe ".github_changelog_generator" do
|
||||
context "when no has file" do
|
||||
let(:options) { {} }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
subject { parse.parse! }
|
||||
it { is_expected.to be_nil }
|
||||
end
|
||||
|
||||
context "when file is empty" do
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
|
||||
it "does not change the options" do
|
||||
expect { parse.parse! }.to_not change { options }
|
||||
end
|
||||
end
|
||||
|
||||
context "when file is incorrect" do
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
|
||||
let(:options_before_change) { options.dup }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
it { expect { parse.parse! }.to raise_error }
|
||||
end
|
||||
|
||||
context "when override default values" do
|
||||
let(:default_options) { GitHubChangelogGenerator::Parser.get_default_options }
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
|
||||
let(:options_before_change) { options.dup }
|
||||
let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
|
||||
|
||||
it "changes the options" do
|
||||
expect { parse.parse! }.to change { options }
|
||||
.from(options_before_change)
|
||||
.to(options_before_change.merge(unreleased_label: "staging",
|
||||
unreleased: false,
|
||||
header: "=== Changelog ==="))
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user