github_changelog_generator 1.16.1 → 1.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (18) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/github_changelog_generator/argv_parser.rb +224 -0
  4. data/lib/github_changelog_generator/generator/generator_fetcher.rb +4 -5
  5. data/lib/github_changelog_generator/generator/generator_processor.rb +2 -1
  6. data/lib/github_changelog_generator/octo_fetcher.rb +21 -4
  7. data/lib/github_changelog_generator/options.rb +1 -0
  8. data/lib/github_changelog_generator/parser.rb +70 -258
  9. data/lib/github_changelog_generator/parser_file.rb +28 -13
  10. data/lib/github_changelog_generator/ssl_certs/cacert.pem +851 -1680
  11. data/lib/github_changelog_generator/version.rb +1 -1
  12. data/man/git-generate-changelog.1 +31 -31
  13. data/man/git-generate-changelog.1.html +30 -30
  14. data/man/git-generate-changelog.html +19 -19
  15. data/man/git-generate-changelog.md +31 -31
  16. data/spec/files/config_example +5 -0
  17. data/spec/unit/parser_spec.rb +50 -0
  18. metadata +5 -2
data/lib/github_changelog_generator/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module GitHubChangelogGenerator
4
- VERSION = "1.16.1"
4
+ VERSION = "1.16.2"
5
5
  end
data/man/git-generate-changelog.1 CHANGED
@@ -13,115 +13,115 @@
13
13
  Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
14
14
  .
15
15
  .SH "OPTIONS"
16
- \-u, \-\-user [USER]
16
+ \-u, \-\-user USER
17
17
  .
18
18
  .P
19
19
  Username of the owner of target GitHub repo\.
20
20
  .
21
21
  .P
22
- \-p, \-\-project [PROJECT]
22
+ \-p, \-\-project PROJECT
23
23
  .
24
24
  .P
25
25
  Name of project on GitHub\.
26
26
  .
27
27
  .P
28
- \-t, \-\-token [TOKEN]
28
+ \-t, \-\-token TOKEN
29
29
  .
30
30
  .P
31
31
  To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
32
32
  .
33
33
  .P
34
- \-f, \-\-date\-format [FORMAT]
34
+ \-f, \-\-date\-format FORMAT
35
35
  .
36
36
  .P
37
37
  Date format\. Default is %Y\-%m\-%d\.
38
38
  .
39
39
  .P
40
- \-o, \-\-output [NAME]
40
+ \-o, \-\-output NAME
41
41
  .
42
42
  .P
43
43
  Output file\. To print to STDOUT instead, use blank as path\. Default is CHANGELOG\.md\.
44
44
  .
45
45
  .P
46
- \-b, \-\-base [NAME]
46
+ \-b, \-\-base NAME
47
47
  .
48
48
  .P
49
- Optional base file to append generated changes to\.
49
+ Optional base file to append generated changes to\. Default is HISTORY\.md\.
50
50
  .
51
51
  .P
52
- \-\-summary\-label [LABEL]
52
+ \-\-summary\-label LABEL
53
53
  .
54
54
  .P
55
55
  Set up custom label for the release summary section\. Default is ""\.
56
56
  .
57
57
  .P
58
- \-\-breaking\-label [LABEL]
58
+ \-\-breaking\-label LABEL
59
59
  .
60
60
  .P
61
61
  Set up custom label for breaking changes section\. Default is "\fBBreaking changes:\fR"\.
62
62
  .
63
63
  .P
64
- \-\-enhancement\-label [LABEL]
64
+ \-\-enhancement\-label LABEL
65
65
  .
66
66
  .P
67
67
  Set up custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"\.
68
68
  .
69
69
  .P
70
- \-\-bugs\-label [LABEL]
70
+ \-\-bugs\-label LABEL
71
71
  .
72
72
  .P
73
73
  Set up custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR"\.
74
74
  .
75
75
  .P
76
- \-\-deprecated\-label [LABEL]
76
+ \-\-deprecated\-label LABEL
77
77
  .
78
78
  .P
79
79
  Set up custom label for deprecated section\. Default is "\fBDeprecated:\fR"\.
80
80
  .
81
81
  .P
