github_changelog_generator 1.10.1 → 1.10.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +40 -0
- data/.rubocop_todo.yml +15 -6
- data/.travis.yml +1 -1
- data/CHANGELOG.md +33 -0
- data/Gemfile.lock +28 -36
- data/README.md +72 -67
- data/Rakefile +17 -1
- data/bin/git-generate-changelog +4 -0
- data/github_changelog_generator.gemspec +4 -4
- data/lib/github_changelog_generator.rb +1 -1
- data/lib/github_changelog_generator/fetcher.rb +5 -5
- data/lib/github_changelog_generator/generator/generator_generation.rb +25 -23
- data/lib/github_changelog_generator/generator/generator_processor.rb +13 -13
- data/lib/github_changelog_generator/generator/generator_tags.rb +12 -12
- data/lib/github_changelog_generator/helper.rb +6 -6
- data/lib/github_changelog_generator/parser.rb +3 -0
- data/lib/github_changelog_generator/parser_file.rb +2 -2
- data/lib/github_changelog_generator/task.rb +2 -2
- data/lib/github_changelog_generator/version.rb +1 -1
- data/man/git-generate-changelog.1 +252 -0
- data/man/git-generate-changelog.html +262 -0
- data/man/git-generate-changelog.md +179 -0
- data/spec/files/github_changelog_params_327 +1 -0
- data/spec/spec_helper.rb +5 -5
- data/spec/unit/parse_file_spec.rb +14 -0
- metadata +39 -17
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c9e22202d47a9d95b6d291a8c94f4a85a93b3f43
|
|
4
|
+
data.tar.gz: 0f8d84d785e4710797881850611085f9bacb3bc7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 82d2a3c32f8cf0ee81e9094f750b42874795074448fce6f17818a88cfb8a23b75a93a80269735034cb8287016ab4f9f00ad6774e1f38ff749d16dc367cdb0098
|
|
7
|
+
data.tar.gz: 7036d59f43b0f35b741a0341f9b0b606a52eead0b94cf5fa7b5b7389546e01235223817c99acd2c314675a2ccd6aa5e0f8fcc554f9b8f30b740f9121ba15de13
|
data/.rubocop.yml
CHANGED
|
@@ -14,3 +14,43 @@ Metrics/ClassLength:
|
|
|
14
14
|
# Configuration parameters: CountComments.
|
|
15
15
|
Metrics/MethodLength:
|
|
16
16
|
Enabled: false
|
|
17
|
+
|
|
18
|
+
Style/FileName:
|
|
19
|
+
Exclude:
|
|
20
|
+
- 'bin/git-generate-changelog'
|
|
21
|
+
|
|
22
|
+
#TODOS
|
|
23
|
+
# Offense count: 14
|
|
24
|
+
Metrics/AbcSize:
|
|
25
|
+
Enabled: false
|
|
26
|
+
|
|
27
|
+
# Offense count: 1
|
|
28
|
+
Style/AccessorMethodName:
|
|
29
|
+
Enabled: false
|
|
30
|
+
|
|
31
|
+
# Offense count: 10
|
|
32
|
+
Style/Documentation:
|
|
33
|
+
Enabled: false
|
|
34
|
+
|
|
35
|
+
# Offense count: 1
|
|
36
|
+
# Configuration parameters: MinBodyLength.
|
|
37
|
+
Style/GuardClause:
|
|
38
|
+
Enabled: false
|
|
39
|
+
|
|
40
|
+
# Offense count: 2
|
|
41
|
+
# Cop supports --auto-correct.
|
|
42
|
+
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
|
43
|
+
# SupportedStyles: skip_modifier_ifs, always
|
|
44
|
+
Style/Next:
|
|
45
|
+
Enabled: false
|
|
46
|
+
|
|
47
|
+
# Offense count: 3
|
|
48
|
+
# Cop supports --auto-correct.
|
|
49
|
+
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
|
50
|
+
# SupportedStyles: slashes, percent_r, mixed
|
|
51
|
+
Style/RegexpLiteral:
|
|
52
|
+
Enabled: false
|
|
53
|
+
|
|
54
|
+
Style/MutableConstant:
|
|
55
|
+
Enabled: false
|
|
56
|
+
|
data/.rubocop_todo.yml
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
|
-
# This configuration was generated by
|
|
2
|
-
#
|
|
1
|
+
# This configuration was generated by
|
|
2
|
+
# `rubocop --auto-gen-config`
|
|
3
|
+
# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
|
|
3
4
|
# The point is for the user to remove these configuration records
|
|
4
5
|
# one by one as the offenses are removed from the code base.
|
|
5
6
|
# Note that changes in the inspected code, or installation of new
|
|
6
7
|
# versions of RuboCop, may require this file to be generated again.
|
|
7
8
|
|
|
8
|
-
# Offense count:
|
|
9
|
+
# Offense count: 1
|
|
10
|
+
Lint/ImplicitStringConcatenation:
|
|
11
|
+
Exclude:
|
|
12
|
+
- 'lib/github_changelog_generator/parser.rb'
|
|
13
|
+
|
|
14
|
+
# Offense count: 14
|
|
9
15
|
Metrics/AbcSize:
|
|
10
16
|
Enabled: false
|
|
11
17
|
|
|
@@ -13,11 +19,11 @@ Metrics/AbcSize:
|
|
|
13
19
|
Metrics/CyclomaticComplexity:
|
|
14
20
|
Max: 7
|
|
15
21
|
|
|
16
|
-
# Offense count:
|
|
22
|
+
# Offense count: 2
|
|
17
23
|
Metrics/PerceivedComplexity:
|
|
18
24
|
Max: 8
|
|
19
25
|
|
|
20
|
-
# Offense count:
|
|
26
|
+
# Offense count: 1
|
|
21
27
|
Style/AccessorMethodName:
|
|
22
28
|
Enabled: false
|
|
23
29
|
|
|
@@ -30,13 +36,16 @@ Style/Documentation:
|
|
|
30
36
|
Style/GuardClause:
|
|
31
37
|
Enabled: false
|
|
32
38
|
|
|
33
|
-
# Offense count:
|
|
39
|
+
# Offense count: 2
|
|
40
|
+
# Cop supports --auto-correct.
|
|
34
41
|
# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
|
|
42
|
+
# SupportedStyles: skip_modifier_ifs, always
|
|
35
43
|
Style/Next:
|
|
36
44
|
Enabled: false
|
|
37
45
|
|
|
38
46
|
# Offense count: 3
|
|
39
47
|
# Cop supports --auto-correct.
|
|
40
48
|
# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
|
|
49
|
+
# SupportedStyles: slashes, percent_r, mixed
|
|
41
50
|
Style/RegexpLiteral:
|
|
42
51
|
Enabled: false
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,38 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
+
## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
|
|
4
|
+
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
|
|
5
|
+
|
|
6
|
+
**Fixed bugs:**
|
|
7
|
+
|
|
8
|
+
- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
|
|
9
|
+
|
|
10
|
+
## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
|
|
11
|
+
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
|
|
12
|
+
|
|
13
|
+
## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
|
|
14
|
+
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
|
|
15
|
+
|
|
16
|
+
**Implemented enhancements:**
|
|
17
|
+
|
|
18
|
+
- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
|
|
19
|
+
- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
|
|
20
|
+
|
|
21
|
+
**Fixed bugs:**
|
|
22
|
+
|
|
23
|
+
- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
|
|
24
|
+
|
|
25
|
+
**Merged pull requests:**
|
|
26
|
+
|
|
27
|
+
- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
|
|
28
|
+
|
|
29
|
+
## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
|
|
30
|
+
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
|
|
31
|
+
|
|
32
|
+
**Fixed bugs:**
|
|
33
|
+
|
|
34
|
+
- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
|
|
35
|
+
|
|
3
36
|
## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
|
|
4
37
|
[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
|
|
5
38
|
|
data/Gemfile.lock
CHANGED
|
@@ -1,23 +1,25 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
github_changelog_generator (1.10.
|
|
4
|
+
github_changelog_generator (1.10.3)
|
|
5
|
+
bundler (~> 1.7)
|
|
5
6
|
colorize (~> 0.7)
|
|
6
7
|
github_api (~> 0.12)
|
|
8
|
+
overcommit (~> 0.31)
|
|
9
|
+
rake (~> 10.0)
|
|
7
10
|
|
|
8
11
|
GEM
|
|
9
12
|
remote: https://rubygems.org/
|
|
10
13
|
specs:
|
|
11
14
|
addressable (2.4.0)
|
|
12
15
|
ast (2.2.0)
|
|
13
|
-
|
|
14
|
-
|
|
16
|
+
childprocess (0.5.9)
|
|
17
|
+
ffi (~> 1.0, >= 1.0.11)
|
|
15
18
|
codeclimate-test-reporter (0.4.8)
|
|
16
19
|
simplecov (>= 0.7.1, < 1.0.0)
|
|
17
20
|
colorize (0.7.7)
|
|
18
|
-
coveralls (0.8.
|
|
21
|
+
coveralls (0.8.11)
|
|
19
22
|
json (~> 1.8)
|
|
20
|
-
rest-client (>= 1.6.8, < 2)
|
|
21
23
|
simplecov (~> 0.11.0)
|
|
22
24
|
term-ansicolor (~> 1.3)
|
|
23
25
|
thor (~> 0.19.1)
|
|
@@ -26,10 +28,9 @@ GEM
|
|
|
26
28
|
thread_safe (~> 0.3, >= 0.3.1)
|
|
27
29
|
diff-lcs (1.2.5)
|
|
28
30
|
docile (1.1.5)
|
|
29
|
-
domain_name (0.5.25)
|
|
30
|
-
unf (>= 0.0.5, < 1.0.0)
|
|
31
31
|
faraday (0.9.2)
|
|
32
32
|
multipart-post (>= 1.2, < 3)
|
|
33
|
+
ffi (1.9.10)
|
|
33
34
|
github_api (0.13.1)
|
|
34
35
|
addressable (~> 2.4.0)
|
|
35
36
|
descendants_tracker (~> 0.0.4)
|
|
@@ -38,53 +39,48 @@ GEM
|
|
|
38
39
|
multi_json (>= 1.7.5, < 2.0)
|
|
39
40
|
oauth2
|
|
40
41
|
hashie (3.4.3)
|
|
41
|
-
|
|
42
|
-
domain_name (~> 0.5)
|
|
42
|
+
iniparse (1.4.2)
|
|
43
43
|
json (1.8.3)
|
|
44
|
-
jwt (1.5.
|
|
45
|
-
mime-types (2.99)
|
|
44
|
+
jwt (1.5.1)
|
|
46
45
|
multi_json (1.11.2)
|
|
47
46
|
multi_xml (0.5.5)
|
|
48
47
|
multipart-post (2.0.0)
|
|
49
|
-
|
|
50
|
-
oauth2 (1.0.0)
|
|
48
|
+
oauth2 (1.1.0)
|
|
51
49
|
faraday (>= 0.8, < 0.10)
|
|
52
|
-
jwt (~> 1.0)
|
|
50
|
+
jwt (~> 1.0, < 1.5.2)
|
|
53
51
|
multi_json (~> 1.3)
|
|
54
52
|
multi_xml (~> 0.5)
|
|
55
|
-
rack (
|
|
56
|
-
|
|
57
|
-
|
|
53
|
+
rack (>= 1.2, < 3)
|
|
54
|
+
overcommit (0.32.0)
|
|
55
|
+
childprocess (~> 0.5.8)
|
|
56
|
+
iniparse (~> 1.4)
|
|
57
|
+
parser (2.3.0.6)
|
|
58
|
+
ast (~> 2.2)
|
|
58
59
|
powerpack (0.1.1)
|
|
59
60
|
rack (1.6.4)
|
|
60
|
-
rainbow (2.
|
|
61
|
-
rake (10.
|
|
62
|
-
rest-client (1.8.0)
|
|
63
|
-
http-cookie (>= 1.0.2, < 2.0)
|
|
64
|
-
mime-types (>= 1.16, < 3.0)
|
|
65
|
-
netrc (~> 0.7)
|
|
61
|
+
rainbow (2.1.0)
|
|
62
|
+
rake (10.5.0)
|
|
66
63
|
rspec (3.4.0)
|
|
67
64
|
rspec-core (~> 3.4.0)
|
|
68
65
|
rspec-expectations (~> 3.4.0)
|
|
69
66
|
rspec-mocks (~> 3.4.0)
|
|
70
|
-
rspec-core (3.4.
|
|
67
|
+
rspec-core (3.4.3)
|
|
71
68
|
rspec-support (~> 3.4.0)
|
|
72
69
|
rspec-expectations (3.4.0)
|
|
73
70
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
74
71
|
rspec-support (~> 3.4.0)
|
|
75
|
-
rspec-mocks (3.4.
|
|
72
|
+
rspec-mocks (3.4.1)
|
|
76
73
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
77
74
|
rspec-support (~> 3.4.0)
|
|
78
75
|
rspec-support (3.4.1)
|
|
79
|
-
rubocop (0.
|
|
80
|
-
|
|
81
|
-
parser (>= 2.2.3.0, < 3.0)
|
|
76
|
+
rubocop (0.37.2)
|
|
77
|
+
parser (>= 2.3.0.4, < 3.0)
|
|
82
78
|
powerpack (~> 0.1)
|
|
83
79
|
rainbow (>= 1.99.1, < 3.0)
|
|
84
80
|
ruby-progressbar (~> 1.7)
|
|
85
|
-
|
|
81
|
+
unicode-display_width (~> 0.3)
|
|
86
82
|
ruby-progressbar (1.7.5)
|
|
87
|
-
simplecov (0.11.
|
|
83
|
+
simplecov (0.11.2)
|
|
88
84
|
docile (~> 1.1.0)
|
|
89
85
|
json (~> 1.8)
|
|
90
86
|
simplecov-html (~> 0.10.0)
|
|
@@ -94,22 +90,18 @@ GEM
|
|
|
94
90
|
thor (0.19.1)
|
|
95
91
|
thread_safe (0.3.5)
|
|
96
92
|
tins (1.6.0)
|
|
97
|
-
|
|
98
|
-
unf_ext
|
|
99
|
-
unf_ext (0.0.7.1)
|
|
93
|
+
unicode-display_width (0.3.1)
|
|
100
94
|
|
|
101
95
|
PLATFORMS
|
|
102
96
|
ruby
|
|
103
97
|
|
|
104
98
|
DEPENDENCIES
|
|
105
|
-
bundler (~> 1.7)
|
|
106
99
|
codeclimate-test-reporter (~> 0.4)
|
|
107
100
|
coveralls (~> 0.8)
|
|
108
101
|
github_changelog_generator!
|
|
109
|
-
rake (~> 10.0)
|
|
110
102
|
rspec (~> 3.2)
|
|
111
103
|
rubocop (~> 0.31)
|
|
112
104
|
simplecov (~> 0.10)
|
|
113
105
|
|
|
114
106
|
BUNDLED WITH
|
|
115
|
-
1.
|
|
107
|
+
1.11.2
|
data/README.md
CHANGED
|
@@ -21,7 +21,7 @@ GitHub Changelog Generator 
|
|
|
21
21
|
- [License](#license)
|
|
22
22
|
|
|
23
23
|
|
|
24
|
-
### Changelog generation has never been so easy
|
|
24
|
+
### Changelog generation has never been so easy
|
|
25
25
|
|
|
26
26
|
**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
|
|
27
27
|
|
|
@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
|
|
|
32
32
|
### *Why should I care?*
|
|
33
33
|
Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
|
|
34
34
|
|
|
35
|
-
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com
|
|
35
|
+
> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
|
|
36
36
|
|
|
37
37
|
## Installation
|
|
38
38
|
|
|
@@ -45,7 +45,7 @@ Because software tools are for people. If you don’t care, why are you contribu
|
|
|
45
45
|
|
|
46
46
|
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
|
|
47
47
|
|
|
48
|
-
- In general it looks like this:
|
|
48
|
+
- In general, it looks like this:
|
|
49
49
|
|
|
50
50
|
> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
|
51
51
|
>
|
|
@@ -67,25 +67,25 @@ Because software tools are for people. If you don’t care, why are you contribu
|
|
|
67
67
|
|
|
68
68
|
|
|
69
69
|
## Usage
|
|
70
|
-
**It's really simple
|
|
70
|
+
**It's really simple!**
|
|
71
71
|
|
|
72
|
-
- If your
|
|
72
|
+
- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
|
|
73
73
|
|
|
74
74
|
github_changelog_generator
|
|
75
75
|
|
|
76
|
-
-
|
|
76
|
+
- Or, run this from anywhere:
|
|
77
77
|
- `github_changelog_generator -u github_username -p github_project`
|
|
78
78
|
- `github_changelog_generator github_username/github_project`
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
|
|
81
81
|
|
|
82
82
|
### Params
|
|
83
83
|
Type `github_changelog_generator --help` for details.
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
|
|
86
86
|
|
|
87
87
|
### Params File
|
|
88
|
-
|
|
88
|
+
In your project root, you can put a params file named `.github_changelog_generator` to override default params:
|
|
89
89
|
|
|
90
90
|
Example:
|
|
91
91
|
```
|
|
@@ -96,36 +96,41 @@ since-tag=1.0.0
|
|
|
96
96
|
|
|
97
97
|
### GitHub token
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
GitHub only allows only 50 unauthenticated requests per hour.
|
|
100
|
+
Therefore, it's recommended to run this script with authentication by using a **token**.
|
|
100
101
|
|
|
101
|
-
|
|
102
|
+
Here's how:
|
|
102
103
|
|
|
103
|
-
|
|
104
|
+
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
|
|
105
|
+
- Either:
|
|
106
|
+
- Run the script with `--token <your-40-digit-token>`; **OR**
|
|
107
|
+
- Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
|
|
104
108
|
|
|
105
|
-
|
|
106
|
-
- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
|
|
109
|
+
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
|
|
107
110
|
|
|
108
|
-
|
|
111
|
+
export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
|
|
109
112
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
So, if you got error like this:
|
|
113
|
+
So, if you got an error like this:
|
|
113
114
|
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
|
|
114
115
|
|
|
115
|
-
It's time to create this token
|
|
116
|
+
It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
|
|
116
117
|
|
|
117
118
|
## Migrating from a manual changelog
|
|
118
119
|
|
|
119
|
-
Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog
|
|
120
|
-
|
|
120
|
+
Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
|
|
121
|
+
But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
|
|
121
122
|
|
|
122
|
-
That's where `--base
|
|
123
|
+
That's where `--base <your-manual-changelog.md>` comes in handy!
|
|
124
|
+
This option lets append your old manual changelog to the end of the generated entries.
|
|
123
125
|
|
|
124
126
|
If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
|
|
125
127
|
|
|
126
128
|
### Rake task
|
|
127
129
|
|
|
128
|
-
You love
|
|
130
|
+
You love `rake`? We do, too! So, we've made it even easier for you:
|
|
131
|
+
we've provided a `rake` task library for your changelog generation.
|
|
132
|
+
|
|
133
|
+
Just put something like this in your `Rakefile`:
|
|
129
134
|
|
|
130
135
|
```ruby
|
|
131
136
|
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
|
@@ -134,94 +139,94 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
|
|
134
139
|
end
|
|
135
140
|
```
|
|
136
141
|
|
|
137
|
-
All command line options can be passed to the
|
|
142
|
+
All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
|
|
138
143
|
|
|
139
|
-
##Features and advantages of this project
|
|
140
|
-
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com
|
|
141
|
-
-
|
|
144
|
+
## Features and advantages of this project
|
|
145
|
+
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
|
|
146
|
+
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
|
|
142
147
|
- **GitHub Enterprise support** via command line options! :factory:
|
|
143
|
-
- Flexible format **
|
|
144
|
-
- **Customize** issues
|
|
145
|
-
- **Custom date
|
|
146
|
-
-
|
|
147
|
-
- Automatically **exclude specific issues
|
|
148
|
-
- **Distinguish** issues **
|
|
149
|
-
- Merged pull requests (all
|
|
150
|
-
- Bug fixes (
|
|
151
|
-
- Enhancements (
|
|
152
|
-
-
|
|
153
|
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
(*
|
|
148
|
+
- Flexible format **customization**:
|
|
149
|
+
- **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
|
|
150
|
+
- **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
|
|
151
|
+
- Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
|
|
152
|
+
- Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
|
|
153
|
+
- **Distinguish** issues **by labels**. :mag_right:
|
|
154
|
+
- Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
|
|
155
|
+
- Bug fixes (issues labeled `bug`) :beetle:
|
|
156
|
+
- Enhancements (issues labeled `enhancement`) :star2:
|
|
157
|
+
- Issues (closed issues with no labels) :non-potable_water:
|
|
158
|
+
|
|
159
|
+
- Manually include or exclude issues by labels :wrench:
|
|
160
|
+
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
|
|
161
|
+
(*See `github_changelog_generator --help` for details)*
|
|
157
162
|
|
|
158
163
|
|
|
159
164
|
###Alternatives
|
|
160
|
-
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives)
|
|
165
|
+
Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
|
|
161
166
|
|
|
162
|
-
*If you know other projects
|
|
167
|
+
*If you know other projects, feel free to edit this Wiki page!*
|
|
163
168
|
|
|
164
169
|
|
|
165
170
|
### Projects using this library
|
|
166
|
-
[
|
|
171
|
+
Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
|
|
167
172
|
|
|
168
173
|
If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
|
|
169
174
|
|
|
170
|
-
*If you are using `github_changelog_generator`
|
|
175
|
+
*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
|
|
171
176
|
|
|
172
177
|
## Am I missing some essential feature?
|
|
173
178
|
|
|
174
179
|
- **Nothing is impossible!**
|
|
175
180
|
|
|
176
|
-
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
|
|
181
|
+
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
|
|
177
182
|
|
|
178
|
-
- *Bug reports, feature requests, patches, well-wishes are always welcome
|
|
183
|
+
- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
|
|
179
184
|
|
|
180
185
|
## FAQ
|
|
181
186
|
|
|
182
187
|
- ***I already use GitHub Releases. Why do I need this?***
|
|
183
188
|
|
|
184
|
-
GitHub Releases is a very good thing. And it's very good practice to maintain it (
|
|
189
|
+
GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
|
|
185
190
|
|
|
186
|
-
*
|
|
191
|
+
*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
|
|
187
192
|
|
|
188
|
-
I'm not
|
|
193
|
+
I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
|
|
189
194
|
|
|
190
|
-
|
|
195
|
+
An auto-generated changelog really helps, even if you manually fill in the release notes!
|
|
191
196
|
|
|
192
197
|
For example:
|
|
193
198
|
|
|
194
|
-
When I found a closed bug
|
|
195
|
-
|
|
196
|
-
- it's not so quite easy to find it in manually filled Releases notes.
|
|
197
|
-
- this file can also help you to build your Release note and not miss features in manually-filled list.
|
|
199
|
+
When I found a closed bug, it's very useful know which release fixed it.
|
|
200
|
+
In this case, you can easily find the issue by \# in `CHANGELOG.md`.
|
|
198
201
|
|
|
199
|
-
|
|
202
|
+
- it's not quite as easy to find this in handwritten releases notes
|
|
203
|
+
- a generated file saves you the trouble of remembering everything;
|
|
204
|
+
sometimes people forget to add things to a handwritten file
|
|
200
205
|
|
|
201
|
-
I think
|
|
202
|
-
|
|
203
|
-
|
|
206
|
+
Ultimately, I think GitHub Releases is ideal for end-users.
|
|
207
|
+
Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
|
|
208
|
+
Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
|
|
204
209
|
|
|
205
|
-
- ***I received a warning: GitHub API rate limit exceed
|
|
210
|
+
- ***I received a warning: "GitHub API rate limit exceed" What does this mean?***
|
|
206
211
|
|
|
207
|
-
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit
|
|
212
|
+
GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
|
|
208
213
|
|
|
209
|
-
If you're seeing this warning:
|
|
214
|
+
If you're seeing this warning, please do the following:
|
|
210
215
|
|
|
211
|
-
1. Make sure you're providing an OAuth token so you're not
|
|
212
|
-
2.
|
|
216
|
+
1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
|
|
217
|
+
2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
|
|
213
218
|
|
|
214
219
|
## Contributing
|
|
215
220
|
|
|
216
|
-
1. Create an issue
|
|
221
|
+
1. Create an issue and describe your idea
|
|
217
222
|
2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
|
|
218
223
|
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
219
224
|
4. Commit your changes (`git commit -am 'Add some feature'`)
|
|
220
|
-
5.
|
|
225
|
+
5. Publish the branch (`git push origin my-new-feature`)
|
|
221
226
|
6. Create a new Pull Request
|
|
222
227
|
7. Profit! :white_check_mark:
|
|
223
228
|
|
|
224
|
-
*To test
|
|
229
|
+
*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
|
|
225
230
|
|
|
226
231
|
## License
|
|
227
232
|
|