Compare commits
119 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
99d20bd8a9 | ||
|
|
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 | ||
|
|
a5c4899360 |
15
.travis.yml
Normal file
15
.travis.yml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
language: ruby
|
||||||
|
before_install:
|
||||||
|
- gem update --system
|
||||||
|
- gem --version
|
||||||
|
rvm:
|
||||||
|
- 2.1.0
|
||||||
|
gemfile:
|
||||||
|
- Gemfile
|
||||||
|
|
||||||
|
notifications:
|
||||||
|
email:
|
||||||
|
recipients:
|
||||||
|
- sky4winder+githubchangeloggenerator@gmail.com
|
||||||
|
on_success: never # [always|never|change]
|
||||||
|
on_failure: change # [always|never|change]
|
||||||
111
CHANGELOG.md
111
CHANGELOG.md
@@ -1,28 +1,91 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## [1.1.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4)
|
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6)
|
||||||
#### 18/11/14
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
|
||||||
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23)
|
#### 21/01/15
|
||||||
|
- *Merged pull-request:* fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||||
|
|
||||||
- *Implemented enhancement:* 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)
|
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||||
|
#### 15/01/15
|
||||||
|
- *Merged pull-request:* PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
|
|
||||||
|
- *Merged pull-request:* support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
|
- *Implemented enhancement:* Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||||
|
|
||||||
|
- *Fixed bug:* Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||||
|
|
||||||
|
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
|
||||||
|
#### 16/12/14
|
||||||
|
- *Merged pull-request:* Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *Merged pull-request:* Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *Implemented enhancement:* Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
|
||||||
|
|
||||||
|
- *Implemented enhancement:* Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
|
||||||
|
|
||||||
|
- *Fixed bug:* Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
|
||||||
|
|
||||||
|
- *Fixed bug:* 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)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
|
||||||
|
#### 16/12/14
|
||||||
|
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
|
||||||
|
#### 10/12/14
|
||||||
|
- *Merged pull-request:* Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||||
|
|
||||||
|
- *Fixed bug:* Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
|
||||||
|
|
||||||
|
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
|
||||||
|
#### 22/11/14
|
||||||
|
- *Merged pull-request:* Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *Merged pull-request:* Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
||||||
|
|
||||||
## [1.1.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
|
## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
|
||||||
|
#### 19/11/14
|
||||||
|
- *Merged pull-request:* 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))
|
||||||
|
|
||||||
|
- *Merged pull-request:* Test Pull-Request SHOULD NOT APPEAR IN LOG! [\#26](https://github.com/skywinder/Github-Changelog-Generator/pull/26) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *Merged pull-request:* 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))
|
||||||
|
|
||||||
|
- *Merged pull-request:* 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)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
|
||||||
|
#### 18/11/14
|
||||||
|
- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *Implemented enhancement:* 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)
|
||||||
|
|
||||||
|
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
|
||||||
#### 12/11/14
|
#### 12/11/14
|
||||||
- *Merged pull-request:* Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18)
|
- *Merged pull-request:* Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17)
|
- *Merged pull-request:* 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)
|
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
|
||||||
#### 10/11/14
|
#### 10/11/14
|
||||||
- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
|
- *Merged pull-request:* 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))
|
||||||
|
|
||||||
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
|
- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
|
- *Merged pull-request:* 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)
|
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
|
||||||
#### 10/11/14
|
#### 10/11/14
|
||||||
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
||||||
|
|
||||||
@@ -30,15 +93,17 @@
|
|||||||
|
|
||||||
- *Fixed bug:* Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
- *Fixed bug:* Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
||||||
|
|
||||||
## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
|
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
|
||||||
#### 10/11/14
|
#### 10/11/14
|
||||||
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8)
|
- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
|
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
|
||||||
#### 07/11/14
|
#### 07/11/14
|
||||||
- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7)
|
- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
|
- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
||||||
|
|
||||||
@@ -46,15 +111,17 @@
|
|||||||
|
|
||||||
- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
||||||
|
|
||||||
## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
|
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
|
||||||
#### 07/11/14
|
#### 07/11/14
|
||||||
- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2)
|
- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
- *Merged pull-request:* Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1)
|
- *Merged pull-request:* 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)
|
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
|
||||||
#### 06/11/14
|
#### 06/11/14
|
||||||
## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
|
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
|
||||||
#### 06/11/14
|
#### 06/11/14
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
1
Gemfile
1
Gemfile
@@ -1,3 +1,4 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
gem 'github_api'
|
gem 'github_api'
|
||||||
gem 'colorize'
|
gem 'colorize'
|
||||||
|
gem 'rake'
|
||||||
|
|||||||
10
Gemfile.lock
10
Gemfile.lock
@@ -2,7 +2,7 @@ GEM
|
|||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.6)
|
addressable (2.3.6)
|
||||||
colorize (0.7.3)
|
colorize (0.7.4)
|
||||||
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)
|
faraday (0.9.0)
|
||||||
@@ -15,13 +15,13 @@ 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.3.2)
|
||||||
jwt (1.0.0)
|
jwt (1.2.0)
|
||||||
mini_portile (0.6.1)
|
mini_portile (0.6.1)
|
||||||
multi_json (1.10.1)
|
multi_json (1.10.1)
|
||||||
multi_xml (0.5.5)
|
multi_xml (0.5.5)
|
||||||
multipart-post (2.0.0)
|
multipart-post (2.0.0)
|
||||||
nokogiri (1.6.4)
|
nokogiri (1.6.5)
|
||||||
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)
|
||||||
@@ -30,6 +30,7 @@ GEM
|
|||||||
multi_xml (~> 0.5)
|
multi_xml (~> 0.5)
|
||||||
rack (~> 1.2)
|
rack (~> 1.2)
|
||||||
rack (1.5.2)
|
rack (1.5.2)
|
||||||
|
rake (10.4.2)
|
||||||
thread_safe (0.3.4)
|
thread_safe (0.3.4)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
@@ -38,3 +39,4 @@ PLATFORMS
|
|||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
colorize
|
colorize
|
||||||
github_api
|
github_api
|
||||||
|
rake
|
||||||
|
|||||||
44
README.md
44
README.md
@@ -2,28 +2,31 @@ GitHub Changelog Generator
|
|||||||
==================
|
==================
|
||||||
|
|
||||||
[](http://badge.fury.io/rb/github_changelog_generator)
|
[](http://badge.fury.io/rb/github_changelog_generator)
|
||||||
|
[](https://travis-ci.org/skywinder/Github-Changelog-Generator)
|
||||||
|
|
||||||
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.
|
This script automatically generate change-log from your tags and merged pull-requests.
|
||||||
|
|
||||||
## Installation:
|
## Installation:
|
||||||
|
You're almost done!
|
||||||
|
|
||||||
[sudo] gem install github_changelog_generator
|
[sudo] gem install github_changelog_generator
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
**It's really simple**:
|
**It's really simple**:
|
||||||
|
|
||||||
- `cd` to your Project folder with configured git and just type:
|
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
|
||||||
|
|
||||||
github_changelog_generator
|
github_changelog_generator
|
||||||
|
|
||||||
- from anywhere:
|
- or from anywhere:
|
||||||
|
|
||||||
github_changelog_generator -u github-username -p github-project
|
github_changelog_generator -u github_username -p github_project
|
||||||
|
|
||||||
As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
|
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||||
|
|
||||||
## Params:
|
### Params:
|
||||||
Type `github_changelog_generator --help` for detailed usage.
|
Type `github_changelog_generator --help` for detailed usage.
|
||||||
|
|
||||||
Usage: changelog_generator [options]
|
Usage: changelog_generator [options]
|
||||||
@@ -42,31 +45,40 @@ Type `github_changelog_generator --help` for detailed usage.
|
|||||||
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
|
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
|
||||||
-v, --version Print version number
|
-v, --version Print version number
|
||||||
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
|
### GitHub token
|
||||||
- This changelog: [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
|
|
||||||
|
|
||||||
|
|
||||||
## FAQ:
|
|
||||||
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
|
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
|
||||||
|
|
||||||
**You can easily [generate it here](https://github.com/settings/applications)**.
|
**You can easily [generate it here](https://github.com/settings/applications)**.
|
||||||
|
|
||||||
And:
|
And:
|
||||||
|
|
||||||
- Run with key `-t [your-16-digit-token]` that
|
- Run with key `-t [your-16-digit-token]`
|
||||||
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your 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"'`
|
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'
|
>! /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 create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
|
||||||
|
|
||||||
|
## Examples:
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
|
||||||
|
## Projects using this library
|
||||||
|
[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
|
||||||
|
|
||||||
|
*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
|
||||||
|
|
||||||
## Am I missed some essential feature?
|
## Am I missed some essential feature?
|
||||||
|
|
||||||
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
@@ -85,3 +97,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
||||||
|
|
||||||
|
|
||||||
|
[](https://bitdeli.com/free "Bitdeli Badge")
|
||||||
|
|
||||||
|
|||||||
9
Rakefile
Normal file
9
Rakefile
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
require "rake/testtask"
|
||||||
|
|
||||||
|
task :default => [:test]
|
||||||
|
|
||||||
|
Rake::TestTask.new do |t|
|
||||||
|
t.verbose = true
|
||||||
|
t.libs.push("demo", "test")
|
||||||
|
t.pattern = "test/**/*_test.rb"
|
||||||
|
end
|
||||||
@@ -3,7 +3,10 @@
|
|||||||
require 'github_api'
|
require 'github_api'
|
||||||
require 'json'
|
require 'json'
|
||||||
require 'colorize'
|
require 'colorize'
|
||||||
|
require 'benchmark'
|
||||||
|
|
||||||
require_relative 'github_changelog_generator/parser'
|
require_relative 'github_changelog_generator/parser'
|
||||||
|
require_relative 'github_changelog_generator/generator'
|
||||||
require_relative 'github_changelog_generator/version'
|
require_relative 'github_changelog_generator/version'
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
@@ -11,17 +14,28 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
attr_accessor :options, :all_tags, :github
|
attr_accessor :options, :all_tags, :github
|
||||||
|
|
||||||
|
PER_PAGE_NUMBER = 30
|
||||||
|
|
||||||
def initialize
|
def initialize
|
||||||
|
|
||||||
@options = Parser.parse_options
|
@options = Parser.parse_options
|
||||||
|
|
||||||
|
if options[:verbose]
|
||||||
|
puts 'Input options:'
|
||||||
|
pp options
|
||||||
|
puts ''
|
||||||
|
end
|
||||||
|
|
||||||
github_token
|
github_token
|
||||||
|
|
||||||
if @github_token.nil?
|
github_options = {per_page: PER_PAGE_NUMBER}
|
||||||
@github = Github.new
|
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||||
else
|
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
|
||||||
@github = Github.new oauth_token: @github_token
|
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
|
||||||
end
|
|
||||||
|
@github = Github.new github_options
|
||||||
|
|
||||||
|
@generator = Generator.new(@options)
|
||||||
|
|
||||||
@all_tags = self.get_all_tags
|
@all_tags = self.get_all_tags
|
||||||
@pull_requests = self.get_all_closed_pull_requests
|
@pull_requests = self.get_all_closed_pull_requests
|
||||||
@@ -39,7 +53,7 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
def exec_command(cmd)
|
def exec_command(cmd)
|
||||||
exec_cmd = "cd #{$project_path} && #{cmd}"
|
exec_cmd = "cd #{$project_path} and #{cmd}"
|
||||||
%x[#{exec_cmd}]
|
%x[#{exec_cmd}]
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -47,18 +61,23 @@ module GitHubChangelogGenerator
|
|||||||
def get_all_closed_pull_requests
|
def get_all_closed_pull_requests
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts 'Fetching pull requests..'
|
print "Fetching pull requests...\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||||
|
|
||||||
pull_requests = []
|
pull_requests = []
|
||||||
|
page_i = 0
|
||||||
response.each_page do |page|
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching pull requests... #{page_i}\r"
|
||||||
pull_requests.concat(page)
|
pull_requests.concat(page)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
print "\r"
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Received all closed pull requests: #{pull_requests.count}"
|
puts "Received closed pull requests: #{pull_requests.count}"
|
||||||
end
|
end
|
||||||
|
|
||||||
unless @options[:pull_request_labels].nil?
|
unless @options[:pull_request_labels].nil?
|
||||||
@@ -91,6 +110,7 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
return filtered_pull_requests
|
return filtered_pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
pull_requests
|
pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -103,8 +123,7 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
if @options[:last]
|
if @options[:last]
|
||||||
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
||||||
elsif @options[:tag1] && @options[:tag2]
|
elsif @options[:tag1] and @options[:tag2]
|
||||||
|
|
||||||
tag1 = @options[:tag1]
|
tag1 = @options[:tag1]
|
||||||
tag2 = @options[:tag2]
|
tag2 = @options[:tag2]
|
||||||
tags_strings = []
|
tags_strings = []
|
||||||
@@ -133,14 +152,19 @@ module GitHubChangelogGenerator
|
|||||||
output_filename = "#{@options[:output]}"
|
output_filename = "#{@options[:output]}"
|
||||||
File.open(output_filename, 'w') { |file| file.write(log) }
|
File.open(output_filename, 'w') { |file| file.write(log) }
|
||||||
|
|
||||||
puts "Done! Generated log placed in #{output_filename}"
|
puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_log_for_all_tags
|
def generate_log_for_all_tags
|
||||||
log = ''
|
log = ''
|
||||||
@all_tags.each { |tag| self.get_time_of_tag(tag) }
|
|
||||||
|
|
||||||
|
# Async fetching tags:
|
||||||
|
threads = []
|
||||||
|
@all_tags.each { |tag|
|
||||||
|
threads << Thread.new { self.get_time_of_tag(tag) }
|
||||||
|
}
|
||||||
|
threads.each { |thr| thr.join }
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Sorting tags.."
|
puts "Sorting tags.."
|
||||||
@@ -152,11 +176,11 @@ module GitHubChangelogGenerator
|
|||||||
puts "Generating log.."
|
puts "Generating log.."
|
||||||
end
|
end
|
||||||
|
|
||||||
for index in 1 ... self.all_tags.size
|
(1 ... self.all_tags.size).each { |index|
|
||||||
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
||||||
end
|
}
|
||||||
|
|
||||||
log += self.generate_log_before_tag(self.all_tags.last)
|
log += generate_log_between_tags(nil, self.all_tags.last)
|
||||||
|
|
||||||
log
|
log
|
||||||
end
|
end
|
||||||
@@ -168,16 +192,19 @@ module GitHubChangelogGenerator
|
|||||||
def get_all_tags
|
def get_all_tags
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts 'Fetching all tags..'
|
print "Fetching tags...\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
response = @github.repos.tags @options[:user], @options[:project]
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
|
|
||||||
tags = []
|
tags = []
|
||||||
|
page_i = 0
|
||||||
response.each_page do |page|
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching tags... #{page_i}\r"
|
||||||
tags.concat(page)
|
tags.concat(page)
|
||||||
end
|
end
|
||||||
|
print "\r"
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Found #{tags.count} tags"
|
puts "Found #{tags.count} tags"
|
||||||
end
|
end
|
||||||
@@ -204,74 +231,119 @@ module GitHubChangelogGenerator
|
|||||||
|
|
||||||
def generate_log_between_tags(older_tag, newer_tag)
|
def generate_log_between_tags(older_tag, newer_tag)
|
||||||
|
|
||||||
|
if newer_tag.nil?
|
||||||
|
puts "Can't find tag -> terminate"
|
||||||
|
exit 1
|
||||||
|
end
|
||||||
|
|
||||||
newer_tag_time = self.get_time_of_tag(newer_tag)
|
newer_tag_time = self.get_time_of_tag(newer_tag)
|
||||||
newer_tag_name = newer_tag['name']
|
newer_tag_name = newer_tag['name']
|
||||||
|
|
||||||
if older_tag.nil?
|
if older_tag.nil?
|
||||||
|
older_tag_name = nil
|
||||||
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
|
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
|
||||||
issues = delete_by_time(@issues, :closed_at, newer_tag_time)
|
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time)
|
||||||
else
|
else
|
||||||
older_tag_time = self.get_time_of_tag(older_tag)
|
older_tag_time = self.get_time_of_tag(older_tag)
|
||||||
|
older_tag_name = older_tag['name']
|
||||||
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
|
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
|
||||||
issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
|
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
|
||||||
end
|
end
|
||||||
|
|
||||||
self.create_log(filtered_pull_requests, issues, newer_tag_name, newer_tag_time)
|
|
||||||
|
if @options[:filter_issues_by_milestone]
|
||||||
|
#delete excess irrelevant issues (according milestones)
|
||||||
|
filtered_issues.select! { |issue|
|
||||||
|
if issue.milestone.nil?
|
||||||
|
true
|
||||||
|
else
|
||||||
|
#check, that this milestone in tag list:
|
||||||
|
milestone_is_tag = @all_tags.find { |tag|
|
||||||
|
tag.name == issue.milestone.title
|
||||||
|
}
|
||||||
|
milestone_is_tag.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
#add missed issues (according milestones)
|
||||||
|
issues_to_add = @issues.select { |issue|
|
||||||
|
if issue.milestone.nil?
|
||||||
|
false
|
||||||
|
else
|
||||||
|
#check, that this milestone in tag list:
|
||||||
|
milestone_is_tag = @all_tags.find { |tag|
|
||||||
|
tag.name == issue.milestone.title
|
||||||
|
}
|
||||||
|
|
||||||
|
if milestone_is_tag.nil?
|
||||||
|
false
|
||||||
|
else
|
||||||
|
issue.milestone.title == newer_tag_name
|
||||||
|
end
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
filtered_issues |= issues_to_add
|
||||||
|
end
|
||||||
|
|
||||||
|
self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time, older_tag_name)
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
|
def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
|
||||||
array_new = Array.new(array)
|
array.select { |req|
|
||||||
array_new.delete_if { |req|
|
|
||||||
if req[hash_key]
|
if req[hash_key]
|
||||||
t = Time.parse(req[hash_key]).utc
|
t = Time.parse(req[hash_key]).utc
|
||||||
|
|
||||||
if older_tag_time.nil?
|
if older_tag_time.nil?
|
||||||
tag_is_older_of_older = false
|
tag_in_range_old = true
|
||||||
else
|
else
|
||||||
tag_is_older_of_older = t > older_tag_time
|
tag_in_range_old = t > older_tag_time
|
||||||
end
|
end
|
||||||
|
|
||||||
tag_is_newer_than_new = t <= newer_tag_time
|
tag_in_range_new = t <= newer_tag_time
|
||||||
|
|
||||||
tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
|
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||||
!tag_not_in_range
|
|
||||||
|
tag_in_range
|
||||||
else
|
else
|
||||||
true
|
false
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_log_before_tag(tag)
|
# @param [Array] pull_requests
|
||||||
generate_log_between_tags(nil, tag)
|
# @param [Array] issues
|
||||||
end
|
# @param [String] newer_tag_name
|
||||||
|
# @param [String] newer_tag_time
|
||||||
|
# @param [String] older_tag_name
|
||||||
|
# @return [String]
|
||||||
|
def create_log(pull_requests, issues, newer_tag_name, newer_tag_time, older_tag_name = nil)
|
||||||
|
|
||||||
def create_log(pull_requests, issues, tag_name, tag_time)
|
github_site = options[:github_site] || 'https://github.com'
|
||||||
|
|
||||||
|
project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
|
||||||
|
|
||||||
# Generate tag name and link
|
# Generate tag name and link
|
||||||
trimmed_tag = tag_name.tr('v', '')
|
log = "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name})\n"
|
||||||
log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
|
||||||
|
if @options[:compare_link] && older_tag_name
|
||||||
|
# Generate compare link
|
||||||
|
log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name})\n"
|
||||||
|
end
|
||||||
|
|
||||||
#Generate date string:
|
#Generate date string:
|
||||||
time_string = tag_time.strftime @options[:format]
|
time_string = newer_tag_time.strftime @options[:format]
|
||||||
log += "#### #{time_string}\n"
|
log += "#### #{time_string}\n"
|
||||||
|
|
||||||
if @options[:pulls]
|
if @options[:pulls]
|
||||||
# Generate pull requests:
|
# Generate pull requests:
|
||||||
if pull_requests
|
pull_requests.each { |pull_request|
|
||||||
if @options[:author]
|
merge = @generator.get_string_for_pull_request(pull_request)
|
||||||
pull_requests.each { |dict|
|
log += "- #{merge}"
|
||||||
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url}) ([#{dict.user.login}](#{dict.user.html_url}))\n\n"
|
|
||||||
log += "- #{merge}"
|
|
||||||
}
|
|
||||||
else
|
|
||||||
pull_requests.each { |dict|
|
|
||||||
merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
|
||||||
log += "- #{merge}"
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
} if pull_requests
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:issues]
|
if @options[:issues]
|
||||||
@@ -314,7 +386,9 @@ module GitHubChangelogGenerator
|
|||||||
intro = 'Implemented enhancement'
|
intro = 'Implemented enhancement'
|
||||||
end
|
end
|
||||||
|
|
||||||
merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
enc_string = @generator.encapsulate_string dict[:title]
|
||||||
|
|
||||||
|
merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
||||||
log += "- #{merge}"
|
log += "- #{merge}"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
@@ -327,10 +401,6 @@ module GitHubChangelogGenerator
|
|||||||
return @tag_times_hash[prev_tag['name']]
|
return @tag_times_hash[prev_tag['name']]
|
||||||
end
|
end
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Getting time for tag #{prev_tag['name']}"
|
|
||||||
end
|
|
||||||
|
|
||||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
||||||
time_string = github_git_data_commits_get['committer']['date']
|
time_string = github_git_data_commits_get['committer']['date']
|
||||||
Time.parse(time_string)
|
Time.parse(time_string)
|
||||||
@@ -340,17 +410,21 @@ module GitHubChangelogGenerator
|
|||||||
def get_all_issues
|
def get_all_issues
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts 'Fetching closed issues..'
|
print "Fetching closed issues...\r"
|
||||||
end
|
end
|
||||||
|
|
||||||
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
||||||
|
|
||||||
|
|
||||||
issues = []
|
issues = []
|
||||||
|
page_i = 0
|
||||||
response.each_page do |page|
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching closed issues... #{page_i}\r"
|
||||||
issues.concat(page)
|
issues.concat(page)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
print "\r"
|
||||||
|
|
||||||
# remove pull request from issues:
|
# remove pull request from issues:
|
||||||
issues.select! { |x|
|
issues.select! { |x|
|
||||||
x.pull_request == nil
|
x.pull_request == nil
|
||||||
@@ -360,6 +434,11 @@ module GitHubChangelogGenerator
|
|||||||
puts "Received closed issues: #{issues.count}"
|
puts "Received closed issues: #{issues.count}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Filtering issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}"
|
||||||
|
end
|
||||||
|
|
||||||
filtered_issues = issues.select { |issue|
|
filtered_issues = issues.select { |issue|
|
||||||
#compare is there any labels from @options[:labels] array
|
#compare is there any labels from @options[:labels] array
|
||||||
(issue.labels.map { |label| label.name } & @options[:labels]).any?
|
(issue.labels.map { |label| label.name } & @options[:labels]).any?
|
||||||
@@ -374,7 +453,7 @@ module GitHubChangelogGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
if @options[:verbose]
|
if @options[:verbose]
|
||||||
puts "Filter issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}: #{filtered_issues.count} issues"
|
puts "Filtered issues: #{filtered_issues.count}"
|
||||||
end
|
end
|
||||||
|
|
||||||
filtered_issues
|
filtered_issues
|
||||||
|
|||||||
38
lib/github_changelog_generator/generator.rb
Normal file
38
lib/github_changelog_generator/generator.rb
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
module GitHubChangelogGenerator
|
||||||
|
class Generator
|
||||||
|
|
||||||
|
def initialize(options = nil)
|
||||||
|
@options = options
|
||||||
|
end
|
||||||
|
|
||||||
|
def get_string_for_pull_request(pull_request)
|
||||||
|
encapsulated_title = self.encapsulate_string pull_request[:title]
|
||||||
|
|
||||||
|
merge = "#{@options[:merge_prefix]}#{encapsulated_title} [\\##{pull_request[:number]}](#{pull_request.html_url})"
|
||||||
|
if @options[:author]
|
||||||
|
if pull_request.user.nil?
|
||||||
|
merge += " ({Null user})\n\n"
|
||||||
|
else
|
||||||
|
merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
|
||||||
|
end
|
||||||
|
else
|
||||||
|
merge += "\n\n"
|
||||||
|
end
|
||||||
|
merge
|
||||||
|
end
|
||||||
|
|
||||||
|
def encapsulate_string(string)
|
||||||
|
|
||||||
|
string.gsub! '\\', '\\\\'
|
||||||
|
|
||||||
|
encpas_chars = %w(> * _ \( \) [ ])
|
||||||
|
encpas_chars.each{ |char|
|
||||||
|
string.gsub! char, "\\#{char}"
|
||||||
|
}
|
||||||
|
|
||||||
|
string
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
require 'optparse'
|
require 'optparse'
|
||||||
require 'PP'
|
require 'pp'
|
||||||
require_relative 'version'
|
require_relative 'version'
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class Parser
|
class Parser
|
||||||
def self.parse_options
|
def self.parse_options
|
||||||
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => %w(bug enhancement)}
|
options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => nil, :filter_issues_by_milestone => true, :compare_link => true}
|
||||||
|
|
||||||
parser = OptionParser.new { |opts|
|
parser = OptionParser.new { |opts|
|
||||||
opts.banner = 'Usage: changelog_generator [options]'
|
opts.banner = 'Usage: changelog_generator [options]'
|
||||||
@@ -16,12 +16,14 @@ module GitHubChangelogGenerator
|
|||||||
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
|
opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
|
||||||
options[:project] = last
|
options[:project] = last
|
||||||
end
|
end
|
||||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new') do |last|
|
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
|
||||||
options[:token] = last
|
options[:token] = last
|
||||||
end
|
end
|
||||||
opts.on('-h', '--help', 'Displays Help') do
|
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
||||||
puts opts
|
options[:format] = last
|
||||||
exit
|
end
|
||||||
|
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
||||||
|
options[:output] = last
|
||||||
end
|
end
|
||||||
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
||||||
options[:verbose] = v
|
options[:verbose] = v
|
||||||
@@ -35,47 +37,55 @@ module GitHubChangelogGenerator
|
|||||||
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
||||||
options[:pulls] = v
|
options[:pulls] = v
|
||||||
end
|
end
|
||||||
opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
|
opts.on('--[no-]filter-issues-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
|
||||||
options[:last] = last
|
options[:filter_issues_by_milestone] = last
|
||||||
end
|
end
|
||||||
opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
|
opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
|
||||||
options[:last] = author
|
options[:last] = author
|
||||||
end
|
end
|
||||||
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
opts.on('--[no-]compare-link', 'Include compare link between older version and newer version. Default is true') do |v|
|
||||||
options[:format] = last
|
options[:compare_link] = v
|
||||||
end
|
|
||||||
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
|
||||||
options[:output] = last
|
|
||||||
end
|
end
|
||||||
opts.on('--labels x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
opts.on('--labels x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
|
||||||
options[:labels] = list
|
options[:labels] = list
|
||||||
end
|
end
|
||||||
opts.on('--filter-pull-requests x,y,z', Array, 'Pull requests with that labels will be included to changelog. pull requests w\o labels will be included anyway. Default is \'bug,enhancement\'') do |list|
|
opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
|
||||||
options[:pull_request_labels] = list
|
options[:pull_request_labels] = list
|
||||||
end
|
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('-v', '--version', 'Print version number') do |v|
|
opts.on('-v', '--version', 'Print version number') do |v|
|
||||||
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
opts.on('-h', '--help', 'Displays Help') do
|
||||||
|
puts opts
|
||||||
|
exit
|
||||||
|
end
|
||||||
}
|
}
|
||||||
|
|
||||||
parser.parse!
|
parser.parse!
|
||||||
|
|
||||||
if options[:verbose]
|
|
||||||
puts 'Input options:'
|
|
||||||
pp options
|
|
||||||
puts ''
|
|
||||||
end
|
|
||||||
|
|
||||||
#udefined case with 1 parameter:
|
|
||||||
if ARGV[0] && !ARGV[1]
|
if ARGV[0] && !ARGV[1]
|
||||||
puts parser.banner
|
github_site = options[:github_site] ? options[:github_site] : 'github.com'
|
||||||
exit
|
# this match should parse https://github.com/skywinder/Github-Changelog-Generator and skywinder/Github-Changelog-Generator to user and name
|
||||||
|
match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
|
||||||
|
|
||||||
|
if match[2].nil?
|
||||||
|
exit
|
||||||
|
else
|
||||||
|
options[:user] = match[1]
|
||||||
|
options[:project]= match[2]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if !options[:user] && !options[:project]
|
if !options[:user] && !options[:project]
|
||||||
remote = `git remote -vv`.split("\n")
|
remote = `git remote -vv`.split("\n")
|
||||||
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
|
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])
|
||||||
|
|
||||||
if match && match[1] && match[2]
|
if match && match[1] && match[2]
|
||||||
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
||||||
@@ -92,7 +102,6 @@ module GitHubChangelogGenerator
|
|||||||
if ARGV[1]
|
if ARGV[1]
|
||||||
options[:tag1] = ARGV[0]
|
options[:tag1] = ARGV[0]
|
||||||
options[:tag2] = ARGV[1]
|
options[:tag2] = ARGV[1]
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
options
|
options
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
VERSION = '1.2.0'
|
VERSION = '1.2.7'
|
||||||
end
|
end
|
||||||
|
|||||||
Reference in New Issue
Block a user