Compare commits
187 Commits
feature/oc
...
1.10.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7aed6aa528 | ||
|
|
9ddc676a44 | ||
|
|
1b9a251c6b | ||
|
|
88ec105c7d | ||
|
|
3a784b16d6 | ||
|
|
0cc7065efc | ||
|
|
53df784ec3 | ||
|
|
d81cb5fcb7 | ||
|
|
8c8c7c4d3c | ||
|
|
34b8fc7217 | ||
|
|
6d02c509cd | ||
|
|
ac1c70978d | ||
|
|
670ced30e3 | ||
|
|
b0b4b1cf0a | ||
|
|
af97beeb60 | ||
|
|
384b080ad0 | ||
|
|
0e4c775ce4 | ||
|
|
c6eac743b6 | ||
|
|
033c7e8d79 | ||
|
|
bffe7cd9ff | ||
|
|
9832dce93c | ||
|
|
d2fa9d3565 | ||
|
|
8f7af37d1e | ||
|
|
12bc3550e1 | ||
|
|
5d5a48e00e | ||
|
|
35b581240f | ||
|
|
01a0c05a02 | ||
|
|
90ea75c471 | ||
|
|
46aaa5f205 | ||
|
|
95d32abbcb | ||
|
|
47c0332b55 | ||
|
|
c63b2e1fb9 | ||
|
|
29fd202ed0 | ||
|
|
fc1fb2eb9a | ||
|
|
afbb47ecf3 | ||
|
|
1d1965e7fb | ||
|
|
06a8fe8169 | ||
|
|
138abfe676 | ||
|
|
3fdf0c64df | ||
|
|
645f96ace6 | ||
|
|
dfdeb0e633 | ||
|
|
8d44b16e73 | ||
|
|
a6e6363cdd | ||
|
|
dd0d82ab91 | ||
|
|
8a87be8f4e | ||
|
|
8f78bb0cc6 | ||
|
|
b1d2b7d828 | ||
|
|
3fb75c825f | ||
|
|
d227464c33 | ||
|
|
5a9928c18a | ||
|
|
2dda090e6b | ||
|
|
38ddf055ae | ||
|
|
92ade3a625 | ||
|
|
3d1789a2d1 | ||
|
|
4f64cdb7d5 | ||
|
|
99ffa3692b | ||
|
|
fdb89ea805 | ||
|
|
b7fff7b764 | ||
|
|
6d36d007ad | ||
|
|
9dea79fe40 | ||
|
|
693f5ee2ee | ||
|
|
e6eb9f5bb6 | ||
|
|
916df554af | ||
|
|
d959639e2a | ||
|
|
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 | ||
|
|
d081130e3e | ||
|
|
016f5e690c | ||
|
|
cb4533abf7 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -0,0 +1 @@
|
||||
coverage/
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
sudo: false
|
||||
cache: bundler
|
||||
language: ruby
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
rvm:
|
||||
- 2.1.0
|
||||
script:
|
||||
|
||||
184
CHANGELOG.md
184
CHANGELOG.md
@@ -1,7 +1,105 @@
|
||||
# Change Log
|
||||
|
||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
|
||||
- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
|
||||
|
||||
## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
|
||||
- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
|
||||
|
||||
## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
|
||||
|
||||
## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
|
||||
|
||||
## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
|
||||
- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
|
||||
- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
|
||||
- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
|
||||
- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
|
||||
- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
|
||||
- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
|
||||
|
||||
## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
|
||||
- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
|
||||
|
||||
## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
|
||||
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
@@ -9,7 +107,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 +118,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 +145,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 +154,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 +179,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 +193,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 +224,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 +231,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 +238,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 +245,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 +266,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 +275,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 +292,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 +327,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 +341,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 +350,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 +373,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 +399,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 +419,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)*
|
||||
73
Gemfile.lock
73
Gemfile.lock
@@ -1,62 +1,59 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
github_changelog_generator (1.6.2)
|
||||
github_changelog_generator (1.10.0)
|
||||
colorize (~> 0.7)
|
||||
github_api (~> 0.12)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.3.8)
|
||||
ast (2.0.0)
|
||||
addressable (2.4.0)
|
||||
ast (2.2.0)
|
||||
astrolabe (1.3.1)
|
||||
parser (~> 2.2)
|
||||
codeclimate-test-reporter (0.4.7)
|
||||
codeclimate-test-reporter (0.4.8)
|
||||
simplecov (>= 0.7.1, < 1.0.0)
|
||||
colorize (0.7.7)
|
||||
coveralls (0.8.2)
|
||||
coveralls (0.8.10)
|
||||
json (~> 1.8)
|
||||
rest-client (>= 1.6.8, < 2)
|
||||
simplecov (~> 0.10.0)
|
||||
simplecov (~> 0.11.0)
|
||||
term-ansicolor (~> 1.3)
|
||||
thor (~> 0.19.1)
|
||||
tins (~> 1.6.0)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
diff-lcs (1.2.5)
|
||||
docile (1.1.5)
|
||||
domain_name (0.5.24)
|
||||
domain_name (0.5.25)
|
||||
unf (>= 0.0.5, < 1.0.0)
|
||||
faraday (0.9.1)
|
||||
faraday (0.9.2)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
github_api (0.12.3)
|
||||
addressable (~> 2.3)
|
||||
github_api (0.13.1)
|
||||
addressable (~> 2.4.0)
|
||||
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)
|
||||
oauth2
|
||||
hashie (3.4.2)
|
||||
hashie (3.4.3)
|
||||
http-cookie (1.0.2)
|
||||
domain_name (~> 0.5)
|
||||
json (1.8.3)
|
||||
jwt (1.5.1)
|
||||
mime-types (2.6.1)
|
||||
mini_portile (0.6.2)
|
||||
jwt (1.5.2)
|
||||
mime-types (2.99)
|
||||
multi_json (1.11.2)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
netrc (0.10.3)
|
||||
nokogiri (1.6.6.2)
|
||||
mini_portile (~> 0.6.0)
|
||||
netrc (0.11.0)
|
||||
oauth2 (1.0.0)
|
||||
faraday (>= 0.8, < 0.10)
|
||||
jwt (~> 1.0)
|
||||
multi_json (~> 1.3)
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
parser (2.2.2.6)
|
||||
parser (2.2.3.0)
|
||||
ast (>= 1.1, < 3.0)
|
||||
powerpack (0.1.1)
|
||||
rack (1.6.4)
|
||||
@@ -66,27 +63,28 @@ GEM
|
||||
http-cookie (>= 1.0.2, < 2.0)
|
||||
mime-types (>= 1.16, < 3.0)
|
||||
netrc (~> 0.7)
|
||||
rspec (3.3.0)
|
||||
rspec-core (~> 3.3.0)
|
||||
rspec-expectations (~> 3.3.0)
|
||||
rspec-mocks (~> 3.3.0)
|
||||
rspec-core (3.3.2)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-expectations (3.3.1)
|
||||
rspec (3.4.0)
|
||||
rspec-core (~> 3.4.0)
|
||||
rspec-expectations (~> 3.4.0)
|
||||
rspec-mocks (~> 3.4.0)
|
||||
rspec-core (3.4.1)
|
||||
rspec-support (~> 3.4.0)
|
||||
rspec-expectations (3.4.0)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-mocks (3.3.2)
|
||||
rspec-support (~> 3.4.0)
|
||||
rspec-mocks (3.4.0)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.3.0)
|
||||
rspec-support (3.3.0)
|
||||
rubocop (0.32.1)
|
||||
rspec-support (~> 3.4.0)
|
||||
rspec-support (3.4.1)
|
||||
rubocop (0.35.1)
|
||||
astrolabe (~> 1.3)
|
||||
parser (>= 2.2.2.5, < 3.0)
|
||||
parser (>= 2.2.3.0, < 3.0)
|
||||
powerpack (~> 0.1)
|
||||
rainbow (>= 1.99.1, < 3.0)
|
||||
ruby-progressbar (~> 1.4)
|
||||
ruby-progressbar (~> 1.7)
|
||||
tins (<= 1.6.0)
|
||||
ruby-progressbar (1.7.5)
|
||||
simplecov (0.10.0)
|
||||
simplecov (0.11.1)
|
||||
docile (~> 1.1.0)
|
||||
json (~> 1.8)
|
||||
simplecov-html (~> 0.10.0)
|
||||
@@ -95,7 +93,7 @@ GEM
|
||||
tins (~> 1.0)
|
||||
thor (0.19.1)
|
||||
thread_safe (0.3.5)
|
||||
tins (1.5.4)
|
||||
tins (1.6.0)
|
||||
unf (0.1.4)
|
||||
unf_ext
|
||||
unf_ext (0.0.7.1)
|
||||
@@ -112,3 +110,6 @@ DEPENDENCIES
|
||||
rspec (~> 3.2)
|
||||
rubocop (~> 0.31)
|
||||
simplecov (~> 0.10)
|
||||
|
||||
BUNDLED WITH
|
||||
1.10.6
|
||||
|
||||
38
README.md
38
README.md
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
|
||||
### *Why should I care?*
|
||||
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
||||
|
||||
> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com/)*
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -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 wouldn'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).
|
||||
|
||||
@@ -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,8 @@
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
|
||||
- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
|
||||
- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
|
||||
- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
|
||||
@user = @options[:user]
|
||||
@project = @options[:project]
|
||||
@github_token = fetch_github_token
|
||||
github_options = { per_page: PER_PAGE_NUMBER }
|
||||
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||
github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
||||
github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
|
||||
@github_options = { per_page: PER_PAGE_NUMBER }
|
||||
@github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||
@github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
|
||||
@github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
|
||||
|
||||
@github = check_github_response { Github.new github_options }
|
||||
@github = check_github_response { Github.new @github_options }
|
||||
end
|
||||
|
||||
# Returns GitHub token. First try to use variable, provided by --token option,
|
||||
@@ -123,7 +123,16 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
|
||||
def fetch_closed_pull_requests
|
||||
pull_requests = []
|
||||
begin
|
||||
response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
|
||||
if @options[:release_branch].nil?
|
||||
response = @github.pull_requests.list @options[:user],
|
||||
@options[:project],
|
||||
state: "closed"
|
||||
else
|
||||
response = @github.pull_requests.list @options[:user],
|
||||
@options[:project],
|
||||
state: "closed",
|
||||
base: @options[:release_branch]
|
||||
end
|
||||
page_i = 0
|
||||
count_pages = response.count_pages
|
||||
response.each_page do |page|
|
||||
@@ -163,10 +172,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)
|
||||
|
||||
@@ -178,9 +178,11 @@ module GitHubChangelogGenerator
|
||||
fetched_pr = closed_pull_requests.find do |fpr|
|
||||
fpr.number == pr.number
|
||||
end
|
||||
if fetched_pr
|
||||
pr[:merged_at] = fetched_pr[:merged_at]
|
||||
closed_pull_requests.delete(fetched_pr)
|
||||
end
|
||||
end
|
||||
|
||||
pull_requests.select! do |pr|
|
||||
!pr[:merged_at].nil?
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -7,30 +7,33 @@ module GitHubChangelogGenerator
|
||||
class Parser
|
||||
# parse options with optparse
|
||||
def self.parse_options
|
||||
options = get_default_options
|
||||
options = default_options
|
||||
|
||||
ParserFile.new(options).parse!
|
||||
|
||||
parser = setup_parser(options)
|
||||
|
||||
parser.parse!
|
||||
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
detect_user_and_project(options)
|
||||
end
|
||||
user_and_project_from_git(options)
|
||||
|
||||
if !options[:user] || !options[:project]
|
||||
puts parser.banner
|
||||
exit
|
||||
end
|
||||
abort(parser.banner) unless options[:user] && options[:project]
|
||||
|
||||
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 +53,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 +116,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
|
||||
@@ -128,6 +143,9 @@ module GitHubChangelogGenerator
|
||||
opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
|
||||
options[:future_release] = future_release
|
||||
end
|
||||
opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
|
||||
options[:release_branch] = release_branch
|
||||
end
|
||||
opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
|
||||
options[:verbose] = v
|
||||
end
|
||||
@@ -144,12 +162,13 @@ module GitHubChangelogGenerator
|
||||
end
|
||||
|
||||
# just get default options
|
||||
def self.get_default_options
|
||||
options = {
|
||||
def self.default_options
|
||||
{
|
||||
tag1: nil,
|
||||
tag2: nil,
|
||||
date_format: "%Y-%m-%d",
|
||||
output: "CHANGELOG.md",
|
||||
base: "HISTORY.md",
|
||||
issues: true,
|
||||
add_issues_wo_labels: true,
|
||||
add_pr_wo_labels: true,
|
||||
@@ -172,14 +191,19 @@ module GitHubChangelogGenerator
|
||||
enhancement_prefix: "**Implemented enhancements:**",
|
||||
git_remote: "origin"
|
||||
}
|
||||
end
|
||||
|
||||
options
|
||||
def self.user_and_project_from_git(options)
|
||||
if options[:user].nil? || options[:project].nil?
|
||||
detect_user_and_project(options, ARGV[0], ARGV[1])
|
||||
end
|
||||
end
|
||||
|
||||
# Detects user and project from git
|
||||
def self.detect_user_and_project(options)
|
||||
options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
|
||||
if !options[:user] || !options[:project]
|
||||
def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
|
||||
options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
|
||||
return if options[:user] && options[:project]
|
||||
|
||||
if ENV["RUBYLIB"] =~ /ruby-debug-ide/
|
||||
options[:user] = "skywinder"
|
||||
options[:project] = "changelog_test"
|
||||
@@ -188,13 +212,12 @@ module GitHubChangelogGenerator
|
||||
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)
|
||||
def self.user_project_from_option(arg0, arg1, github_site)
|
||||
user = nil
|
||||
project = nil
|
||||
github_site ||= "github.com"
|
||||
@@ -207,10 +230,10 @@ module GitHubChangelogGenerator
|
||||
param = match[2].nil?
|
||||
rescue
|
||||
puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
|
||||
exit
|
||||
return
|
||||
end
|
||||
if param
|
||||
exit
|
||||
return
|
||||
else
|
||||
user = match[1]
|
||||
project = match[2]
|
||||
@@ -253,9 +276,4 @@ module GitHubChangelogGenerator
|
||||
[user, project]
|
||||
end
|
||||
end
|
||||
|
||||
if __FILE__ == $PROGRAM_NAME
|
||||
remote = "invalid reference to project"
|
||||
p user_project_from_option(ARGV[0], ARGV[1], remote)
|
||||
end
|
||||
end
|
||||
|
||||
39
lib/github_changelog_generator/parser_file.rb
Normal file
39
lib/github_changelog_generator/parser_file.rb
Normal file
@@ -0,0 +1,39 @@
|
||||
module GitHubChangelogGenerator
|
||||
ParserError = Class.new(StandardError)
|
||||
|
||||
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 ParserError, "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
|
||||
@@ -53,31 +53,28 @@ module GitHubChangelogGenerator
|
||||
|
||||
@heading_structures.each do |regexp|
|
||||
matches = Regexp.new(regexp).match(heading)
|
||||
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
|
||||
|
||||
# Try Regular Expressions until you find one that delivers results
|
||||
break unless matches.nil?
|
||||
if matches
|
||||
captures.merge!(Hash[matches.names.zip(matches.captures)])
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
captures
|
||||
end
|
||||
|
||||
# Parse the given ChangeLog data into a Hash
|
||||
# Parse the given ChangeLog data into a list of Hashes
|
||||
#
|
||||
# @param [String] data File data from the ChangeLog.md
|
||||
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||
# @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||
def parse(data)
|
||||
sections = data.split(/^## .+?$/)
|
||||
headings = data.scan(/^## .+?$/)
|
||||
changelog = []
|
||||
|
||||
headings.each_with_index do |heading, index|
|
||||
captures = parse_heading(heading)
|
||||
captures["content"] = sections.at(index + 1)
|
||||
changelog.push captures
|
||||
headings.each_with_index.map do |heading, index|
|
||||
section = parse_heading(heading)
|
||||
section["content"] = sections.at(index + 1)
|
||||
section
|
||||
end
|
||||
|
||||
changelog
|
||||
end
|
||||
|
||||
def read(file_path)
|
||||
|
||||
67
lib/github_changelog_generator/task.rb
Normal file
67
lib/github_changelog_generator/task.rb
Normal file
@@ -0,0 +1,67 @@
|
||||
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 release_branch verbose release_url
|
||||
base )
|
||||
|
||||
OPTIONS.each do |o|
|
||||
attr_accessor o.to_sym
|
||||
end
|
||||
|
||||
# Public: Initialise a new GitHubChangelogGenerator::RakeTask.
|
||||
#
|
||||
# Example
|
||||
#
|
||||
# GitHubChangelogGenerator::RakeTask.new
|
||||
def initialize(*args, &task_block)
|
||||
@name = args.shift || :changelog
|
||||
|
||||
define(args, &task_block)
|
||||
end
|
||||
|
||||
def define(args, &task_block)
|
||||
desc "Generate a Change log from GitHub"
|
||||
|
||||
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.default_options
|
||||
|
||||
Parser.user_and_project_from_git(options)
|
||||
|
||||
OPTIONS.each do |o|
|
||||
v = instance_variable_get("@#{o}")
|
||||
options[o.to_sym] = v unless v.nil?
|
||||
end
|
||||
|
||||
generator = Generator.new options
|
||||
|
||||
log = generator.compound_changelog
|
||||
|
||||
output_filename = "#{options[:output]}"
|
||||
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.6.2"
|
||||
VERSION = "1.10.1"
|
||||
end
|
||||
|
||||
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(GitHubChangelogGenerator::ParserError) }
|
||||
end
|
||||
|
||||
context "when override default values" do
|
||||
let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
|
||||
let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
|
||||
let(:options_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
|
||||
@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
|
||||
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) }
|
||||
it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
|
||||
end
|
||||
|
||||
context "when option is valid" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
|
||||
end
|
||||
context "when option nil" do
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
|
||||
subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
|
||||
it { is_expected.to be_a(Array) }
|
||||
it { is_expected.to match_array([nil, nil]) }
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user