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