Compare commits
376 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
27fa9e8e02 | ||
|
|
0706f89c02 | ||
|
|
419e7e78ad | ||
|
|
6159ebba2f | ||
|
|
3a200e943c | ||
|
|
4dc5a094d2 | ||
|
|
07d52c9465 | ||
|
|
02b0f95ab0 | ||
|
|
0b1f0319db | ||
|
|
c20529bf32 | ||
|
|
26c393c2cc | ||
|
|
f8f887093a | ||
|
|
63bf4a59d4 | ||
|
|
af189dc66f | ||
|
|
917041424b | ||
|
|
2e5099efee | ||
|
|
9685d79f61 | ||
|
|
fb6b3dad5b | ||
|
|
8d27718648 | ||
|
|
8f8be4740d | ||
|
|
26bd24b7d2 | ||
|
|
049599a0a4 | ||
|
|
fcbf661d32 | ||
|
|
d1636ccb1d | ||
|
|
98cdd685b9 | ||
|
|
84c52dba98 | ||
|
|
b1428c894a | ||
|
|
0d72f1236d | ||
|
|
e3a8a0ed32 | ||
|
|
8243f6f00c | ||
|
|
2b5c1297b1 | ||
|
|
7f68f3db13 | ||
|
|
3e2978357c | ||
|
|
4a53f4a126 | ||
|
|
0163bf1844 | ||
|
|
059d6daf6a | ||
|
|
931c90cecd | ||
|
|
911e6a6e6f | ||
|
|
8201de3758 | ||
|
|
8ffe5a168b | ||
|
|
8de7464490 | ||
|
|
215daa4ede | ||
|
|
26be13eb11 | ||
|
|
8a5dc8830b | ||
|
|
909e192e76 | ||
|
|
48cb34e735 | ||
|
|
d2c5775658 | ||
|
|
711241621f | ||
|
|
b34128fdb3 | ||
|
|
54eb81bc6a | ||
|
|
035d9d5c19 | ||
|
|
004b37b7b9 | ||
|
|
21de5f02ca | ||
|
|
082c83b8e6 | ||
|
|
3f5d182e7a | ||
|
|
92066155ea | ||
|
|
2039cacba5 | ||
|
|
3a6670cc02 | ||
|
|
2918d9c385 | ||
|
|
a40105b718 | ||
|
|
08f61216c8 | ||
|
|
03c7a51cd5 | ||
|
|
2edd6097bd | ||
|
|
3a0c6a8558 | ||
|
|
6cb5a60322 | ||
|
|
9e6d29d013 | ||
|
|
922fa9fc7e | ||
|
|
b36037c49f | ||
|
|
4f4bae5719 | ||
|
|
1d8b1f40b5 | ||
|
|
cd5aa7be1c | ||
|
|
d16c4109dc | ||
|
|
27ab2a906c | ||
|
|
b107671a66 | ||
|
|
a1618367f1 | ||
|
|
39a4ef3f3f | ||
|
|
dd2be24d3b | ||
|
|
5422e58508 | ||
|
|
c4f91f55ff | ||
|
|
1dd82cddf4 | ||
|
|
c8db84a4a5 | ||
|
|
563ddb7f30 | ||
|
|
1d7f09e9bb | ||
|
|
48e3a75251 | ||
|
|
9b8291ab69 | ||
|
|
904017cf4d | ||
|
|
a90c276a9f | ||
|
|
31137c2ca4 | ||
|
|
9ce7dd736a | ||
|
|
e6dc367f99 | ||
|
|
454bfb5a86 | ||
|
|
07073ea02c | ||
|
|
3e981bb741 | ||
|
|
49bf02c6d3 | ||
|
|
6c0fbf52a3 | ||
|
|
da2ae851a7 | ||
|
|
3ad085b73c | ||
|
|
8ca7b4c5c4 | ||
|
|
5545ffcf23 | ||
|
|
3bf0cded56 | ||
|
|
67993a334b | ||
|
|
2f3bb3f7a5 | ||
|
|
eac2cf5a65 | ||
|
|
9c19ae00b1 | ||
|
|
53ec89beb0 | ||
|
|
abebd4c81b | ||
|
|
bcae804809 | ||
|
|
f8a59643ca | ||
|
|
7eaf5496d9 | ||
|
|
0fae773de6 | ||
|
|
6abbda27e1 | ||
|
|
37d277e70f | ||
|
|
a124b63668 | ||
|
|
b7c4656c75 | ||
|
|
54166a444a | ||
|
|
f2caab5275 | ||
|
|
e50ab5318d | ||
|
|
9d49b1488a | ||
|
|
3a9eca4233 | ||
|
|
04f1173616 | ||
|
|
0eacd9acda | ||
|
|
c3884b9a55 | ||
|
|
2cd6ba620d | ||
|
|
c73142e169 | ||
|
|
70543e854b | ||
|
|
721357d65f | ||
|
|
4b59f3bd65 | ||
|
|
7d526de165 | ||
|
|
cf0a032fb6 | ||
|
|
e8e0399341 | ||
|
|
615b38476c | ||
|
|
a53883ba0e | ||
|
|
ca27b7c21e | ||
|
|
1607407ab4 | ||
|
|
c1c6d835af | ||
|
|
205bdfb39b | ||
|
|
2b603e8b26 | ||
|
|
b5acd63d81 | ||
|
|
9525cdeba8 | ||
|
|
a6897c6a86 | ||
|
|
3c33893606 | ||
|
|
1bc2e64e28 | ||
|
|
4431f26457 | ||
|
|
1eee70bfe5 | ||
|
|
e6f12421ff | ||
|
|
f668aedafc | ||
|
|
ae92488d6d | ||
|
|
cf4692c7b0 | ||
|
|
69e3b17d8b | ||
|
|
82d8c72a4d | ||
|
|
7af782d0b3 | ||
|
|
192816924f | ||
|
|
b39c644509 | ||
|
|
ed06743b93 | ||
|
|
65059af038 | ||
|
|
32e085965c | ||
|
|
260e3bd666 | ||
|
|
b88179fecc | ||
|
|
be46bb4202 | ||
|
|
c06c0f0432 | ||
|
|
736abb3528 | ||
|
|
91c34e7f98 | ||
|
|
52d1e83888 | ||
|
|
99d20bd8a9 | ||
|
|
9b4f0187df | ||
|
|
f0e713d6ef | ||
|
|
8dc50cf483 | ||
|
|
90c455ada4 | ||
|
|
088824aa05 | ||
|
|
96977c8384 | ||
|
|
1940974c4c | ||
|
|
1fced7278e | ||
|
|
eb9bd59f26 | ||
|
|
41f43932e0 | ||
|
|
4ba7bbcc90 | ||
|
|
8505d340af | ||
|
|
f3c05bd01c | ||
|
|
4bcf49175b | ||
|
|
6c28db6d4a | ||
|
|
6f8aee6a4b | ||
|
|
3e3cc15592 | ||
|
|
d5edb1f606 | ||
|
|
e6d0c3d791 | ||
|
|
c1d28d486f | ||
|
|
fa713af816 | ||
|
|
17f7127de1 | ||
|
|
e1a264e2c9 | ||
|
|
e4b79e75ca | ||
|
|
c7a767451d | ||
|
|
01f44b8311 | ||
|
|
c0015a2c22 | ||
|
|
49cb6589f7 | ||
|
|
e139f839c9 | ||
|
|
a7a75a181e | ||
|
|
6efa421816 | ||
|
|
e8d59fe66a | ||
|
|
6b5cf5ab2e | ||
|
|
de6763aa3a | ||
|
|
5f019482d2 | ||
|
|
6da115c4b0 | ||
|
|
657ce0e838 | ||
|
|
5304e4faf8 | ||
|
|
e6bb728355 | ||
|
|
135c48a494 | ||
|
|
6bad92e899 | ||
|
|
ad4c20d8d8 | ||
|
|
a5d9766aef | ||
|
|
a0cfaa66a2 | ||
|
|
d16f4f7cb5 | ||
|
|
1d6d6ab400 | ||
|
|
5b07fc9614 | ||
|
|
3437fbf278 | ||
|
|
ba4db0e5f4 | ||
|
|
abac1013f1 | ||
|
|
28247edc7f | ||
|
|
fcc1c608a2 | ||
|
|
46ae40f250 | ||
|
|
00f98b8ca6 | ||
|
|
5da838efee | ||
|
|
73b789ab82 | ||
|
|
b5778b14a0 | ||
|
|
e29ff3c3a9 | ||
|
|
9646b49add | ||
|
|
a44b0bdd25 | ||
|
|
433d46d85b | ||
|
|
950e8916d9 | ||
|
|
87c6e33335 | ||
|
|
4488ac8cc6 | ||
|
|
c697c6be4a | ||
|
|
69dd5eadc2 | ||
|
|
4ea1058cd5 | ||
|
|
fcd78e6bc4 | ||
|
|
e6c0d49200 | ||
|
|
0f5db97474 | ||
|
|
0901b38577 | ||
|
|
2a24f49a83 | ||
|
|
2ad014d5c7 | ||
|
|
188ba7e073 | ||
|
|
6f53fe0a1d | ||
|
|
2c7853cf9f | ||
|
|
6830ea49f2 | ||
|
|
5be1a2afaf | ||
|
|
7be5021685 | ||
|
|
c3373b2343 | ||
|
|
9aa156a02b | ||
|
|
68a8d8d2c8 | ||
|
|
057fb488d5 | ||
|
|
f1d9c839c7 | ||
|
|
97d048d62f | ||
|
|
7972ec0977 | ||
|
|
f55598825d | ||
|
|
a678b52fe4 | ||
|
|
aac04726ba | ||
|
|
0c65035cde | ||
|
|
e038c7e680 | ||
|
|
bcecb4eb81 | ||
|
|
52123885a1 | ||
|
|
326a067ac5 | ||
|
|
5dcbef87d1 | ||
|
|
caf264360b | ||
|
|
bc13632545 | ||
|
|
67b438f46b | ||
|
|
ff52291d2a | ||
|
|
b2df1cfdcd | ||
|
|
f037a839ce | ||
|
|
5295389fcc | ||
|
|
8e5b4ed191 | ||
|
|
80cc3fc625 | ||
|
|
f087699d07 | ||
|
|
540df2ef51 | ||
|
|
54d029d8ea | ||
|
|
bec4fdef0e | ||
|
|
b5d5615244 | ||
|
|
766569c27a | ||
|
|
51e3c2ee54 | ||
|
|
e1e5de555b | ||
|
|
0e4474bb2d | ||
|
|
fa4ccb7e9c | ||
|
|
36fbe509fa | ||
|
|
4c5ca562cf | ||
|
|
27432c3328 | ||
|
|
4a27872695 | ||
|
|
bf88bc0a0e | ||
|
|
3b145bd7ed | ||
|
|
97311bc5a0 | ||
|
|
bdc4657e2c | ||
|
|
0c8a96aef8 | ||
|
|
c9462a6c9b | ||
|
|
0a43c25f8f | ||
|
|
c58ec0dcbb | ||
|
|
7aa9b6ca47 | ||
|
|
865a364dff | ||
|
|
062f3fd3f2 | ||
|
|
a4e9390283 | ||
|
|
09f5ac5d37 | ||
|
|
aed5c37559 | ||
|
|
9f9f237e96 | ||
|
|
3e1abf928d | ||
|
|
7ce486085b | ||
|
|
bf17d9e284 | ||
|
|
fadae1b714 | ||
|
|
a5cb604bc1 | ||
|
|
7f89aae72e | ||
|
|
b6ec9bd8be | ||
|
|
80de58779d | ||
|
|
07e0ec0cfb | ||
|
|
fab1e28e3e | ||
|
|
0ab44f79f7 | ||
|
|
269ab4e790 | ||
|
|
4fa903b5cd | ||
|
|
c018bf2db5 | ||
|
|
c830d6c1ef | ||
|
|
03bca478c8 | ||
|
|
91229c7472 | ||
|
|
7bd174126b | ||
|
|
4b716645e5 | ||
|
|
7b44c4aa78 | ||
|
|
95bdd60c34 | ||
|
|
1357b3980d | ||
|
|
a5c4899360 | ||
|
|
b30587ce14 | ||
|
|
18e0f937ea | ||
|
|
1af8e18f9f | ||
|
|
a458a1e378 | ||
|
|
bc3af7fa93 | ||
|
|
6682ffe452 | ||
|
|
dbc7b3e567 | ||
|
|
a96f74208c | ||
|
|
cdc009b4ad | ||
|
|
0046f344a9 | ||
|
|
1b792bc67b | ||
|
|
f0716771b5 | ||
|
|
50dd7b2ed6 | ||
|
|
3797b3ac31 | ||
|
|
f08685b015 | ||
|
|
fc96007741 | ||
|
|
7e2826e3b8 | ||
|
|
c55881bdfa | ||
|
|
f6f9facc71 | ||
|
|
807bacd95a | ||
|
|
936b191566 | ||
|
|
a33b52d6d0 | ||
|
|
337c9a7d59 | ||
|
|
8247fd8520 | ||
|
|
223cd2640c | ||
|
|
459b0ec7ec | ||
|
|
ea1c5c1f6d | ||
|
|
86512d3606 | ||
|
|
b908b07e0a | ||
|
|
737774a164 | ||
|
|
62d9b7f4a6 | ||
|
|
e75e358ef8 | ||
|
|
3ac83e9ea7 | ||
|
|
70d3f63e89 | ||
|
|
2db69dd27c | ||
|
|
5a7589f8ca | ||
|
|
1adcd9918c | ||
|
|
afea098355 | ||
|
|
d3c3b7850f | ||
|
|
502ae431b7 | ||
|
|
5882762800 | ||
|
|
606fab4289 | ||
|
|
3d25d1135f | ||
|
|
acd2daada3 | ||
|
|
381ffeb261 | ||
|
|
f9e6a076bc | ||
|
|
8457b764bf | ||
|
|
4237b751a0 | ||
|
|
3a78f97d61 | ||
|
|
24c5f66c65 | ||
|
|
9c4b68f779 | ||
|
|
65e978f4a8 | ||
|
|
6b4333f98a | ||
|
|
675601880d | ||
|
|
e2aac3cb2c | ||
|
|
20095c571d |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,2 +0,0 @@
|
||||
constants.rb
|
||||
*.md
|
||||
|
||||
15
.travis.yml
Normal file
15
.travis.yml
Normal file
@@ -0,0 +1,15 @@
|
||||
language: ruby
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem --version
|
||||
rvm:
|
||||
- 2.1.0
|
||||
gemfile:
|
||||
- Gemfile
|
||||
|
||||
notifications:
|
||||
email:
|
||||
recipients:
|
||||
- sky4winder+githubchangeloggenerator@gmail.com
|
||||
on_success: never # [always|never|change]
|
||||
on_failure: change # [always|never|change]
|
||||
269
CHANGELOG.md
Normal file
269
CHANGELOG.md
Normal file
@@ -0,0 +1,269 @@
|
||||
# Change Log
|
||||
|
||||
## [1.3.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.5) (2015-03-04)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.4...1.3.5)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/Github-Changelog-Generator/issues/60)
|
||||
|
||||
## [1.3.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.4) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/Github-Changelog-Generator/issues/59)
|
||||
|
||||
## [1.3.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.3) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/Github-Changelog-Generator/issues/58)
|
||||
|
||||
## [1.3.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.2) (2015-03-03)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/Github-Changelog-Generator/issues/57)
|
||||
|
||||
## [1.3.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.1) (2015-02-27)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.0...1.3.1)
|
||||
|
||||
## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
|
||||
|
||||
- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
|
||||
|
||||
- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
|
||||
|
||||
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
|
||||
|
||||
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||
|
||||
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||
|
||||
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||
|
||||
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
|
||||
|
||||
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
|
||||
|
||||
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
|
||||
|
||||
- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||
|
||||
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
||||
|
||||
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
|
||||
|
||||
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
|
||||
|
||||
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
|
||||
|
||||
- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||
|
||||
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
|
||||
|
||||
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
|
||||
|
||||
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
|
||||
|
||||
|
||||
|
||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||
3
Gemfile
3
Gemfile
@@ -1,3 +1,4 @@
|
||||
source 'https://rubygems.org'
|
||||
gem 'github_api'
|
||||
gem 'httparty'
|
||||
gem 'colorize'
|
||||
gem 'rake'
|
||||
|
||||
15
Gemfile.lock
15
Gemfile.lock
@@ -2,6 +2,7 @@ GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.3.6)
|
||||
colorize (0.7.4)
|
||||
descendants_tracker (0.0.4)
|
||||
thread_safe (~> 0.3, >= 0.3.1)
|
||||
faraday (0.9.0)
|
||||
@@ -14,17 +15,13 @@ GEM
|
||||
multi_json (>= 1.7.5, < 2.0)
|
||||
nokogiri (~> 1.6.3)
|
||||
oauth2
|
||||
hashie (3.3.1)
|
||||
httparty (0.13.2)
|
||||
json (~> 1.8)
|
||||
multi_xml (>= 0.5.2)
|
||||
json (1.8.1)
|
||||
jwt (1.0.0)
|
||||
hashie (3.3.2)
|
||||
jwt (1.2.0)
|
||||
mini_portile (0.6.1)
|
||||
multi_json (1.10.1)
|
||||
multi_xml (0.5.5)
|
||||
multipart-post (2.0.0)
|
||||
nokogiri (1.6.4)
|
||||
nokogiri (1.6.5)
|
||||
mini_portile (~> 0.6.0)
|
||||
oauth2 (1.0.0)
|
||||
faraday (>= 0.8, < 0.10)
|
||||
@@ -33,11 +30,13 @@ GEM
|
||||
multi_xml (~> 0.5)
|
||||
rack (~> 1.2)
|
||||
rack (1.5.2)
|
||||
rake (10.4.2)
|
||||
thread_safe (0.3.4)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
colorize
|
||||
github_api
|
||||
httparty
|
||||
rake
|
||||
|
||||
163
README.md
163
README.md
@@ -1,46 +1,153 @@
|
||||
Github Changelog Generator
|
||||
==================
|
||||
|
||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||
[](https://travis-ci.org/skywinder/Github-Changelog-Generator)
|
||||
|
||||
This script automatically generate change-log from your tags and merged pull-requests.
|
||||
GitHub Changelog Generator
|
||||
==================
|
||||
|
||||
## Installation:
|
||||
`gem install github_changelog_generator`
|
||||
- [Installation](#installation)
|
||||
- [Output example](#output-example)
|
||||
- [Usage](#usage)
|
||||
- [Params](#params)
|
||||
- [GitHub token](#github-token)
|
||||
- [Features and advantages of this project](#features-and-advantages-of-this-project)
|
||||
- [Alternatives](#alternatives)
|
||||
- [Projects using this library](#projects-using-this-library)
|
||||
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Usage:
|
||||
|
||||
### Example usage:
|
||||
`github_changelog_generator -u github-username -p github-project`
|
||||
Changelog generation has never been so easy.
|
||||
|
||||
In output you will get `[your_project]_CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
|
||||
**Fully automate changelog generation** - This gem generate change log file based on tags, issues and merged pull requests from **Github issue tracker**. This generator complies all [change log format guidelines](http://keepachangelog.com/).
|
||||
|
||||
### Params:
|
||||
github_changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
|
||||
-u, --user [USER] your username on GitHub
|
||||
-p, --project [PROJECT] name of project on GitHub
|
||||
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
|
||||
## Installation
|
||||
|
||||
[sudo] gem install github_changelog_generator
|
||||
|
||||
## Output example
|
||||
|
||||
- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
||||
- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command:
|
||||
|
||||
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
||||
|
||||
- In general it looks like this:
|
||||
|
||||
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||
>
|
||||
> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||
>
|
||||
> **Implemented enhancements:**
|
||||
>
|
||||
> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||
>
|
||||
> **Fixed bugs:**
|
||||
>
|
||||
> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||
>
|
||||
> **Merged pull requests:**
|
||||
>
|
||||
> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||
>
|
||||
> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||
|
||||
|
||||
## Usage
|
||||
**It's really simple**:
|
||||
|
||||
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
|
||||
|
||||
github_changelog_generator
|
||||
|
||||
- or from anywhere:
|
||||
|
||||
github_changelog_generator -u github_username -p github_project
|
||||
|
||||
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||
|
||||
### Params
|
||||
Type `github_changelog_generator --help` for detailed usage.
|
||||
|
||||
Usage: changelog_generator [options]
|
||||
-u, --user [USER] Username of the owner of target GitHub repo
|
||||
-p, --project [PROJECT] Name of project on GitHub
|
||||
-t, --token [TOKEN] To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
|
||||
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
|
||||
-o, --output [NAME] Output file. Default is CHANGELOG.md
|
||||
--[no-]verbose Run verbosely. Default is true
|
||||
--[no-]issues Include closed issues to changelog. Default is true
|
||||
--[no-]issues-wo-labels Include closed issues without labels to changelog. Default is true
|
||||
--[no-]pr-wo-labels Include pull requests without labels to changelog. Default is true
|
||||
--[no-]pull-requests Include pull-requests to changelog. Default is true
|
||||
--[no-]filter-by-milestone Use milestone to detect when issue was resolved. Default is true
|
||||
--[no-]author Add author of pull-request in the end. Default is true
|
||||
--unreleased-only Generate log from unreleased closed issues only.
|
||||
--[no-]unreleased Add to log unreleased closed issues. Default is true
|
||||
--[no-]compare-link Include compare link between older version and newer version. Default is true
|
||||
--include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
|
||||
--exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
|
||||
--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.
|
||||
-v, --version Print version number
|
||||
-h, --help Displays Help
|
||||
-v, --[no-]verbose Run verbosely
|
||||
-l, --last-changes generate log between last 2 tags
|
||||
-f, --date-format [FORMAT] date format. default is %d/%m/%y
|
||||
|
||||
|
||||
## Real examples:
|
||||
### [This changelog](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by
|
||||
`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
|
||||
### GitHub token
|
||||
|
||||
## FAQ
|
||||
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your 16 digit token]` that you can easily **[generate here](https://github.com/settings/applications)**.
|
||||
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
|
||||
|
||||
**You can easily [generate it here](https://github.com/settings/applications)**.
|
||||
|
||||
And:
|
||||
|
||||
- Run with key `-t [your-16-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 :
|
||||
|
||||
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||
|
||||
So, if you got error like this:
|
||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden)
|
||||
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||
|
||||
Then you have to generate this token or wait for 1 hour
|
||||
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||
|
||||
## License
|
||||
##Features and advantages of this project
|
||||
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
|
||||
- Simply add links for all closed issues and merged pull requests
|
||||
- Possible to generate **Unreleased** changes (closed issues that have not released yet)
|
||||
- Flexible format customisation:
|
||||
- Customize issues, that should be added to changelog
|
||||
- Custom date format supported
|
||||
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
|
||||
- Ability to exclude specific issues from change log (by labels)
|
||||
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels)
|
||||
- Distinguish bug fixes, enchantments, and closed issues according labels.
|
||||
- **Issues** (closed issues w/o any labels)
|
||||
- **Merged pull-requests** (all merged pull-requests)
|
||||
- **Bug-fixes** (by label `bug` in issue)
|
||||
- **Enhancements** (by label `enhancement` in issue)
|
||||
|
||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||
###Alternatives
|
||||
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements.
|
||||
|
||||
*If you know other projects - feel free to edit this Wiki page!*
|
||||
|
||||
|
||||
### Projects using this library
|
||||
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||
|
||||
*If you are using `github_changelog_generator` for generation change log in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||
|
||||
## Am I missed some essential feature?
|
||||
|
||||
**Nothing is impossible!**
|
||||
|
||||
Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||
|
||||
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -51,6 +158,6 @@ Github Changelog Generator is released under the [MIT License](http://www.openso
|
||||
5. Push to the branch (`git push origin my-new-feature`)
|
||||
6. Create a new Pull Request
|
||||
|
||||
**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!**
|
||||
## License
|
||||
|
||||
*Improvements more than welcome - they are kindly requested! :)*
|
||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||
|
||||
9
Rakefile
Normal file
9
Rakefile
Normal file
@@ -0,0 +1,9 @@
|
||||
require "rake/testtask"
|
||||
|
||||
task :default => [:test]
|
||||
|
||||
Rake::TestTask.new do |t|
|
||||
t.verbose = true
|
||||
t.libs.push("demo", "test")
|
||||
t.pattern = "test/**/*_test.rb"
|
||||
end
|
||||
@@ -1,5 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
#! /usr/bin/env ruby
|
||||
|
||||
require 'github_changelog_generator'
|
||||
|
||||
ChangelogGenerator.new.compund_changelog
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||
227
bump_gemfile.rb
Executable file
227
bump_gemfile.rb
Executable file
@@ -0,0 +1,227 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'optparse'
|
||||
|
||||
SPEC_TYPE = 'gemspec'
|
||||
|
||||
:major
|
||||
:minor
|
||||
:patch
|
||||
|
||||
@options = {:dry_run => false, :bump_number => :patch}
|
||||
|
||||
OptionParser.new { |opts|
|
||||
opts.banner = 'Usage: bump.rb [options]'
|
||||
|
||||
opts.on('-d', '--dry-run', 'Dry run') do |v|
|
||||
@options[:dry_run] = v
|
||||
end
|
||||
opts.on('-a', '--major', 'Bump major version') do |v|
|
||||
@options[:bump_number] = :major
|
||||
end
|
||||
opts.on('-m', '--minor', 'Bump minor version') do |v|
|
||||
@options[:bump_number] = :minor
|
||||
end
|
||||
opts.on('-p', '--patch', 'Bump patch version') do |v|
|
||||
@options[:bump_number] = :patch
|
||||
end
|
||||
opts.on('-r', '--revert', 'Revert last bump') do |v|
|
||||
@options[:revert] = v
|
||||
end
|
||||
}.parse!
|
||||
|
||||
p @options
|
||||
|
||||
def check_repo_is_clean_or_dry_run
|
||||
value =%x[#{'git status --porcelain'}]
|
||||
|
||||
if value.empty?
|
||||
puts 'Repo is clean -> continue'
|
||||
else
|
||||
if @options[:dry_run]
|
||||
puts 'Repo not clean, "Dry run" enabled -> continue'
|
||||
else
|
||||
puts 'Repository not clean -> exit'
|
||||
exit
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
def find_spec_file
|
||||
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
|
||||
arr = list_of_specs.split("\n")
|
||||
|
||||
spec_file = ''
|
||||
|
||||
case arr.count
|
||||
when 0
|
||||
puts "No #{SPEC_TYPE} files found. -> Exit."
|
||||
exit
|
||||
when 1
|
||||
spec_file = arr[0]
|
||||
else
|
||||
puts 'Which spec should be used?'
|
||||
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
||||
input_index = Integer(gets.chomp)
|
||||
spec_file = arr[input_index-1]
|
||||
end
|
||||
|
||||
if spec_file == nil
|
||||
puts "Can't find specified spec file -> exit"
|
||||
exit
|
||||
end
|
||||
|
||||
spec_file.sub('./', '')
|
||||
|
||||
end
|
||||
|
||||
def find_current_gem_file
|
||||
list_of_specs = execute_line("find . -name '*.gem'")
|
||||
arr = list_of_specs.split("\n")
|
||||
|
||||
spec_file = ''
|
||||
|
||||
case arr.count
|
||||
when 0
|
||||
puts "No #{SPEC_TYPE} files found. -> Exit."
|
||||
exit
|
||||
when 1
|
||||
spec_file = arr[0]
|
||||
else
|
||||
puts 'Which spec should be used?'
|
||||
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
||||
input_index = Integer(gets.chomp)
|
||||
spec_file = arr[input_index-1]
|
||||
end
|
||||
|
||||
if spec_file == nil
|
||||
puts "Can't find specified spec file -> exit"
|
||||
exit
|
||||
end
|
||||
|
||||
spec_file.sub('./', '')
|
||||
|
||||
end
|
||||
|
||||
def find_version_in_podspec(podspec)
|
||||
readme = File.read(podspec)
|
||||
|
||||
#try to find version in format 1.22.333
|
||||
re = /(\d+)\.(\d+)\.(\d+)/m
|
||||
|
||||
match_result = re.match(readme)
|
||||
|
||||
unless match_result
|
||||
puts 'Not found any versions'
|
||||
exit
|
||||
end
|
||||
|
||||
puts "Found version #{match_result[0]}"
|
||||
return match_result[0], match_result.captures
|
||||
end
|
||||
|
||||
def bump_version(versions_array)
|
||||
bumped_result = versions_array.dup
|
||||
bumped_result.map! { |x| x.to_i }
|
||||
|
||||
case @options[:bump_number]
|
||||
when :major
|
||||
bumped_result[0] += 1
|
||||
bumped_result[1] = 0
|
||||
bumped_result[2] = 0
|
||||
when :minor
|
||||
bumped_result[1] += 1
|
||||
bumped_result[2] = 0
|
||||
when :patch
|
||||
bumped_result[2] += 1
|
||||
else
|
||||
raise('unknown bump_number')
|
||||
end
|
||||
|
||||
|
||||
bumped_version = bumped_result.join('.')
|
||||
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
|
||||
bumped_version
|
||||
end
|
||||
|
||||
def execute_line(line)
|
||||
output = `#{line}`
|
||||
check_exit_status(output)
|
||||
|
||||
output
|
||||
end
|
||||
|
||||
def execute_line_if_not_dry_run(line)
|
||||
if @options[:dry_run]
|
||||
puts "Dry run: #{line}"
|
||||
nil
|
||||
else
|
||||
puts line
|
||||
value = %x[#{line}]
|
||||
puts value
|
||||
check_exit_status(value)
|
||||
value
|
||||
end
|
||||
end
|
||||
|
||||
def check_exit_status(output)
|
||||
if $?.exitstatus != 0
|
||||
puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
|
||||
exit
|
||||
end
|
||||
end
|
||||
|
||||
def run_bumping_script
|
||||
|
||||
check_repo_is_clean_or_dry_run
|
||||
spec_file = find_spec_file
|
||||
result, versions_array = find_version_in_podspec(spec_file)
|
||||
bumped_version = bump_version(versions_array)
|
||||
|
||||
unless @options[:dry_run]
|
||||
puts 'Are you sure? Press Y to continue:'
|
||||
str = gets.chomp
|
||||
if str != 'Y'
|
||||
puts '-> exit'
|
||||
exit
|
||||
end
|
||||
end
|
||||
|
||||
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" README.md")
|
||||
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
|
||||
execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
|
||||
execute_line_if_not_dry_run("git tag #{bumped_version}")
|
||||
execute_line_if_not_dry_run('git push')
|
||||
execute_line_if_not_dry_run('git push --tags')
|
||||
execute_line_if_not_dry_run("gem build #{spec_file}")
|
||||
|
||||
gem = find_current_gem_file
|
||||
execute_line_if_not_dry_run("gem push #{gem}")
|
||||
# execute_line_if_not_dry_run("pod trunk push #{spec_file}")
|
||||
|
||||
end
|
||||
|
||||
def revert_last_bump
|
||||
spec_file = find_spec_file
|
||||
result, _ = find_version_in_podspec(spec_file)
|
||||
|
||||
puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
|
||||
str = gets.chomp
|
||||
if str != 'Y'
|
||||
puts '-> exit'
|
||||
exit
|
||||
end
|
||||
execute_line_if_not_dry_run("git tag -d #{result}")
|
||||
execute_line_if_not_dry_run('git reset --hard HEAD~1')
|
||||
execute_line_if_not_dry_run("git push --delete origin #{result}")
|
||||
end
|
||||
|
||||
if __FILE__ == $0
|
||||
|
||||
if @options[:revert]
|
||||
revert_last_bump
|
||||
else
|
||||
run_bumping_script
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,21 +1,32 @@
|
||||
Gem::Specification.new do |s|
|
||||
s.name = "github_changelog_generator"
|
||||
s.version = "0.0.2"
|
||||
s.default_executable = "github_changelog_generator"
|
||||
# coding: utf-8
|
||||
|
||||
s.required_ruby_version = '>= 1.9.3'
|
||||
s.authors = ["Petr Korolev"]
|
||||
s.date = %q{2014-10-10}
|
||||
s.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
|
||||
s.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||
s.files = ["lib/github_changelog_generator.rb", "lib/github_changelog_generator/parser.rb", "bin/github_changelog_generator"]
|
||||
s.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
||||
s.require_paths = ["lib"]
|
||||
s.rubygems_version = %q{1.6.2}
|
||||
s.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
|
||||
s.license = "MIT"
|
||||
s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
|
||||
s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||
lib = File.expand_path('../lib', __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require 'github_changelog_generator/version'
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "github_changelog_generator"
|
||||
spec.version = GitHubChangelogGenerator::VERSION
|
||||
spec.default_executable = "github_changelog_generator"
|
||||
|
||||
spec.required_ruby_version = '>= 1.9.3'
|
||||
spec.authors = ["Petr Korolev"]
|
||||
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||
spec.date = `date +"%Y-%m-%d"`.strip!
|
||||
spec.summary = %q{Script, that automatically generate changelog from your tags, issues, labels and pull requests.}
|
||||
spec.description = %q{Script, that automatically generate changelog from your tags, issues, labels and pull requests.}
|
||||
spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
||||
spec.license = "MIT"
|
||||
|
||||
spec.files = `git ls-files -z`.split("\x0")
|
||||
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||
spec.require_paths = ["lib"]
|
||||
|
||||
spec.add_development_dependency "bundler", "~> 1.7"
|
||||
spec.add_development_dependency "rake", "~> 10.0"
|
||||
|
||||
spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||
spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
|
||||
|
||||
s.executables = %w(github_changelog_generator)
|
||||
end
|
||||
5
lib/CHANGELOG.md
Normal file
5
lib/CHANGELOG.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Change Log
|
||||
|
||||
|
||||
|
||||
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||
@@ -2,71 +2,192 @@
|
||||
|
||||
require 'github_api'
|
||||
require 'json'
|
||||
require 'httparty'
|
||||
require 'colorize'
|
||||
require 'benchmark'
|
||||
|
||||
require_relative 'github_changelog_generator/parser'
|
||||
require_relative 'github_changelog_generator/generator'
|
||||
require_relative 'github_changelog_generator/version'
|
||||
|
||||
module GitHubChangelogGenerator
|
||||
class ChangelogGenerator
|
||||
|
||||
class ChangelogGenerator
|
||||
attr_accessor :options, :all_tags, :github
|
||||
|
||||
attr_accessor :options, :all_tags
|
||||
PER_PAGE_NUMBER = 30
|
||||
|
||||
def initialize()
|
||||
def initialize
|
||||
|
||||
@options = Parser.parse_options
|
||||
if @options[:token]
|
||||
@github = Github.new oauth_token: @options[:token]
|
||||
else
|
||||
@github = Github.new
|
||||
end
|
||||
@all_tags = self.get_all_tags
|
||||
@pull_requests = self.get_all_closed_pull_requests
|
||||
|
||||
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 = Github.new github_options
|
||||
|
||||
@generator = Generator.new(@options)
|
||||
|
||||
@all_tags = self.get_all_tags
|
||||
@issues, @pull_requests = self.fetch_issues_and_pull_requests
|
||||
|
||||
if @options[:pulls]
|
||||
@pull_requests = self.get_filtered_pull_requests
|
||||
self.fetch_merged_at_pull_requests
|
||||
else
|
||||
@pull_requests = []
|
||||
end
|
||||
|
||||
if @options[:issues]
|
||||
@issues = self.get_filtered_issues
|
||||
else
|
||||
@issues = []
|
||||
end
|
||||
|
||||
fetch_event_for_issues_and_pr
|
||||
detect_actual_closed_dates
|
||||
@tag_times_hash = {}
|
||||
end
|
||||
|
||||
def detect_actual_closed_dates
|
||||
|
||||
if @options[:verbose]
|
||||
print "Fetching closed dates for issues...\r"
|
||||
end
|
||||
|
||||
threads = []
|
||||
|
||||
@issues.each { |issue|
|
||||
threads << Thread.new {
|
||||
find_closed_date_by_commit(issue)
|
||||
}
|
||||
}
|
||||
|
||||
@pull_requests.each { |pull_request|
|
||||
threads << Thread.new {
|
||||
find_closed_date_by_commit(pull_request)
|
||||
}
|
||||
}
|
||||
threads.each { |thr| thr.join }
|
||||
|
||||
if @options[:verbose]
|
||||
puts 'Fetching closed dates for issues: Done!'
|
||||
end
|
||||
end
|
||||
|
||||
def find_closed_date_by_commit(issue)
|
||||
unless issue['events'].nil?
|
||||
#if it's PR -> then find "merged event", in case of usual issue -> fond closed date
|
||||
compare_string = issue[:merged_at].nil? ? 'closed' : 'merged'
|
||||
# reverse! - to find latest closed event. (event goes in date order)
|
||||
issue['events'].reverse!.each { |event|
|
||||
if event[:event].eql? compare_string
|
||||
if event[:commit_id].nil?
|
||||
issue[:actual_date] = issue[:closed_at]
|
||||
else
|
||||
begin
|
||||
commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
|
||||
issue[:actual_date] = commit[:author][:date]
|
||||
rescue
|
||||
puts "Warning: can't fetch commit #{event[:commit_id]} probably it referenced from another repo."
|
||||
issue[:actual_date] = issue[:closed_at]
|
||||
end
|
||||
end
|
||||
break
|
||||
end
|
||||
}
|
||||
end
|
||||
#TODO: assert issues, that remain without 'actual_date' hash for some reason.
|
||||
end
|
||||
|
||||
def print_json(json)
|
||||
puts JSON.pretty_generate(json)
|
||||
end
|
||||
|
||||
def exec_command(cmd)
|
||||
exec_cmd = "cd #{$project_path} && #{cmd}"
|
||||
%x[#{exec_cmd}]
|
||||
def fetch_merged_at_pull_requests
|
||||
if @options[:verbose]
|
||||
print "Fetching merged dates...\r"
|
||||
end
|
||||
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
|
||||
pull_requests = []
|
||||
page_i = 0
|
||||
response.each_page do |page|
|
||||
page_i += PER_PAGE_NUMBER
|
||||
count_pages = response.count_pages
|
||||
print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||
pull_requests.concat(page)
|
||||
end
|
||||
print " \r"
|
||||
|
||||
def get_all_closed_pull_requests
|
||||
|
||||
|
||||
issues = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||
json = issues.body
|
||||
@pull_requests.each { |pr|
|
||||
fetched_pr = pull_requests.find { |fpr|
|
||||
fpr.number == pr.number }
|
||||
pr[:merged_at] = fetched_pr[:merged_at]
|
||||
pull_requests.delete(fetched_pr)
|
||||
}
|
||||
|
||||
if @options[:verbose]
|
||||
puts 'Receive all pull requests'
|
||||
puts 'Fetching merged dates... Done!'
|
||||
end
|
||||
|
||||
json
|
||||
end
|
||||
|
||||
def get_filtered_pull_requests
|
||||
|
||||
pull_requests = @pull_requests
|
||||
filtered_pull_requests = pull_requests
|
||||
|
||||
|
||||
unless @options[:include_labels].nil?
|
||||
filtered_pull_requests = pull_requests.select { |issue|
|
||||
#add all labels from @options[:incluse_labels] array
|
||||
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
|
||||
}
|
||||
end
|
||||
|
||||
unless @options[:exclude_labels].nil?
|
||||
filtered_pull_requests = filtered_pull_requests.select { |issue|
|
||||
#delete all labels from @options[:exclude_labels] array
|
||||
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
|
||||
}
|
||||
end
|
||||
|
||||
if @options[:add_issues_wo_labels]
|
||||
issues_wo_labels = pull_requests.select {
|
||||
# add issues without any labels
|
||||
|issue| !issue.labels.map { |label| label.name }.any?
|
||||
}
|
||||
filtered_pull_requests |= issues_wo_labels
|
||||
end
|
||||
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Filtered pull requests: #{filtered_pull_requests.count}"
|
||||
end
|
||||
|
||||
filtered_pull_requests
|
||||
end
|
||||
|
||||
def compund_changelog
|
||||
if @options[:verbose]
|
||||
puts 'Generating changelog:'
|
||||
end
|
||||
|
||||
log = "# Changelog\n\n"
|
||||
|
||||
if @options[:last]
|
||||
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
||||
elsif @options[:tag1] && @options[:tag2]
|
||||
log = "# Change Log\n\n"
|
||||
|
||||
if @options[:unreleased_only]
|
||||
log += self.generate_log_between_tags(self.all_tags[0], nil)
|
||||
elsif @options[:tag1] and @options[:tag2]
|
||||
tag1 = @options[:tag1]
|
||||
tag2 = @options[:tag2]
|
||||
tags_strings = []
|
||||
self.all_tags.each { |x| tags_strings.push(x['name'])}
|
||||
self.all_tags.each { |x| tags_strings.push(x['name']) }
|
||||
|
||||
if tags_strings.include?(tag1)
|
||||
if tags_strings.include?(tag2)
|
||||
hash = Hash[tags_strings.map.with_index.to_a]
|
||||
to_a = tags_strings.map.with_index.to_a
|
||||
hash = Hash[to_a]
|
||||
index1 = hash[tag1]
|
||||
index2 = hash[tag2]
|
||||
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
|
||||
@@ -82,125 +203,432 @@ class ChangelogGenerator
|
||||
log += self.generate_log_for_all_tags
|
||||
end
|
||||
|
||||
log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||
|
||||
if @options[:verbose]
|
||||
puts log
|
||||
end
|
||||
|
||||
log += "\n\n*This file was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
|
||||
output_filename = "#{@options[:project]}_CHANGELOG.md"
|
||||
output_filename = "#{@options[:output]}"
|
||||
File.open(output_filename, 'w') { |file| file.write(log) }
|
||||
|
||||
puts "Done! Generated log placed in #{output_filename}"
|
||||
puts 'Done!'
|
||||
puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
|
||||
|
||||
end
|
||||
|
||||
def generate_log_for_all_tags
|
||||
|
||||
fetch_tags_dates
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Sorting tags.."
|
||||
end
|
||||
|
||||
@all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Generating log.."
|
||||
end
|
||||
|
||||
|
||||
log = ''
|
||||
for index in 1 ... self.all_tags.size
|
||||
log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
|
||||
|
||||
if @options[:unreleased] && @all_tags.count != 0
|
||||
unreleased_log = self.generate_log_between_tags(self.all_tags[0], nil)
|
||||
if unreleased_log
|
||||
log += unreleased_log
|
||||
end
|
||||
end
|
||||
|
||||
(1 ... self.all_tags.size).each { |index|
|
||||
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
||||
}
|
||||
if @all_tags.count != 0
|
||||
log += generate_log_between_tags(nil, self.all_tags.last)
|
||||
end
|
||||
|
||||
log
|
||||
end
|
||||
|
||||
def fetch_tags_dates
|
||||
if @options[:verbose]
|
||||
print "Fetching tags dates..\r"
|
||||
end
|
||||
|
||||
# Async fetching tags:
|
||||
threads = []
|
||||
i = 0
|
||||
all = @all_tags.count
|
||||
@all_tags.each { |tag|
|
||||
# explicit set @tag_times_hash to write data safety.
|
||||
threads << Thread.new {
|
||||
self.get_time_of_tag(tag, @tag_times_hash)
|
||||
if @options[:verbose]
|
||||
print "Fetching tags dates: #{i+1}/#{all}\r"
|
||||
i+=1
|
||||
end
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
print " \r"
|
||||
|
||||
threads.each { |thr| thr.join }
|
||||
|
||||
if @options[:verbose]
|
||||
puts 'Fetching tags: Done!'
|
||||
end
|
||||
end
|
||||
|
||||
def is_megred(number)
|
||||
@github.pull_requests.merged? @options[:user], @options[:project], number
|
||||
end
|
||||
|
||||
def get_all_merged_pull_requests
|
||||
json = self.get_all_closed_pull_requests
|
||||
puts 'Check if the requests is merged... (it can take a while)'
|
||||
|
||||
json.delete_if { |req|
|
||||
merged = self.is_megred(req[:number])
|
||||
if @options[:verbose]
|
||||
puts "##{req[:number]} #{merged ? 'merged' : 'not merged'}"
|
||||
end
|
||||
!merged
|
||||
}
|
||||
end
|
||||
|
||||
def get_all_tags
|
||||
|
||||
url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Receive tags for repo #{url}"
|
||||
print "Fetching tags...\r"
|
||||
end
|
||||
|
||||
response = HTTParty.get(url,
|
||||
:headers => {'Authorization' => 'token 8587bb22f6bf125454768a4a19dbcc774ea68d48',
|
||||
'User-Agent' => 'Changelog-Generator'})
|
||||
|
||||
json_parse = JSON.parse(response.body)
|
||||
response = @github.repos.tags @options[:user], @options[:project]
|
||||
|
||||
tags = []
|
||||
page_i = 0
|
||||
count_pages = response.count_pages
|
||||
response.each_page do |page|
|
||||
page_i += PER_PAGE_NUMBER
|
||||
print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||
tags.concat(page)
|
||||
end
|
||||
print " \r"
|
||||
if @options[:verbose]
|
||||
puts "Found #{json_parse.count} tags"
|
||||
puts "Found #{tags.count} tags"
|
||||
end
|
||||
|
||||
json_parse
|
||||
tags
|
||||
end
|
||||
|
||||
def generate_log_between_tags(since_tag, till_tag)
|
||||
since_tag_time = self.get_time_of_tag(since_tag)
|
||||
till_tag_time = self.get_time_of_tag(till_tag)
|
||||
def fetch_github_token
|
||||
env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
|
||||
|
||||
# if we mix up tags order - lits fix it!
|
||||
if since_tag_time > till_tag_time
|
||||
since_tag, till_tag = till_tag, since_tag
|
||||
since_tag_time, till_tag_time = till_tag_time, since_tag_time
|
||||
unless env_var
|
||||
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
|
||||
puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
|
||||
end
|
||||
|
||||
till_tag_name = till_tag['name']
|
||||
@github_token ||= env_var
|
||||
|
||||
pull_requests = Array.new(@pull_requests)
|
||||
end
|
||||
|
||||
pull_requests.delete_if { |req|
|
||||
t = Time.parse(req[:closed_at]).utc
|
||||
true_classor_false_class = t > since_tag_time
|
||||
classor_false_class = t < till_tag_time
|
||||
def generate_log_between_tags(older_tag, newer_tag)
|
||||
# older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
|
||||
filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
|
||||
filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
|
||||
|
||||
in_range = (true_classor_false_class) && (classor_false_class)
|
||||
!in_range
|
||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
|
||||
older_tag_name = older_tag.nil? ? nil : older_tag['name']
|
||||
|
||||
if @options[:filter_issues_by_milestone]
|
||||
#delete excess irrelevant issues (according milestones)
|
||||
filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
|
||||
filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
|
||||
end
|
||||
|
||||
if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
|
||||
# do not generate empty unreleased section
|
||||
return nil
|
||||
end
|
||||
|
||||
self.create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
|
||||
end
|
||||
|
||||
def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
|
||||
filtered_issues.select! { |issue|
|
||||
# leave issues without milestones
|
||||
if issue.milestone.nil?
|
||||
true
|
||||
else
|
||||
#check, that this milestone in tag list:
|
||||
@all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
|
||||
end
|
||||
}
|
||||
unless newer_tag_name.nil?
|
||||
|
||||
#add missed issues (according milestones)
|
||||
issues_to_add = src_array.select { |issue|
|
||||
if issue.milestone.nil?
|
||||
false
|
||||
else
|
||||
#check, that this milestone in tag list:
|
||||
milestone_is_tag = @all_tags.find { |tag|
|
||||
tag.name == issue.milestone.title
|
||||
}
|
||||
|
||||
self.create_log(pull_requests, till_tag_name, till_tag_time)
|
||||
if milestone_is_tag.nil?
|
||||
false
|
||||
else
|
||||
issue.milestone.title == newer_tag_name
|
||||
end
|
||||
end
|
||||
}
|
||||
|
||||
filtered_issues |= issues_to_add
|
||||
end
|
||||
filtered_issues
|
||||
end
|
||||
|
||||
def create_log(pull_requests, tag_name, tag_time)
|
||||
def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
|
||||
|
||||
trimmed_tag = tag_name.tr('v', '')
|
||||
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
||||
raise 'At least one of the tags should be not nil!' if (older_tag.nil? && newer_tag.nil?)
|
||||
|
||||
time_string = tag_time.strftime @options[:format]
|
||||
log += "#### #{time_string}\n"
|
||||
newer_tag_time = self.get_time_of_tag(newer_tag)
|
||||
older_tag_time = self.get_time_of_tag(older_tag)
|
||||
|
||||
pull_requests.each { |dict|
|
||||
merge = "#{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/pull/#{dict[:number]})\n\n"
|
||||
log += "- #{merge}"
|
||||
array.select { |req|
|
||||
if req[hash_key]
|
||||
t = Time.parse(req[hash_key]).utc
|
||||
|
||||
if older_tag_time.nil?
|
||||
tag_in_range_old = true
|
||||
else
|
||||
tag_in_range_old = t > older_tag_time
|
||||
end
|
||||
|
||||
if newer_tag_time.nil?
|
||||
tag_in_range_new = true
|
||||
else
|
||||
tag_in_range_new = t <= newer_tag_time
|
||||
end
|
||||
|
||||
|
||||
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||
|
||||
tag_in_range
|
||||
else
|
||||
false
|
||||
end
|
||||
}
|
||||
end
|
||||
|
||||
# @param [Array] pull_requests
|
||||
# @param [Array] issues
|
||||
# @param [String] older_tag_name
|
||||
# @return [String]
|
||||
def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
|
||||
|
||||
newer_tag_time = newer_tag.nil? ? nil : self.get_time_of_tag(newer_tag)
|
||||
newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
|
||||
|
||||
github_site = options[:github_site] || 'https://github.com'
|
||||
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||
|
||||
if newer_tag.nil?
|
||||
newer_tag_name = @options[:unreleased_label]
|
||||
newer_tag_link = 'HEAD'
|
||||
newer_tag_time = Time.new
|
||||
else
|
||||
newer_tag_link = newer_tag_name
|
||||
end
|
||||
|
||||
log = ''
|
||||
|
||||
log += generate_header(log, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
|
||||
|
||||
if @options[:issues]
|
||||
# Generate issues:
|
||||
issues_a = []
|
||||
enhancement_a = []
|
||||
bugs_a =[]
|
||||
|
||||
issues.each { |dict|
|
||||
added = false
|
||||
dict.labels.each { |label|
|
||||
if label.name == 'bug'
|
||||
bugs_a.push dict
|
||||
added = true
|
||||
next
|
||||
end
|
||||
if label.name == 'enhancement'
|
||||
enhancement_a.push dict
|
||||
added = true
|
||||
next
|
||||
end
|
||||
}
|
||||
unless added
|
||||
issues_a.push dict
|
||||
end
|
||||
}
|
||||
|
||||
log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix])
|
||||
log += generate_log_from_array(bugs_a, @options[:bug_prefix])
|
||||
log += generate_log_from_array(issues_a, @options[:issue_prefix])
|
||||
end
|
||||
|
||||
if @options[:pulls]
|
||||
# Generate pull requests:
|
||||
log += generate_log_from_array(pull_requests, @options[:merge_prefix])
|
||||
end
|
||||
|
||||
log
|
||||
end
|
||||
|
||||
def get_time_of_tag(prev_tag)
|
||||
|
||||
if @tag_times_hash[prev_tag['name']]
|
||||
return @tag_times_hash[prev_tag['name']]
|
||||
def generate_log_from_array(issues, prefix)
|
||||
log = ''
|
||||
if options[:simple_list].nil? && issues.any?
|
||||
log += "#{prefix}\n\n"
|
||||
end
|
||||
|
||||
if issues.any?
|
||||
issues.each { |issue|
|
||||
merge_string = @generator.get_string_for_issue(issue)
|
||||
log += "- #{merge_string}\n\n"
|
||||
}
|
||||
end
|
||||
log
|
||||
end
|
||||
|
||||
def generate_header(log, newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
|
||||
|
||||
#Generate date string:
|
||||
time_string = newer_tag_time.strftime @options[:format]
|
||||
|
||||
# Generate tag name and link
|
||||
if newer_tag_name.equal? @options[:unreleased_label]
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2})\n\n"
|
||||
else
|
||||
log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
|
||||
end
|
||||
|
||||
if @options[:compare_link] && older_tag_name
|
||||
# Generate compare link
|
||||
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name2})\n\n"
|
||||
end
|
||||
|
||||
log
|
||||
end
|
||||
|
||||
def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
|
||||
|
||||
if tag_name.nil?
|
||||
return nil
|
||||
end
|
||||
|
||||
if tag_times_hash[tag_name['name']]
|
||||
return @tag_times_hash[tag_name['name']]
|
||||
end
|
||||
|
||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
|
||||
time_string = github_git_data_commits_get['committer']['date']
|
||||
@tag_times_hash[tag_name['name']] = Time.parse(time_string)
|
||||
end
|
||||
|
||||
def get_filtered_issues
|
||||
|
||||
issues = @issues
|
||||
|
||||
filtered_issues = issues
|
||||
|
||||
unless @options[:include_labels].nil?
|
||||
filtered_issues = issues.select { |issue|
|
||||
#add all labels from @options[:incluse_labels] array
|
||||
(issue.labels.map { |label| label.name } & @options[:include_labels]).any?
|
||||
}
|
||||
end
|
||||
|
||||
unless @options[:exclude_labels].nil?
|
||||
filtered_issues = filtered_issues.select { |issue|
|
||||
#delete all labels from @options[:exclude_labels] array
|
||||
!(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
|
||||
}
|
||||
end
|
||||
|
||||
if @options[:add_issues_wo_labels]
|
||||
issues_wo_labels = issues.select {
|
||||
# add issues without any labels
|
||||
|issue| !issue.labels.map { |label| label.name }.any?
|
||||
}
|
||||
filtered_issues |= issues_wo_labels
|
||||
end
|
||||
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Get time for tag #{prev_tag['name']}"
|
||||
puts "Filtered issues: #{filtered_issues.count}"
|
||||
end
|
||||
|
||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
||||
time_string = github_git_data_commits_get['committer']['date']
|
||||
Time.parse(time_string)
|
||||
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
||||
filtered_issues
|
||||
|
||||
end
|
||||
|
||||
def fetch_issues_and_pull_requests
|
||||
if @options[:verbose]
|
||||
print "Fetching closed issues...\r"
|
||||
end
|
||||
|
||||
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
||||
|
||||
issues = []
|
||||
page_i = 0
|
||||
count_pages = response.count_pages
|
||||
response.each_page do |page|
|
||||
page_i += PER_PAGE_NUMBER
|
||||
print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
|
||||
issues.concat(page)
|
||||
end
|
||||
|
||||
print " \r"
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Received issues: #{issues.count}"
|
||||
end
|
||||
|
||||
# remove pull request from issues:
|
||||
issues_wo_pr = issues.select { |x|
|
||||
x.pull_request == nil
|
||||
}
|
||||
pull_requests = issues.select { |x|
|
||||
x.pull_request != nil
|
||||
}
|
||||
return issues_wo_pr, pull_requests
|
||||
end
|
||||
|
||||
def fetch_event_for_issues_and_pr
|
||||
if @options[:verbose]
|
||||
print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
|
||||
end
|
||||
|
||||
# Async fetching events:
|
||||
threads = []
|
||||
|
||||
i = 0
|
||||
|
||||
@issues.each { |issue|
|
||||
threads << Thread.new {
|
||||
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
|
||||
issue[:events] = obj.body
|
||||
print "Fetching events for issues and PR: #{i+1}/#{@issues.count + @pull_requests.count}\r"
|
||||
i +=1
|
||||
}
|
||||
}
|
||||
|
||||
@pull_requests.each { |pull_request|
|
||||
threads << Thread.new {
|
||||
obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: pull_request['number']
|
||||
pull_request[:events] = obj.body
|
||||
print "Fetching events for issues and PR: #{i+1}/#{@issues.count + @pull_requests.count}\r"
|
||||
i +=1
|
||||
}
|
||||
}
|
||||
|
||||
threads.each { |thr| thr.join }
|
||||
|
||||
#to clear line from prev print
|
||||
print " \r"
|
||||
|
||||
if @options[:verbose]
|
||||
puts "Fetching events for issues and PR: Done! #{i}/#{@issues.count + @pull_requests.count}"
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
if __FILE__ == $0
|
||||
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
if __FILE__ == $0
|
||||
ChangelogGenerator.new.compund_changelog
|
||||
end
|
||||
39
lib/github_changelog_generator/generator.rb
Normal file
39
lib/github_changelog_generator/generator.rb
Normal file
@@ -0,0 +1,39 @@
|
||||
module GitHubChangelogGenerator
|
||||
class Generator
|
||||
|
||||
def initialize(options = nil)
|
||||
@options = options
|
||||
end
|
||||
|
||||
def get_string_for_issue(issue)
|
||||
encapsulated_title = self.encapsulate_string issue[:title]
|
||||
|
||||
title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
|
||||
|
||||
unless issue.pull_request.nil?
|
||||
if @options[:author]
|
||||
if issue.user.nil?
|
||||
title_with_number += " ({Null user})"
|
||||
else
|
||||
title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
|
||||
end
|
||||
end
|
||||
end
|
||||
title_with_number
|
||||
end
|
||||
|
||||
def encapsulate_string(string)
|
||||
|
||||
string.gsub! '\\', '\\\\'
|
||||
|
||||
encpas_chars = %w(> * _ \( \) [ ] #)
|
||||
encpas_chars.each { |char|
|
||||
string.gsub! char, "\\#{char}"
|
||||
}
|
||||
|
||||
string
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,43 +1,142 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'optparse'
|
||||
require 'pp'
|
||||
require_relative 'version'
|
||||
|
||||
class Parser
|
||||
module GitHubChangelogGenerator
|
||||
class Parser
|
||||
def self.parse_options
|
||||
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y'}
|
||||
|
||||
options = {
|
||||
:tag1 => nil,
|
||||
:tag2 => nil,
|
||||
:format => '%Y-%m-%d',
|
||||
:output => 'CHANGELOG.md',
|
||||
:exclude_labels => %w(duplicate question invalid wontfix),
|
||||
:pulls => true,
|
||||
:issues => true,
|
||||
:verbose => true,
|
||||
:add_issues_wo_labels => true,
|
||||
:add_pr_wo_labels => true,
|
||||
:merge_prefix => '**Merged pull requests:**',
|
||||
:issue_prefix => '**Closed issues:**',
|
||||
:bug_prefix => '**Fixed bugs:**',
|
||||
:enhancement_prefix => '**Implemented enhancements:**',
|
||||
:author => true,
|
||||
:filter_issues_by_milestone => true,
|
||||
:compare_link => true,
|
||||
:unreleased => true,
|
||||
:unreleased_label => 'Unreleased'
|
||||
}
|
||||
|
||||
parser = OptionParser.new { |opts|
|
||||
opts.banner = 'Usage: changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]'
|
||||
opts.on('-u', '--user [USER]', 'your username on GitHub') do |last|
|
||||
opts.banner = 'Usage: github_changelog_generator [options]'
|
||||
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
||||
options[:user] = last
|
||||
end
|
||||
opts.on('-p', '--project [PROJECT]', 'name of project on GitHub') do |last|
|
||||
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
|
||||
options[:project] = last
|
||||
end
|
||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications') do |last|
|
||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
|
||||
options[:token] = last
|
||||
end
|
||||
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
||||
options[:format] = last
|
||||
end
|
||||
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
||||
options[:output] = last
|
||||
end
|
||||
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
|
||||
options[:issues] = v
|
||||
end
|
||||
opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels to changelog. Default is true') do |v|
|
||||
options[:add_issues_wo_labels] = v
|
||||
end
|
||||
opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels to changelog. Default is true') do |v|
|
||||
options[:add_pr_wo_labels] = v
|
||||
end
|
||||
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
||||
options[:pulls] = v
|
||||
end
|
||||
opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
|
||||
options[:filter_issues_by_milestone] = last
|
||||
end
|
||||
opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
|
||||
options[:author] = author
|
||||
end
|
||||
opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
|
||||
options[:unreleased_only] = v
|
||||
end
|
||||
opts.on('--[no-]unreleased', 'Add to log unreleased closed issues. Default is true') do |v|
|
||||
options[:unreleased] = v
|
||||
end
|
||||
opts.on('--unreleased-label [label]', 'Add to log unreleased closed issues. Default is true') do |v|
|
||||
options[:unreleased_label] = v
|
||||
end
|
||||
opts.on('--[no-]compare-link', 'Include compare link (Full Changelog) between older version and newer version. Default is true') do |v|
|
||||
options[:compare_link] = v
|
||||
end
|
||||
opts.on('--include-labels x,y,z', Array, 'Issues only with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
||||
options[:include_labels] = list
|
||||
end
|
||||
opts.on('--exclude-labels x,y,z', Array, 'Issues with that labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
|
||||
options[:exclude_labels] = list
|
||||
end
|
||||
opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
|
||||
options[:github_site] = last
|
||||
end
|
||||
opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
|
||||
options[:github_endpoint] = last
|
||||
end
|
||||
opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
|
||||
options[:simple_list] = v
|
||||
end
|
||||
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
||||
options[:verbose] = v
|
||||
end
|
||||
opts.on('-v', '--version', 'Print version number') do |v|
|
||||
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||
exit
|
||||
end
|
||||
opts.on('-h', '--help', 'Displays Help') do
|
||||
puts opts
|
||||
exit
|
||||
end
|
||||
opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
|
||||
options[:verbose] = v
|
||||
end
|
||||
opts.on('-l', '--last-changes', 'generate log between last 2 tags') do |last|
|
||||
options[:last] = last
|
||||
end
|
||||
opts.on('-f', '--date-format [FORMAT]', 'date format. default is %d/%m/%y') do |last|
|
||||
options[:format] = last
|
||||
end
|
||||
}
|
||||
|
||||
parser.parse!
|
||||
|
||||
#udefined case with 1 parameter:
|
||||
if ARGV[0] && !ARGV[1]
|
||||
puts parser.banner
|
||||
github_site = options[:github_site] ? options[:github_site] : 'github.com'
|
||||
# this match should parse strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
|
||||
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
|
||||
|
||||
begin
|
||||
param = match[2].nil?
|
||||
rescue
|
||||
puts "Can't detect user and name from first parameter: '#{ARGV[0]}' -> exit'"
|
||||
exit
|
||||
end
|
||||
if param
|
||||
exit
|
||||
else
|
||||
options[:user] = match[1]
|
||||
options[:project]= match[2]
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
if !options[:user] && !options[:project]
|
||||
remote = `git remote -vv`.split("\n")
|
||||
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])
|
||||
|
||||
if match && match[1] && match[2]
|
||||
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
||||
options[:user], options[:project] = match[1], match[2]
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
if !options[:user] || !options[:project]
|
||||
puts parser.banner
|
||||
@@ -47,9 +146,15 @@ class Parser
|
||||
if ARGV[1]
|
||||
options[:tag1] = ARGV[0]
|
||||
options[:tag2] = ARGV[1]
|
||||
end
|
||||
|
||||
if options[:verbose]
|
||||
puts 'Performing task with options:'
|
||||
pp options
|
||||
puts ''
|
||||
end
|
||||
|
||||
options
|
||||
end
|
||||
end
|
||||
end
|
||||
3
lib/github_changelog_generator/version.rb
Normal file
3
lib/github_changelog_generator/version.rb
Normal file
@@ -0,0 +1,3 @@
|
||||
module GitHubChangelogGenerator
|
||||
VERSION = '1.3.6'
|
||||
end
|
||||
Reference in New Issue
Block a user