82
- \-\-removed\-label [LABEL]
82
+ \-\-removed\-label LABEL
83
83
  .
84
84
  .P
85
85
  Set up custom label for removed section\. Default is "\fBRemoved:\fR"\.
86
86
  .
87
87
  .P
88
- \-\-security\-label [LABEL]
88
+ \-\-security\-label LABEL
89
89
  .
90
90
  .P
91
91
  Set up custom label for security section\. Default is "\fBSecurity:\fR"\.
92
92
  .
93
93
  .P
94
- \-\-issues\-label [LABEL]
94
+ \-\-issues\-label LABEL
95
95
  .
96
96
  .P
97
97
  Set up custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"\.
98
98
  .
99
99
  .P
100
- \-\-header\-label [LABEL]
100
+ \-\-header\-label LABEL
101
101
  .
102
102
  .P
103
103
  Set up custom header label\. Default is "# Changelog"\.
104
104
  .
105
105
  .P
106
- \-\-configure\-sections [HASH, STRING]
106
+ \-\-configure\-sections HASH, STRING
107
107
  .
108
108
  .P
109
109
  Define your own set of sections which overrides all default sections\.
110
110
  .
111
111
  .P
112
- \-\-add\-sections [HASH, STRING]
112
+ \-\-add\-sections HASH, STRING
113
113
  .
114
114
  .P
115
115
  Add new sections but keep the default sections\.
116
116
  .
117
117
  .P
118
- \-\-front\-matter [JSON]
118
+ \-\-front\-matter JSON
119
119
  .
120
120
  .P
121
121
  Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line\.
122
122
  .
123
123
  .P
124
- \-\-pr\-label [LABEL]
124
+ \-\-pr\-label LABEL
125
125
  .
126
126
  .P
127
127
  Set up custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"\.
@@ -187,7 +187,7 @@ Generate log from unreleased closed issues only\.
187
187
  Add to log unreleased closed issues\. Default is true\.
188
188
  .
189
189
  .P
190
- \-\-unreleased\-label [label]
190
+ \-\-unreleased\-label LABEL
191
191
  .
192
192
  .P
193
193
  Set up custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"\.
@@ -265,7 +265,7 @@ The specified labels will be shown in brackets next to each matching issue\. Use
265
265
  Changelog will exclude specified tags\.
266
266
  .
267
267
  .P
268
- \-\-exclude\-tags\-regex [REGEX]
268
+ \-\-exclude\-tags\-regex REGEX
269
269
  .
270
270
  .P
271
271
  Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"\.
@@ -289,25 +289,25 @@ Changelog will end before specified tag\.
289
289
  Fetch only commits after this time\. eg\. "2017\-01\-01 10:00:00"
290
290
  .
291
291
  .P
292
- \-\-max\-issues [NUMBER]
292
+ \-\-max\-issues NUMBER
293
293
  .
294
294
  .P
295
295
  Maximum number of issues to fetch from GitHub\. Default is unlimited\.
296
296
  .
297
297
  .P
298
- \-\-release\-url [URL]
298
+ \-\-release\-url URL
299
299
  .
300
300
  .P
301
301
  The URL to point to for release links, in printf format (with the tag as variable)\.
302
302
  .
303
303
  .P
304
- \-\-github\-site [URL]
304
+ \-\-github\-site URL
305
305
  .
306
306
  .P
307
307
  The Enterprise GitHub site where your project is hosted\.
308
308
  .
309
309
  .P
310
- \-\-github\-api [URL]
310
+ \-\-github\-api URL
311
311
  .
312
312
  .P
313
313
  The enterprise endpoint to use for your GitHub API\.
@@ -319,13 +319,13 @@ The enterprise endpoint to use for your GitHub API\.
319
319
  Create a simple list from issues and pull requests\. Default is false\.
320
320
  .
321
321
  .P
322
- \-\-future\-release [RELEASE\-VERSION]
322
+ \-\-future\-release RELEASE\-VERSION
323
323
  .
324
324
  .P
325
325
  Put the unreleased changes in the specified release number\.
326
326
  .
327
327
  .P
328
- \-\-release\-branch [RELEASE\-BRANCH]
328
+ \-\-release\-branch RELEASE\-BRANCH
329
329
  .
