Compare commits
208 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6f8aee6a4b | ||
|
|
3e3cc15592 | ||
|
|
d5edb1f606 | ||
|
|
e6d0c3d791 | ||
|
|
c1d28d486f | ||
|
|
fa713af816 | ||
|
|
17f7127de1 | ||
|
|
e1a264e2c9 | ||
|
|
e4b79e75ca | ||
|
|
c7a767451d | ||
|
|
01f44b8311 | ||
|
|
c0015a2c22 | ||
|
|
49cb6589f7 | ||
|
|
e139f839c9 | ||
|
|
a7a75a181e | ||
|
|
6efa421816 | ||
|
|
e8d59fe66a | ||
|
|
6b5cf5ab2e | ||
|
|
de6763aa3a | ||
|
|
5f019482d2 | ||
|
|
6da115c4b0 | ||
|
|
657ce0e838 | ||
|
|
5304e4faf8 | ||
|
|
e6bb728355 | ||
|
|
135c48a494 | ||
|
|
6bad92e899 | ||
|
|
ad4c20d8d8 | ||
|
|
a5d9766aef | ||
|
|
a0cfaa66a2 | ||
|
|
d16f4f7cb5 | ||
|
|
1d6d6ab400 | ||
|
|
5b07fc9614 | ||
|
|
3437fbf278 | ||
|
|
ba4db0e5f4 | ||
|
|
abac1013f1 | ||
|
|
28247edc7f | ||
|
|
fcc1c608a2 | ||
|
|
46ae40f250 | ||
|
|
00f98b8ca6 | ||
|
|
5da838efee | ||
|
|
73b789ab82 | ||
|
|
b5778b14a0 | ||
|
|
e29ff3c3a9 | ||
|
|
9646b49add | ||
|
|
a44b0bdd25 | ||
|
|
433d46d85b | ||
|
|
950e8916d9 | ||
|
|
87c6e33335 | ||
|
|
4488ac8cc6 | ||
|
|
c697c6be4a | ||
|
|
69dd5eadc2 | ||
|
|
4ea1058cd5 | ||
|
|
fcd78e6bc4 | ||
|
|
e6c0d49200 | ||
|
|
0f5db97474 | ||
|
|
0901b38577 | ||
|
|
2a24f49a83 | ||
|
|
2ad014d5c7 | ||
|
|
188ba7e073 | ||
|
|
6f53fe0a1d | ||
|
|
2c7853cf9f | ||
|
|
6830ea49f2 | ||
|
|
5be1a2afaf | ||
|
|
7be5021685 | ||
|
|
c3373b2343 | ||
|
|
9aa156a02b | ||
|
|
68a8d8d2c8 | ||
|
|
057fb488d5 | ||
|
|
f1d9c839c7 | ||
|
|
97d048d62f | ||
|
|
7972ec0977 | ||
|
|
f55598825d | ||
|
|
a678b52fe4 | ||
|
|
aac04726ba | ||
|
|
0c65035cde | ||
|
|
e038c7e680 | ||
|
|
bcecb4eb81 | ||
|
|
52123885a1 | ||
|
|
326a067ac5 | ||
|
|
5dcbef87d1 | ||
|
|
caf264360b | ||
|
|
bc13632545 | ||
|
|
67b438f46b | ||
|
|
ff52291d2a | ||
|
|
b2df1cfdcd | ||
|
|
f037a839ce | ||
|
|
5295389fcc | ||
|
|
8e5b4ed191 | ||
|
|
80cc3fc625 | ||
|
|
f087699d07 | ||
|
|
540df2ef51 | ||
|
|
54d029d8ea | ||
|
|
bec4fdef0e | ||
|
|
b5d5615244 | ||
|
|
766569c27a | ||
|
|
51e3c2ee54 | ||
|
|
e1e5de555b | ||
|
|
0e4474bb2d | ||
|
|
fa4ccb7e9c | ||
|
|
36fbe509fa | ||
|
|
4c5ca562cf | ||
|
|
27432c3328 | ||
|
|
4a27872695 | ||
|
|
bf88bc0a0e | ||
|
|
3b145bd7ed | ||
|
|
97311bc5a0 | ||
|
|
bdc4657e2c | ||
|
|
0c8a96aef8 | ||
|
|
c9462a6c9b | ||
|
|
0a43c25f8f | ||
|
|
c58ec0dcbb | ||
|
|
7aa9b6ca47 | ||
|
|
865a364dff | ||
|
|
062f3fd3f2 | ||
|
|
a4e9390283 | ||
|
|
09f5ac5d37 | ||
|
|
aed5c37559 | ||
|
|
9f9f237e96 | ||
|
|
3e1abf928d | ||
|
|
7ce486085b | ||
|
|
bf17d9e284 | ||
|
|
fadae1b714 | ||
|
|
a5cb604bc1 | ||
|
|
7f89aae72e | ||
|
|
b6ec9bd8be | ||
|
|
80de58779d | ||
|
|
07e0ec0cfb | ||
|
|
fab1e28e3e | ||
|
|
0ab44f79f7 | ||
|
|
269ab4e790 | ||
|
|
4fa903b5cd | ||
|
|
c018bf2db5 | ||
|
|
c830d6c1ef | ||
|
|
03bca478c8 | ||
|
|
91229c7472 | ||
|
|
7bd174126b | ||
|
|
4b716645e5 | ||
|
|
7b44c4aa78 | ||
|
|
95bdd60c34 | ||
|
|
1357b3980d | ||
|
|
a5c4899360 | ||
|
|
b30587ce14 | ||
|
|
18e0f937ea | ||
|
|
1af8e18f9f | ||
|
|
a458a1e378 | ||
|
|
bc3af7fa93 | ||
|
|
6682ffe452 | ||
|
|
dbc7b3e567 | ||
|
|
a96f74208c | ||
|
|
cdc009b4ad | ||
|
|
0046f344a9 | ||
|
|
1b792bc67b | ||
|
|
f0716771b5 | ||
|
|
50dd7b2ed6 | ||
|
|
3797b3ac31 | ||
|
|
f08685b015 | ||
|
|
fc96007741 | ||
|
|
7e2826e3b8 | ||
|
|
c55881bdfa | ||
|
|
f6f9facc71 | ||
|
|
807bacd95a | ||
|
|
936b191566 | ||
|
|
a33b52d6d0 | ||
|
|
337c9a7d59 | ||
|
|
8247fd8520 | ||
|
|
223cd2640c | ||
|
|
459b0ec7ec | ||
|
|
ea1c5c1f6d | ||
|
|
86512d3606 | ||
|
|
b908b07e0a | ||
|
|
737774a164 | ||
|
|
62d9b7f4a6 | ||
|
|
e75e358ef8 | ||
|
|
3ac83e9ea7 | ||
|
|
70d3f63e89 | ||
|
|
2db69dd27c | ||
|
|
5a7589f8ca | ||
|
|
1adcd9918c | ||
|
|
afea098355 | ||
|
|
d3c3b7850f | ||
|
|
502ae431b7 | ||
|
|
5882762800 | ||
|
|
606fab4289 | ||
|
|
3d25d1135f | ||
|
|
acd2daada3 | ||
|
|
381ffeb261 | ||
|
|
f9e6a076bc | ||
|
|
8457b764bf | ||
|
|
4237b751a0 | ||
|
|
3a78f97d61 | ||
|
|
24c5f66c65 | ||
|
|
9c4b68f779 | ||
|
|
65e978f4a8 | ||
|
|
6b4333f98a | ||
|
|
675601880d | ||
|
|
e2aac3cb2c | ||
|
|
20095c571d | ||
|
|
db1c125e7e | ||
|
|
a335594bcc | ||
|
|
5e64e5a226 | ||
|
|
0a69f76191 | ||
|
|
959d406ef0 | ||
|
|
cf4386a3a3 | ||
|
|
daf391dd1a | ||
|
|
26d4717b7d | ||
|
|
e331525e21 | ||
|
|
b32969e72c | ||
|
|
b8d13a6331 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,2 +1 @@
|
|||||||
constants.rb
|
/lib/CHANGELOG.md
|
||||||
*.md
|
|
||||||
|
|||||||
15
.travis.yml
Normal file
15
.travis.yml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
language: ruby
|
||||||
|
before_install:
|
||||||
|
- gem update --system
|
||||||
|
- gem --version
|
||||||
|
rvm:
|
||||||
|
- 2.1.0
|
||||||
|
gemfile:
|
||||||
|
- Gemfile
|
||||||
|
|
||||||
|
notifications:
|
||||||
|
email:
|
||||||
|
recipients:
|
||||||
|
- sky4winder+githubchangeloggenerator@gmail.com
|
||||||
|
on_success: never # [always|never|change]
|
||||||
|
on_failure: change # [always|never|change]
|
||||||
109
CHANGELOG.md
Normal file
109
CHANGELOG.md
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## [1.2.5] (https://github.com/skywinder/Github-Changelog-Generator/tree/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)
|
||||||
|
#### 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)
|
||||||
|
#### 16/12/14
|
||||||
|
## [1.2.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/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)
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
## [1.2.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/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)
|
||||||
|
#### 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)
|
||||||
|
#### 12/11/14
|
||||||
|
- *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) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
|
||||||
|
#### 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) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- *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) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
|
||||||
|
#### 10/11/14
|
||||||
|
- *Implemented enhancement:* Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
||||||
|
|
||||||
|
- *Fixed bug:* Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
|
||||||
|
|
||||||
|
- *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)
|
||||||
|
#### 10/11/14
|
||||||
|
- *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)
|
||||||
|
#### 07/11/14
|
||||||
|
- *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) ([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:* Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
|
||||||
|
|
||||||
|
- *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)
|
||||||
|
#### 07/11/14
|
||||||
|
- *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) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
|
||||||
|
#### 06/11/14
|
||||||
|
## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
|
||||||
|
#### 06/11/14
|
||||||
|
|
||||||
|
|
||||||
|
\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
3
Gemfile
3
Gemfile
@@ -1,3 +1,4 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
gem 'github_api'
|
gem 'github_api'
|
||||||
gem 'httparty'
|
gem 'colorize'
|
||||||
|
gem 'rake'
|
||||||
|
|||||||
15
Gemfile.lock
15
Gemfile.lock
@@ -2,6 +2,7 @@ GEM
|
|||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
addressable (2.3.6)
|
addressable (2.3.6)
|
||||||
|
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)
|
||||||
@@ -14,17 +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)
|
||||||
httparty (0.13.2)
|
jwt (1.2.0)
|
||||||
json (~> 1.8)
|
|
||||||
multi_xml (>= 0.5.2)
|
|
||||||
json (1.8.1)
|
|
||||||
jwt (1.0.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)
|
||||||
@@ -33,11 +30,13 @@ 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
|
||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
|
colorize
|
||||||
github_api
|
github_api
|
||||||
httparty
|
rake
|
||||||
|
|||||||
106
README.md
106
README.md
@@ -1,23 +1,103 @@
|
|||||||
Github Changelog Generator
|
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.
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
Usage: github_changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
|
## Installation:
|
||||||
-u, --user [USER] your username on GitHub
|
You're almost done!
|
||||||
-p, --project [PROJECT] name of project on GitHub
|
|
||||||
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
|
|
||||||
-h, --help Displays Help
|
|
||||||
-v, --[no-]verbose Run verbosely
|
|
||||||
-l, --last-changes generate log between last 2 tags
|
|
||||||
-f, --date-format [FORMAT] date format. default is %d/%m/%y
|
|
||||||
|
|
||||||
### Example:
|
[sudo] gem install github_changelog_generator
|
||||||
`github_changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]`
|
|
||||||
|
|
||||||
In output you get `[your_project]_changelog.md` file with automatically generated changelogs.
|
## Usage
|
||||||
|
**It's really simple**:
|
||||||
|
|
||||||
|
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
|
||||||
|
|
||||||
|
github_changelog_generator
|
||||||
|
|
||||||
|
- or from anywhere:
|
||||||
|
|
||||||
|
github_changelog_generator -u github_username -p github_project
|
||||||
|
|
||||||
|
As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
|
||||||
|
|
||||||
|
### Params:
|
||||||
|
Type `github_changelog_generator --help` for detailed usage.
|
||||||
|
|
||||||
|
Usage: changelog_generator [options]
|
||||||
|
-u, --user [USER] Username of the owner of target GitHub repo
|
||||||
|
-p, --project [PROJECT] Name of project on GitHub
|
||||||
|
-t, --token [TOKEN] To make more than 50 requests this script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new
|
||||||
|
-h, --help Displays Help
|
||||||
|
--[no-]verbose Run verbosely. Default is true
|
||||||
|
--[no-]issues Include closed issues to changelog. Default is true
|
||||||
|
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
|
||||||
|
--[no-]pull-requests Include pull-requests to changelog. Default is true
|
||||||
|
-l, --last-changes Generate log between last 2 tags only
|
||||||
|
--[no-]author Add author of pull-request in the end. Default is true
|
||||||
|
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
|
||||||
|
-o, --output [NAME] Output file. Default is CHANGELOG.md
|
||||||
|
--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
|
||||||
|
|
||||||
|
|
||||||
|
### GitHub 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)**.
|
||||||
|
|
||||||
|
And:
|
||||||
|
|
||||||
|
- Run with key `-t [your-16-digit-token]`
|
||||||
|
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
||||||
|
|
||||||
|
i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
|
||||||
|
|
||||||
|
export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
|
||||||
|
|
||||||
|
So, if you got error like this:
|
||||||
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
||||||
|
|
||||||
|
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?
|
||||||
|
|
||||||
|
**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
||||||
|
|
||||||
|
*Bug reports, feature requests, patches, well-wishes are always welcome!*
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
1. Create an issue to discuss about your idea
|
||||||
|
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
||||||
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
|
6. Create a new Pull Request
|
||||||
|
|
||||||
## 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
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
#!/usr/bin/env ruby
|
#! /usr/bin/env ruby
|
||||||
|
|
||||||
require 'github_changelog_generator'
|
require 'github_changelog_generator'
|
||||||
|
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||||
ChangelogGenerator.new.compund_changelog
|
|
||||||
227
bump_gemfile.rb
Executable file
227
bump_gemfile.rb
Executable file
@@ -0,0 +1,227 @@
|
|||||||
|
#!/usr/bin/env ruby
|
||||||
|
require 'optparse'
|
||||||
|
|
||||||
|
SPEC_TYPE = 'gemspec'
|
||||||
|
|
||||||
|
:major
|
||||||
|
:minor
|
||||||
|
:patch
|
||||||
|
|
||||||
|
@options = {:dry_run => false, :bump_number => :patch}
|
||||||
|
|
||||||
|
OptionParser.new { |opts|
|
||||||
|
opts.banner = 'Usage: bump.rb [options]'
|
||||||
|
|
||||||
|
opts.on('-d', '--dry-run', 'Dry run') do |v|
|
||||||
|
@options[:dry_run] = v
|
||||||
|
end
|
||||||
|
opts.on('-a', '--major', 'Bump major version') do |v|
|
||||||
|
@options[:bump_number] = :major
|
||||||
|
end
|
||||||
|
opts.on('-m', '--minor', 'Bump minor version') do |v|
|
||||||
|
@options[:bump_number] = :minor
|
||||||
|
end
|
||||||
|
opts.on('-p', '--patch', 'Bump patch version') do |v|
|
||||||
|
@options[:bump_number] = :patch
|
||||||
|
end
|
||||||
|
opts.on('-r', '--revert', 'Revert last bump') do |v|
|
||||||
|
@options[:revert] = v
|
||||||
|
end
|
||||||
|
}.parse!
|
||||||
|
|
||||||
|
p @options
|
||||||
|
|
||||||
|
def check_repo_is_clean_or_dry_run
|
||||||
|
value =%x[#{'git status --porcelain'}]
|
||||||
|
|
||||||
|
if value.empty?
|
||||||
|
puts 'Repo is clean -> continue'
|
||||||
|
else
|
||||||
|
if @options[:dry_run]
|
||||||
|
puts 'Repo not clean, "Dry run" enabled -> continue'
|
||||||
|
else
|
||||||
|
puts 'Repository not clean -> exit'
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def find_spec_file
|
||||||
|
list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
|
||||||
|
arr = list_of_specs.split("\n")
|
||||||
|
|
||||||
|
spec_file = ''
|
||||||
|
|
||||||
|
case arr.count
|
||||||
|
when 0
|
||||||
|
puts "No #{SPEC_TYPE} files found. -> Exit."
|
||||||
|
exit
|
||||||
|
when 1
|
||||||
|
spec_file = arr[0]
|
||||||
|
else
|
||||||
|
puts 'Which spec should be used?'
|
||||||
|
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
||||||
|
input_index = Integer(gets.chomp)
|
||||||
|
spec_file = arr[input_index-1]
|
||||||
|
end
|
||||||
|
|
||||||
|
if spec_file == nil
|
||||||
|
puts "Can't find specified spec file -> exit"
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
spec_file.sub('./', '')
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def find_current_gem_file
|
||||||
|
list_of_specs = execute_line("find . -name '*.gem'")
|
||||||
|
arr = list_of_specs.split("\n")
|
||||||
|
|
||||||
|
spec_file = ''
|
||||||
|
|
||||||
|
case arr.count
|
||||||
|
when 0
|
||||||
|
puts "No #{SPEC_TYPE} files found. -> Exit."
|
||||||
|
exit
|
||||||
|
when 1
|
||||||
|
spec_file = arr[0]
|
||||||
|
else
|
||||||
|
puts 'Which spec should be used?'
|
||||||
|
arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
|
||||||
|
input_index = Integer(gets.chomp)
|
||||||
|
spec_file = arr[input_index-1]
|
||||||
|
end
|
||||||
|
|
||||||
|
if spec_file == nil
|
||||||
|
puts "Can't find specified spec file -> exit"
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
spec_file.sub('./', '')
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def find_version_in_podspec(podspec)
|
||||||
|
readme = File.read(podspec)
|
||||||
|
|
||||||
|
#try to find version in format 1.22.333
|
||||||
|
re = /(\d+)\.(\d+)\.(\d+)/m
|
||||||
|
|
||||||
|
match_result = re.match(readme)
|
||||||
|
|
||||||
|
unless match_result
|
||||||
|
puts 'Not found any versions'
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
|
||||||
|
puts "Found version #{match_result[0]}"
|
||||||
|
return match_result[0], match_result.captures
|
||||||
|
end
|
||||||
|
|
||||||
|
def bump_version(versions_array)
|
||||||
|
bumped_result = versions_array.dup
|
||||||
|
bumped_result.map! { |x| x.to_i }
|
||||||
|
|
||||||
|
case @options[:bump_number]
|
||||||
|
when :major
|
||||||
|
bumped_result[0] += 1
|
||||||
|
bumped_result[1] = 0
|
||||||
|
bumped_result[2] = 0
|
||||||
|
when :minor
|
||||||
|
bumped_result[1] += 1
|
||||||
|
bumped_result[2] = 0
|
||||||
|
when :patch
|
||||||
|
bumped_result[2] += 1
|
||||||
|
else
|
||||||
|
raise('unknown bump_number')
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
bumped_version = bumped_result.join('.')
|
||||||
|
puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
|
||||||
|
bumped_version
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_line(line)
|
||||||
|
output = `#{line}`
|
||||||
|
check_exit_status(output)
|
||||||
|
|
||||||
|
output
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_line_if_not_dry_run(line)
|
||||||
|
if @options[:dry_run]
|
||||||
|
puts "Dry run: #{line}"
|
||||||
|
nil
|
||||||
|
else
|
||||||
|
puts line
|
||||||
|
value = %x[#{line}]
|
||||||
|
puts value
|
||||||
|
check_exit_status(value)
|
||||||
|
value
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_exit_status(output)
|
||||||
|
if $?.exitstatus != 0
|
||||||
|
puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_bumping_script
|
||||||
|
|
||||||
|
check_repo_is_clean_or_dry_run
|
||||||
|
spec_file = find_spec_file
|
||||||
|
result, versions_array = find_version_in_podspec(spec_file)
|
||||||
|
bumped_version = bump_version(versions_array)
|
||||||
|
|
||||||
|
unless @options[:dry_run]
|
||||||
|
puts 'Are you sure? Press Y to continue:'
|
||||||
|
str = gets.chomp
|
||||||
|
if str != 'Y'
|
||||||
|
puts '-> exit'
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" README.md")
|
||||||
|
execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
|
||||||
|
execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
|
||||||
|
execute_line_if_not_dry_run("git tag #{bumped_version}")
|
||||||
|
execute_line_if_not_dry_run('git push')
|
||||||
|
execute_line_if_not_dry_run('git push --tags')
|
||||||
|
execute_line_if_not_dry_run("gem build #{spec_file}")
|
||||||
|
|
||||||
|
gem = find_current_gem_file
|
||||||
|
execute_line_if_not_dry_run("gem push #{gem}")
|
||||||
|
# execute_line_if_not_dry_run("pod trunk push #{spec_file}")
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def revert_last_bump
|
||||||
|
spec_file = find_spec_file
|
||||||
|
result, _ = find_version_in_podspec(spec_file)
|
||||||
|
|
||||||
|
puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
|
||||||
|
str = gets.chomp
|
||||||
|
if str != 'Y'
|
||||||
|
puts '-> exit'
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
execute_line_if_not_dry_run("git tag -d #{result}")
|
||||||
|
execute_line_if_not_dry_run('git reset --hard HEAD~1')
|
||||||
|
execute_line_if_not_dry_run("git push --delete origin #{result}")
|
||||||
|
end
|
||||||
|
|
||||||
|
if __FILE__ == $0
|
||||||
|
|
||||||
|
if @options[:revert]
|
||||||
|
revert_last_bump
|
||||||
|
else
|
||||||
|
run_bumping_script
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -1,22 +1,32 @@
|
|||||||
Gem::Specification.new do |s|
|
# coding: utf-8
|
||||||
s.name = "github_changelog_generator"
|
|
||||||
s.version = "0.0.1"
|
|
||||||
s.default_executable = "github_changelog_generator"
|
|
||||||
|
|
||||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
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.6"])
|
Gem::Specification.new do |spec|
|
||||||
s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
spec.name = "github_changelog_generator"
|
||||||
|
spec.version = GitHubChangelogGenerator::VERSION
|
||||||
|
spec.default_executable = "github_changelog_generator"
|
||||||
|
|
||||||
s.executables = %w(github_changelog_generator)
|
spec.required_ruby_version = '>= 1.9.3'
|
||||||
end
|
spec.authors = ["Petr Korolev"]
|
||||||
|
spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
|
||||||
|
spec.date = `date +"%Y-%m-%d"`.strip!
|
||||||
|
spec.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
|
||||||
|
spec.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
|
||||||
|
spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
|
||||||
|
spec.license = "MIT"
|
||||||
|
|
||||||
|
spec.files = `git ls-files -z`.split("\x0")
|
||||||
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||||
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||||
|
spec.require_paths = ["lib"]
|
||||||
|
|
||||||
|
spec.add_development_dependency "bundler", "~> 1.7"
|
||||||
|
spec.add_development_dependency "rake", "~> 10.0"
|
||||||
|
|
||||||
|
spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
|
||||||
|
spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
|
||||||
|
|
||||||
|
end
|
||||||
|
|||||||
@@ -2,204 +2,458 @@
|
|||||||
|
|
||||||
require 'github_api'
|
require 'github_api'
|
||||||
require 'json'
|
require 'json'
|
||||||
require 'httparty'
|
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'
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
class ChangelogGenerator
|
||||||
|
|
||||||
class ChangelogGenerator
|
attr_accessor :options, :all_tags, :github
|
||||||
|
|
||||||
attr_accessor :options, :all_tags
|
PER_PAGE_NUMBER = 30
|
||||||
|
|
||||||
def initialize()
|
def initialize
|
||||||
|
|
||||||
@options = Parser.parse_options
|
@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 = {}
|
if options[:verbose]
|
||||||
end
|
puts 'Input options:'
|
||||||
|
pp options
|
||||||
|
puts ''
|
||||||
|
end
|
||||||
|
|
||||||
def print_json(json)
|
github_token
|
||||||
puts JSON.pretty_generate(json)
|
|
||||||
end
|
|
||||||
|
|
||||||
def exec_command(cmd)
|
github_options = {per_page: PER_PAGE_NUMBER}
|
||||||
exec_cmd = "cd #{$project_path} && #{cmd}"
|
github_options[:oauth_token] = @github_token unless @github_token.nil?
|
||||||
%x[#{exec_cmd}]
|
github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
|
||||||
end
|
github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
|
||||||
|
|
||||||
|
@github = Github.new github_options
|
||||||
|
|
||||||
def get_all_closed_pull_requests
|
@generator = Generator.new(@options)
|
||||||
|
|
||||||
|
@all_tags = self.get_all_tags
|
||||||
|
@pull_requests = self.get_all_closed_pull_requests
|
||||||
|
if @options[:issues]
|
||||||
|
@issues = self.get_all_issues
|
||||||
|
else
|
||||||
|
@issues = []
|
||||||
|
end
|
||||||
|
|
||||||
issues = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
@tag_times_hash = {}
|
||||||
json = issues.body
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Receive all pull requests'
|
|
||||||
end
|
end
|
||||||
|
|
||||||
json
|
def print_json(json)
|
||||||
|
puts JSON.pretty_generate(json)
|
||||||
end
|
|
||||||
|
|
||||||
def compund_changelog
|
|
||||||
if @options[:verbose]
|
|
||||||
puts 'Generating changelog:'
|
|
||||||
end
|
end
|
||||||
|
|
||||||
log = "# Changelog\n\n"
|
def exec_command(cmd)
|
||||||
|
exec_cmd = "cd #{$project_path} and #{cmd}"
|
||||||
|
%x[#{exec_cmd}]
|
||||||
|
end
|
||||||
|
|
||||||
if @options[:last]
|
|
||||||
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
|
||||||
elsif @options[:tag1] && @options[:tag2]
|
|
||||||
|
|
||||||
tag1 = @options[:tag1]
|
def get_all_closed_pull_requests
|
||||||
tag2 = @options[:tag2]
|
|
||||||
tags_strings = []
|
|
||||||
self.all_tags.each { |x| tags_strings.push(x['name'])}
|
|
||||||
|
|
||||||
if tags_strings.include?(tag1)
|
if @options[:verbose]
|
||||||
if tags_strings.include?(tag2)
|
print "Fetching pull requests...\r"
|
||||||
hash = Hash[tags_strings.map.with_index.to_a]
|
end
|
||||||
index1 = hash[tag1]
|
|
||||||
index2 = hash[tag2]
|
response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
|
||||||
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
|
|
||||||
|
pull_requests = []
|
||||||
|
page_i = 0
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching pull requests... #{page_i}\r"
|
||||||
|
pull_requests.concat(page)
|
||||||
|
end
|
||||||
|
|
||||||
|
print "\r"
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Received closed pull requests: #{pull_requests.count}"
|
||||||
|
end
|
||||||
|
|
||||||
|
unless @options[:pull_request_labels].nil?
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts 'Filter all pull requests by labels.'
|
||||||
|
end
|
||||||
|
|
||||||
|
filtered_pull_requests = pull_requests.select { |pull_request|
|
||||||
|
#We need issue to fetch labels
|
||||||
|
issue = @github.issues.get @options[:user], @options[:project], pull_request.number
|
||||||
|
#compare is there any labels from @options[:labels] array
|
||||||
|
select_no_label = !issue.labels.map { |label| label.name }.any?
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Filter request \##{issue.number}."
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:pull_request_labels].any?
|
||||||
|
select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
|
||||||
|
else
|
||||||
|
select_by_label = false
|
||||||
|
end
|
||||||
|
|
||||||
|
select_by_label | select_no_label
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
|
||||||
|
end
|
||||||
|
return filtered_pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
def compund_changelog
|
||||||
|
if @options[:verbose]
|
||||||
|
puts 'Generating changelog:'
|
||||||
|
end
|
||||||
|
|
||||||
|
log = "# Changelog\n\n"
|
||||||
|
|
||||||
|
if @options[:last]
|
||||||
|
log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
|
||||||
|
elsif @options[:tag1] and @options[:tag2]
|
||||||
|
tag1 = @options[:tag1]
|
||||||
|
tag2 = @options[:tag2]
|
||||||
|
tags_strings = []
|
||||||
|
self.all_tags.each { |x| tags_strings.push(x['name']) }
|
||||||
|
|
||||||
|
if tags_strings.include?(tag1)
|
||||||
|
if tags_strings.include?(tag2)
|
||||||
|
hash = Hash[tags_strings.map.with_index.to_a]
|
||||||
|
index1 = hash[tag1]
|
||||||
|
index2 = hash[tag2]
|
||||||
|
log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
|
||||||
|
else
|
||||||
|
puts "Can't find tag #{tag2} -> exit"
|
||||||
|
exit
|
||||||
|
end
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag2} -> exit"
|
puts "Can't find tag #{tag1} -> exit"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
puts "Can't find tag #{tag1} -> exit"
|
log += self.generate_log_for_all_tags
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
else
|
|
||||||
log += self.generate_log_for_all_tags
|
log += "\n\n\\* *This changelog 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 #{`pwd`.strip!}/#{output_filename}"
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def generate_log_for_all_tags
|
||||||
|
log = ''
|
||||||
|
|
||||||
if @options[:verbose]
|
# Async fetching tags:
|
||||||
puts log
|
threads = []
|
||||||
end
|
@all_tags.each { |tag|
|
||||||
|
threads << Thread.new { self.get_time_of_tag(tag) }
|
||||||
|
}
|
||||||
|
threads.each { |thr| thr.join }
|
||||||
|
|
||||||
output_filename = "#{@options[:project]}_changelog.md"
|
|
||||||
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
|
|
||||||
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| self.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]
|
(1 ... self.all_tags.size).each { |index|
|
||||||
puts "Receive tags for repo #{url}"
|
log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
|
||||||
|
}
|
||||||
|
|
||||||
|
log += generate_log_between_tags(nil, self.all_tags.last)
|
||||||
|
|
||||||
|
log
|
||||||
end
|
end
|
||||||
|
|
||||||
response = HTTParty.get(url,
|
def is_megred(number)
|
||||||
:headers => {'Authorization' => 'token 8587bb22f6bf125454768a4a19dbcc774ea68d48',
|
@github.pull_requests.merged? @options[:user], @options[:project], number
|
||||||
'User-Agent' => 'Changelog-Generator'})
|
|
||||||
|
|
||||||
json_parse = JSON.parse(response.body)
|
|
||||||
|
|
||||||
if @options[:verbose]
|
|
||||||
puts "Found #{json_parse.count} tags"
|
|
||||||
end
|
end
|
||||||
|
|
||||||
json_parse
|
def get_all_tags
|
||||||
end
|
|
||||||
|
|
||||||
def generate_log_between_tags(since_tag, till_tag)
|
if @options[:verbose]
|
||||||
since_tag_time = self.get_time_of_tag(since_tag)
|
print "Fetching tags...\r"
|
||||||
till_tag_time = self.get_time_of_tag(till_tag)
|
end
|
||||||
|
|
||||||
# if we mix up tags order - lits fix it!
|
response = @github.repos.tags @options[:user], @options[:project]
|
||||||
if since_tag_time > till_tag_time
|
|
||||||
since_tag, till_tag = till_tag, since_tag
|
tags = []
|
||||||
since_tag_time, till_tag_time = till_tag_time, since_tag_time
|
page_i = 0
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching tags... #{page_i}\r"
|
||||||
|
tags.concat(page)
|
||||||
|
end
|
||||||
|
print "\r"
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Found #{tags.count} tags"
|
||||||
|
end
|
||||||
|
|
||||||
|
tags
|
||||||
end
|
end
|
||||||
|
|
||||||
till_tag_name = till_tag['name']
|
def github_token
|
||||||
|
if @options[:token]
|
||||||
|
return @github_token ||= @options[:token]
|
||||||
|
end
|
||||||
|
|
||||||
pull_requests = Array.new(@pull_requests)
|
env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil
|
||||||
|
|
||||||
pull_requests.delete_if { |req|
|
unless env_var
|
||||||
t = Time.parse(req[:closed_at]).utc
|
puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
|
||||||
true_classor_false_class = t > since_tag_time
|
puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
|
||||||
classor_false_class = t < till_tag_time
|
end
|
||||||
|
|
||||||
in_range = (true_classor_false_class) && (classor_false_class)
|
@github_token ||= env_var
|
||||||
!in_range
|
|
||||||
}
|
|
||||||
|
|
||||||
self.create_log(pull_requests, till_tag_name, till_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]
|
|
||||||
puts "Get time for tag #{prev_tag['name']}"
|
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_name = newer_tag['name']
|
||||||
|
|
||||||
|
if older_tag.nil?
|
||||||
|
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
|
||||||
|
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time)
|
||||||
|
else
|
||||||
|
older_tag_time = self.get_time_of_tag(older_tag)
|
||||||
|
filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
|
||||||
|
filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
|
||||||
|
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
|
||||||
|
|
||||||
|
tag_in_range_new = t <= newer_tag_time
|
||||||
|
|
||||||
|
tag_in_range = (tag_in_range_old) && (tag_in_range_new)
|
||||||
|
|
||||||
|
tag_in_range
|
||||||
|
else
|
||||||
|
false
|
||||||
|
end
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
# @param [Array] pull_requests
|
||||||
|
# @param [Array] issues
|
||||||
|
# @param [String] tag_name
|
||||||
|
# @param [String] tag_time
|
||||||
|
# @return [String]
|
||||||
|
def create_log(pull_requests, issues, tag_name, tag_time)
|
||||||
|
|
||||||
|
github_site = options[:github_site] || 'https://github.com'
|
||||||
|
|
||||||
|
# Generate tag name and link
|
||||||
|
log = "## [#{tag_name}](#{github_site}/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
|
||||||
|
|
||||||
|
#Generate date string:
|
||||||
|
time_string = tag_time.strftime @options[:format]
|
||||||
|
log += "#### #{time_string}\n"
|
||||||
|
|
||||||
|
if @options[:pulls]
|
||||||
|
# Generate pull requests:
|
||||||
|
pull_requests.each { |pull_request|
|
||||||
|
merge = @generator.get_string_for_pull_request(pull_request)
|
||||||
|
log += "- #{merge}"
|
||||||
|
|
||||||
|
} if pull_requests
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:issues]
|
||||||
|
# Generate issues:
|
||||||
|
if issues
|
||||||
|
issues.sort! { |x, y|
|
||||||
|
if x.labels.any? && y.labels.any?
|
||||||
|
x.labels[0].name <=> y.labels[0].name
|
||||||
|
else
|
||||||
|
if x.labels.any?
|
||||||
|
1
|
||||||
|
else
|
||||||
|
if y.labels.any?
|
||||||
|
-1
|
||||||
|
else
|
||||||
|
0
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
}.reverse!
|
||||||
|
end
|
||||||
|
issues.each { |dict|
|
||||||
|
is_bug = false
|
||||||
|
is_enhancement = false
|
||||||
|
dict.labels.each { |label|
|
||||||
|
if label.name == 'bug'
|
||||||
|
is_bug = true
|
||||||
|
end
|
||||||
|
if label.name == 'enhancement'
|
||||||
|
is_enhancement = true
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
intro = 'Closed issue'
|
||||||
|
if is_bug
|
||||||
|
intro = 'Fixed bug'
|
||||||
|
end
|
||||||
|
|
||||||
|
if is_enhancement
|
||||||
|
intro = 'Implemented enhancement'
|
||||||
|
end
|
||||||
|
|
||||||
|
enc_string = @generator.encapsulate_string dict[:title]
|
||||||
|
|
||||||
|
merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
|
||||||
|
log += "- #{merge}"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
log
|
||||||
|
end
|
||||||
|
|
||||||
|
def get_time_of_tag(prev_tag)
|
||||||
|
|
||||||
|
if @tag_times_hash[prev_tag['name']]
|
||||||
|
return @tag_times_hash[prev_tag['name']]
|
||||||
|
end
|
||||||
|
|
||||||
|
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
||||||
|
time_string = github_git_data_commits_get['committer']['date']
|
||||||
|
Time.parse(time_string)
|
||||||
|
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
||||||
|
end
|
||||||
|
|
||||||
|
def get_all_issues
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
print "Fetching closed issues...\r"
|
||||||
|
end
|
||||||
|
|
||||||
|
response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
|
||||||
|
|
||||||
|
issues = []
|
||||||
|
page_i = 0
|
||||||
|
response.each_page do |page|
|
||||||
|
page_i += PER_PAGE_NUMBER
|
||||||
|
print "Fetching closed issues... #{page_i}\r"
|
||||||
|
issues.concat(page)
|
||||||
|
end
|
||||||
|
|
||||||
|
print "\r"
|
||||||
|
|
||||||
|
# remove pull request from issues:
|
||||||
|
issues.select! { |x|
|
||||||
|
x.pull_request == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Received closed issues: #{issues.count}"
|
||||||
|
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|
|
||||||
|
#compare is there any labels from @options[:labels] array
|
||||||
|
(issue.labels.map { |label| label.name } & @options[:labels]).any?
|
||||||
|
}
|
||||||
|
|
||||||
|
if @options[:add_issues_wo_labels]
|
||||||
|
issues_wo_labels = issues.select {
|
||||||
|
# add issues without any labels
|
||||||
|
|issue| !issue.labels.map { |label| label.name }.any?
|
||||||
|
}
|
||||||
|
filtered_issues.concat(issues_wo_labels)
|
||||||
|
end
|
||||||
|
|
||||||
|
if @options[:verbose]
|
||||||
|
puts "Filtered issues: #{filtered_issues.count}"
|
||||||
|
end
|
||||||
|
|
||||||
|
filtered_issues
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
|
|
||||||
time_string = github_git_data_commits_get['committer']['date']
|
|
||||||
Time.parse(time_string)
|
|
||||||
@tag_times_hash[prev_tag['name']] = Time.parse(time_string)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
if __FILE__ == $0
|
||||||
|
GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
|
||||||
|
end
|
||||||
|
|
||||||
if __FILE__ == $0
|
|
||||||
ChangelogGenerator.new.compund_changelog
|
|
||||||
end
|
end
|
||||||
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,55 +1,107 @@
|
|||||||
#!/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'}
|
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 => nil, :filter_issues_by_milestone => true}
|
||||||
|
|
||||||
parser = OptionParser.new { |opts|
|
parser = OptionParser.new { |opts|
|
||||||
opts.banner = 'Usage: changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]'
|
opts.banner = 'Usage: changelog_generator [options]'
|
||||||
opts.on('-u', '--user [USER]', 'your username on GitHub') do |last|
|
opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
|
||||||
options[:user] = 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 required. You can generate it here: https://github.com/settings/tokens/new') do |last|
|
||||||
|
options[:token] = last
|
||||||
|
end
|
||||||
|
opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
|
||||||
|
options[:format] = last
|
||||||
|
end
|
||||||
|
opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
|
||||||
|
options[:output] = last
|
||||||
|
end
|
||||||
|
opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
|
||||||
|
options[:verbose] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
|
||||||
|
options[:issues] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
|
||||||
|
options[:add_issues_wo_labels] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
|
||||||
|
options[:pulls] = v
|
||||||
|
end
|
||||||
|
opts.on('--[no-]filter-issues-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[:last] = author
|
||||||
|
end
|
||||||
|
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
|
||||||
|
end
|
||||||
|
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
|
||||||
|
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|
|
||||||
|
puts "Version: #{GitHubChangelogGenerator::VERSION}"
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
opts.on('-h', '--help', 'Displays Help') do
|
||||||
|
puts opts
|
||||||
|
exit
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
parser.parse!
|
||||||
|
|
||||||
|
if ARGV[0] && !ARGV[1]
|
||||||
|
github_site = options[:github_site] ? options[:github_site] : 'github.com'
|
||||||
|
# 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
|
||||||
opts.on('-p', '--project [PROJECT]', 'name of project on GitHub') do |last|
|
|
||||||
options[:project] = last
|
if !options[:user] && !options[:project]
|
||||||
|
remote = `git remote -vv`.split("\n")
|
||||||
|
match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])
|
||||||
|
|
||||||
|
if match && match[1] && match[2]
|
||||||
|
puts "Detected user:#{match[1]}, project:#{match[2]}"
|
||||||
|
options[:user], options[:project] = match[1], match[2]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications') do |last|
|
|
||||||
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
|
if ARGV[1]
|
||||||
|
options[:tag1] = ARGV[0]
|
||||||
|
options[:tag2] = ARGV[1]
|
||||||
end
|
end
|
||||||
opts.on('-l', '--last-changes', 'generate log between last 2 tags') do |last|
|
|
||||||
options[:last] = last
|
|
||||||
end
|
|
||||||
opts.on('-f', '--date-format [FORMAT]', 'date format. default is %d/%m/%y') do |last|
|
|
||||||
options[:format] = last
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
parser.parse!
|
options
|
||||||
|
|
||||||
#udefined case with 1 parameter:
|
|
||||||
if ARGV[0] && !ARGV[1]
|
|
||||||
puts parser.banner
|
|
||||||
exit
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if !options[:user] || !options[:project]
|
|
||||||
puts parser.banner
|
|
||||||
exit
|
|
||||||
end
|
|
||||||
|
|
||||||
if ARGV[1]
|
|
||||||
options[:tag1] = ARGV[0]
|
|
||||||
options[:tag2] = ARGV[1]
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
options
|
|
||||||
end
|
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.2.6'
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user