330
330
  .P
331
331
  Limit pull requests to the release branch, such as master or release\.
@@ -337,19 +337,19 @@ Limit pull requests to the release branch, such as master or release\.
337
337
  Use HTTP Cache to cache GitHub API requests (useful for large repos)\. Default is true\.
338
338
  .
339
339
  .P
340
- \-\-[no\-]cache\-file [CACHE\-FILE]
340
+ \-\-[no\-]cache\-file CACHE\-FILE
341
341
  .
342
342
  .P
343
343
  Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
344
344
  .
345
345
  .P
346
- \-\-cache\-log [CACHE\-LOG]
346
+ \-\-cache\-log CACHE\-LOG
347
347
  .
348
348
  .P
349
349
  Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
350
350
  .
351
351
  .P
352
- \-\-ssl\-ca\-file [PATH]
352
+ \-\-ssl\-ca\-file PATH
353
353
  .
354
354
  .P
355
355
  Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
data/man/git-generate-changelog.1.html CHANGED
@@ -85,79 +85,79 @@
85
85
 
86
86
  <h2 id="OPTIONS">OPTIONS</h2>
87
87
 
88
- <p> -u, --user [USER]</p>
88
+ <p> -u, --user USER</p>
89
89
 
90
90
  <p> Username of the owner of target GitHub repo.</p>
91
91
 
92
- <p> -p, --project [PROJECT]</p>
92
+ <p> -p, --project PROJECT</p>
93
93
 
94
94
  <p> Name of project on GitHub.</p>
95
95
 
96
- <p> -t, --token [TOKEN]</p>
96
+ <p> -t, --token TOKEN</p>
97
97
 
98
98
  <p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
99
99
 
100
- <p> -f, --date-format [FORMAT]</p>
100
+ <p> -f, --date-format FORMAT</p>
101
101
 
102
102
  <p> Date format. Default is %Y-%m-%d.</p>
103
103
 
104
- <p> -o, --output [NAME]</p>
104
+ <p> -o, --output NAME</p>
105
105
 
106
106
  <p> Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.</p>
107
107
 
108
- <p> -b, --base [NAME]</p>
108
+ <p> -b, --base NAME</p>
109
109
 
110
110
  <p> Optional base file to append generated changes to.</p>
111
111
 
112
- <p> --summary-label [LABEL]</p>
112
+ <p> --summary-label LABEL</p>
113
113
 
114
114
  <p> Set up custom label for the release summary section. Default is "".</p>
115
115
 
116
- <p> --breaking-label [LABEL]</p>
116
+ <p> --breaking-label LABEL</p>
117
117
 
118
118
  <p> Set up custom label for breaking changes section. Default is "<strong>Breaking changes:</strong>".</p>
119
119
 
120
- <p> --enhancement-label [LABEL]</p>
120
+ <p> --enhancement-label LABEL</p>
121
121
 
122
122
  <p> Set up custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>".</p>
123
123
 
124
- <p> --bugs-label [LABEL]</p>
124
+ <p> --bugs-label LABEL</p>
125
125
 
126
126
  <p> Set up custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong>".</p>
127
127
 
128
- <p> --deprecated-label [LABEL]</p>
128
+ <p> --deprecated-label LABEL</p>
129
129
 
130
130
  <p> Set up custom label for deprecated section. Default is "<strong>Deprecated:</strong>".</p>
131
131
 
132
- <p> --removed-label [LABEL]</p>
132
+ <p> --removed-label LABEL</p>
133
133
 
134
134
  <p> Set up custom label for removed section. Default is "<strong>Removed:</strong>".</p>
135
135
 
136
- <p> --security-label [LABEL]</p>
136
+ <p> --security-label LABEL</p>
137
137
 
138
138
  <p> Set up custom label for security section. Default is "<strong>Security:</strong>".</p>
139
139
 
140
- <p> --issues-label [LABEL]</p>
140
+ <p> --issues-label LABEL</p>
141
141
 
142
142
  <p> Set up custom label for closed-issues section. Default is "<strong>Closed issues:</strong>".</p>
143
143
 
144
- <p> --header-label [LABEL]</p>
144
+ <p> --header-label LABEL</p>
145
145
 
146
146
  <p> Set up custom header label. Default is "# Changelog".</p>
147
147
 
148
- <p> --configure-sections [HASH, STRING]</p>
148
+ <p> --configure-sections HASH, STRING</p>
149
149
 
150
150
  <p> Define your own set of sections which overrides all default sections.</p>
151
151
 
152
- <p> --add-sections [HASH, STRING]</p>
152
+ <p> --add-sections HASH, STRING</p>
153
153
 
154
154
  <p> Add new sections but keep the default sections.</p>
155
155
 
156
- <p> --front-matter [JSON]</p>
156
+ <p> --front-matter JSON</p>
157
157
 
158
158
  <p> Add YAML front matter. Formatted as JSON because it's easier to add on the command line.</p>
159
159
 
160
- <p> --pr-label [LABEL]</p>
160
+ <p> --pr-label LABEL</p>
161
161
 
162
162
  <p> Set up custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>".</p>
163
163
 
@@ -201,7 +201,7 @@
201
201
 
202
202
  <p> Add to log unreleased closed issues. Default is true.</p>
203
203
 
204
- <p> --unreleased-label [label]</p>
204
+ <p> --unreleased-label LABEL</p>
205
205
 
206
206
  <p> Set up custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>".</p>
207
207
 
@@ -253,7 +253,7 @@
253
253
 
254
254
  <p> Changelog will exclude specified tags.</p>
255
255
 
256
- <p> --exclude-tags-regex [REGEX]</p>
256
+ <p> --exclude-tags-regex REGEX</p>
257
257
 
258
258
  <p> Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}".</p>
259
259
 
@@ -269,19 +269,19 @@
269
269
 
270
270
  <p> Fetch only commits after this time. eg. "2017-01-01 10:00:00"</p>
271
271
 
272
- <p> --max-issues [NUMBER]</p>
272
+ <p> --max-issues NUMBER</p>
273
273
 
274
274
  <p> Maximum number of issues to fetch from GitHub. Default is unlimited.</p>
275
275
 
276
- <p> --release-url [URL]</p>
276
+ <p> --release-url URL</p>
277
277
 
278
278
  <p> The URL to point to for release links, in printf format (with the tag as variable).</p>
279
279
 
280
- <p> --github-site [URL]</p>
280
+ <p> --github-site URL</p>
281
281
 
282
282
  <p> The Enterprise GitHub site where your project is hosted.</p>
283
283
 
284
- <p> --github-api [URL]</p>
284
+ <p> --github-api URL</p>
285
285
 
286
286
  <p> The enterprise endpoint to use for your GitHub API.</p>
287
287
 
@@ -289,11 +289,11 @@
289
289
 
290
290
  <p> Create a simple list from issues and pull requests. Default is false.</p>
291
291
 
292
- <p> --future-release [RELEASE-VERSION]</p>
292
+ <p> --future-release RELEASE-VERSION</p>
293
293
 
294
294
  <p> Put the unreleased changes in the specified release number.</p>
295
295
 
296
- <p> --release-branch [RELEASE-BRANCH]</p>
296
+ <p> --release-branch RELEASE-BRANCH</p>
297
297
 
298
298
  <p> Limit pull requests to the release branch, such as master or release.</p>
299
299
 
@@ -301,15 +301,15 @@
301
301
 
302
302
  <p> Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.</p>
303
303
 
304
- <p> --[no-]cache-file [CACHE-FILE]</p>
304
+ <p> --[no-]cache-file CACHE-FILE</p>
305
305
 
306
306
  <p> Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
307
307
 
308
- <p> --cache-log [CACHE-LOG]</p>
308
+ <p> --cache-log CACHE-LOG</p>
309
309
 
310
310
  <p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
311
311
 
312
- <p> --ssl-ca-file [PATH]</p>
312
+ <p> --ssl-ca-file PATH</p>
313
313
 
314
314
  <p> Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
315
315
 
data/man/git-generate-changelog.html CHANGED
@@ -84,47 +84,47 @@
84
84
 
85
85
  <h2 id="OPTIONS">OPTIONS</h2>
86
86
 
87
- <p> -u, --user [USER]</p>
87
+ <p> -u, --user USER</p>
88
88
 
89
89
  <p> Username of the owner of target GitHub repo</p>
90
90
 
91
- <p> -p, --project [PROJECT]</p>
91
+ <p> -p, --project PROJECT</p>
92
92
 
93
93
  <p> Name of project on GitHub</p>
94
94
 
95
- <p> -t, --token [TOKEN]</p>
95
+ <p> -t, --token TOKEN</p>
96
96
 
97
97
  <p> To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
98
98
 
99
- <p> -f, --date-format [FORMAT]</p>
99
+ <p> -f, --date-format FORMAT</p>
100
100
 
101
101
  <p> Date format. Default is %Y-%m-%d</p>
102
102
 
103
- <p> -o, --output [NAME]</p>
103
+ <p> -o, --output NAME</p>
104
104
 
105
105
  <p> Output file. Default is CHANGELOG.md</p>
106
106
 
107
- <p> -b, --base [NAME]</p>
107
+ <p> -b, --base NAME</p>
108
108
 
109
109
  <p> Optional base file to append generated changes to.</p>
110
110
 
111
- <p> --bugs-label [LABEL]</p>
111
+ <p> --bugs-label LABEL</p>
112
112
 
113
113
  <p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
114
114
 
115
- <p> --enhancement-label [LABEL]</p>
115
+ <p> --enhancement-label LABEL</p>
116
116
 
117
117
  <p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
118
118
 
119
- <p> --issues-label [LABEL]</p>
119
+ <p> --issues-label LABEL</p>
120
120
 
121
121
  <p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
122
122
 
123
- <p> --header-label [LABEL]</p>
123
+ <p> --header-label LABEL</p>
124
124
 
125
125
  <p> Setup custom header label. Default is "# Changelog"</p>
126
126
 
127
- <p> --pr-label [LABEL]</p>
127
+ <p> --pr-label LABEL</p>
128
128
 
129
129
  <p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
130
130
 
@@ -160,7 +160,7 @@
160
160
 
161
161
  <p> Add to log unreleased closed issues. Default is true</p>
162
162
 
163
- <p> --unreleased-label [label]</p>
163
+ <p> --unreleased-label LABEL</p>
164
164
 
165
165
  <p> Add to log unreleased closed issues. Default is true</p>
166
166
 
@@ -196,19 +196,19 @@
196
196
 
197
197
  <p> Changelog will end before specified tag</p>
198
198
 
199
- <p> --max-issues [NUMBER]</p>
199
+ <p> --max-issues NUMBER</p>
200
200
 
201
201
  <p> Max number of issues to fetch from GitHub. Default is unlimited</p>
202
202
 
203
- <p> --release-url [URL]</p>
203
+ <p> --release-url URL</p>
204
204
 
205
205
  <p> The URL to point to for release links, in printf format (with the tag as variable).</p>
206
206
 
207
- <p> --github-site [URL]</p>
207
+ <p> --github-site URL</p>
208
208
 
209
209
  <p> The Enterprise Github site on which your project is hosted.</p>
210
210
 
211
- <p> --github-api [URL]</p>
211
+ <p> --github-api URL</p>
212
212
 
213
213
  <p> The enterprise endpoint to use for your Github API.</p>
214
214
 
@@ -216,15 +216,15 @@
216
216
 
217
217
  <p> Create simple list from issues and pull requests. Default is false.</p>
218
218
 
219
- <p> --future-release [RELEASE-VERSION]</p>
219
+ <p> --future-release RELEASE-VERSION</p>
220
220
 
221
221
  <p> Put the unreleased changes in the specified release number.</p>
222
222
 
223
- <p> --configure-sections [HASH, STRING]</p>
223
+ <p> --configure-sections HASH, STRING</p>
224
224
 
225
225
  <p> Define your own set of sections which overrides all default sections") do |v|</p>
226
226
 
227
- <p> --add-sections [HASH, STRING]</p>
227
+ <p> --add-sections HASH, STRING</p>
228
228
 
229
229
  <p> Add new sections but keep the default sections"</p>
230
230