github_changelog_generator 1.15.0.pre.rc → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +126 -51
  4. data/bin/git-generate-changelog +1 -1
  5. data/lib/github_changelog_generator.rb +10 -6
  6. data/lib/github_changelog_generator/generator/entry.rb +218 -0
  7. data/lib/github_changelog_generator/generator/generator.rb +96 -119
  8. data/lib/github_changelog_generator/generator/generator_fetcher.rb +140 -21
  9. data/lib/github_changelog_generator/generator/generator_processor.rb +40 -10
  10. data/lib/github_changelog_generator/generator/generator_tags.rb +10 -12
  11. data/lib/github_changelog_generator/generator/section.rb +104 -0
  12. data/lib/github_changelog_generator/octo_fetcher.rb +113 -23
  13. data/lib/github_changelog_generator/options.rb +35 -4
  14. data/lib/github_changelog_generator/parser.rb +88 -49
  15. data/lib/github_changelog_generator/parser_file.rb +6 -2
  16. data/lib/github_changelog_generator/task.rb +2 -3
  17. data/lib/github_changelog_generator/version.rb +1 -1
  18. data/man/git-generate-changelog.1 +125 -51
  19. data/man/git-generate-changelog.1.html +145 -89
  20. data/man/git-generate-changelog.html +19 -7
  21. data/man/git-generate-changelog.md +141 -86
  22. data/spec/files/github-changelog-generator.md +114 -114
  23. data/spec/{install-gem-in-bundler.gemfile → install_gem_in_bundler.gemfile} +2 -0
  24. data/spec/spec_helper.rb +1 -5
  25. data/spec/unit/generator/entry_spec.rb +760 -0
  26. data/spec/unit/generator/generator_processor_spec.rb +9 -2
  27. data/spec/unit/generator/generator_tags_spec.rb +5 -21
  28. data/spec/unit/octo_fetcher_spec.rb +204 -197
  29. data/spec/unit/options_spec.rb +24 -0
  30. data/spec/unit/parse_file_spec.rb +2 -2
  31. data/spec/unit/reader_spec.rb +4 -4
  32. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_commits/when_API_is_valid/returns_commits.json +1 -0
  33. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_commits_before/when_API_is_valid/returns_commits.json +1 -1
  34. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid.json +1 -1
  35. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issue_with_proper_key/values.json +1 -1
  36. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issues.json +1 -1
  37. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issues_with_labels.json +1 -1
  38. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_pull_request_with_proper_key/values.json +1 -1
  39. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_pull_requests_with_labels.json +1 -1
  40. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid.json +1 -1
  41. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid/returns_correct_pull_request_keys.json +1 -1
  42. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid/returns_pull_requests.json +1 -1
  43. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_commit/when_API_call_is_valid.json +1 -1
  44. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_commit/when_API_call_is_valid/returns_commit.json +1 -1
  45. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_date_of_tag/when_API_call_is_valid.json +1 -1
  46. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_date_of_tag/when_API_call_is_valid/returns_date.json +1 -1
  47. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid.json +1 -1
  48. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid/populates_issues.json +1 -1
  49. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid.json +1 -1
  50. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid/should_return_tags.json +1 -1
  51. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid/should_return_tags_count.json +1 -1
  52. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided.json +1 -1
  53. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided/should_raise_Unauthorized_error.json +1 -1
  54. metadata +17 -17
  55. data/bin/ghclgen +0 -5
  56. data/lib/github_changelog_generator/generator/generator_generation.rb +0 -181
  57. data/spec/unit/generator/generator_generation_spec.rb +0 -73
data/man/git-generate-changelog.1.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
5
  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
- <title>git-generate-changelog(1) - Generate changelog from github</title>
6
+ <title>git-generate-changelog(1) - Generate changelog from GitHub</title>
7
7
  <style type='text/css' media='all'>
8
8
  /* style: man */
9
9
  body#manpage {margin:0}
@@ -57,6 +57,7 @@
57
57
  <a href="#SYNOPSIS">SYNOPSIS</a>
58
58
  <a href="#DESCRIPTION">DESCRIPTION</a>
59
59
  <a href="#OPTIONS">OPTIONS</a>
60
+ <a href="#REBASED-COMMITS">REBASED COMMITS</a>
60
61
  <a href="#EXAMPLES">EXAMPLES</a>
61
62
  <a href="#AUTHOR">AUTHOR</a>
62
63
  <a href="#REPORTING-BUGS">REPORTING BUGS</a>
@@ -71,7 +72,7 @@
71
72
 
72
73
  <h2 id="NAME">NAME</h2>
73
74
  <p class="man-name">
74
- <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
75
+ <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from GitHub</span>
75
76
  </p>
76
77
 
77
78
  <h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -80,17 +81,17 @@
80
81
 
81
82
  <h2 id="DESCRIPTION">DESCRIPTION</h2>
82
83
 
83
- <p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
84
+ <p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
84
85
 
85
86
  <h2 id="OPTIONS">OPTIONS</h2>
86
87
 
87
88
  <p> -u, --user [USER]</p>
88
89
 
89
- <p> Username of the owner of target GitHub repo</p>
90
+ <p> Username of the owner of target GitHub repo.</p>
90
91
 
91
92
  <p> -p, --project [PROJECT]</p>
92
93
 
93
- <p> Name of project on GitHub</p>
94
+ <p> Name of project on GitHub.</p>
94
95
 
95
96
  <p> -t, --token [TOKEN]</p>
96
97
 
@@ -98,176 +99,231 @@
98
99
 
99
100
  <p> -f, --date-format [FORMAT]</p>
100
101
 
101
- <p> Date format. Default is %Y-%m-%d</p>
102
+ <p> Date format. Default is %Y-%m-%d.</p>
102
103
 
103
104
  <p> -o, --output [NAME]</p>
104
105
 
105
- <p> Output file. Default is CHANGELOG.md</p>
106
+ <p> Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.</p>
106
107
 
107
108
  <p> -b, --base [NAME]</p>
108
109
 
109
110
  <p> Optional base file to append generated changes to.</p>
110
111
 
111
- <p> --bugs-label [LABEL]</p>
112
+ <p> --summary-label [LABEL]</p>
112
113
 
113
- <p> Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
114
+ <p> Set up custom label for the release summary section. Default is "".</p>
114
115
 
115
- <p> --enhancement-label [LABEL]</p>
116
+ <p> --breaking-label [LABEL]</p>
116
117
 
117
- <p> Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
118
+ <p> Set up custom label for breaking changes section. Default is "<strong>Breaking changes:</strong>".</p>
118
119
 
119
- <p> --issues-label [LABEL]</p>
120
+ <p> --enhancement-label [LABEL]</p>
120
121
 
121
- <p> Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
122
+ <p> Set up custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>".</p>
122
123
 
123
- <p> --header-label [LABEL]</p>
124
+ <p> --bugs-label [LABEL]</p>
124
125
 
125
- <p> Setup custom header label. Default is "# Change Log"</p>
126
+ <p> Set up custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong>".</p>
126
127
 
127
- <p> --front-matter [JSON]</p>
128
+ <p> --deprecated-label [LABEL]</p>
128
129
 
129
- <p> Add YAML front matter. Formatted as JSON because it's easier to add on the command line</p>
130
+ <p> Set up custom label for deprecated section. Default is "<strong>Deprecated:</strong>".</p>
130
131
 
131
- <p> --pr-label [LABEL]</p>
132
+ <p> --removed-label [LABEL]</p>
132
133
 
133
- <p> Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
134
+ <p> Set up custom label for removed section. Default is "<strong>Removed:</strong>".</p>
134
135
 
135
- <p> --[no-]issues</p>
136
+ <p> --security-label [LABEL]</p>
136
137
 
137
- <p> Include closed issues in changelog. Default is true</p>
138
+ <p> Set up custom label for security section. Default is "<strong>Security:</strong>".</p>
138
139
 
139
- <p> --[no-]issues-wo-labels</p>
140
+ <p> --issues-label [LABEL]</p>
140
141
 
141
- <p> Include closed issues without labels in changelog. Default is true</p>
142
+ <p> Set up custom label for closed-issues section. Default is "<strong>Closed issues:</strong>".</p>
142
143
 
143
- <p> --[no-]pr-wo-labels</p>
144
+ <p> --header-label [LABEL]</p>
144
145
 
145
- <p> Include pull requests without labels in changelog. Default is true</p>
146
+ <p> Set up custom header label. Default is "# Changelog".</p>
146
147
 
147
- <p> --[no-]pull-requests</p>
148
+ <p> --configure-sections [HASH, STRING]</p>
148
149
 
149
- <p> Include pull-requests in changelog. Default is true</p>
150
+ <p> Define your own set of sections which overrides all default sections.</p>
150
151
 
151
- <p> --[no-]filter-by-milestone</p>
152
+ <p> --add-sections [HASH, STRING]</p>
152
153
 
153
- <p> Use milestone to detect when issue was resolved. Default is true</p>
154
+ <p> Add new sections but keep the default sections.</p>
154
155
 
155
- <p> --[no-]author</p>
156
+ <p> --front-matter [JSON]</p>
156
157
 
157
- <p> Add author of pull-request in the end. Default is true</p>
158
+ <p> Add YAML front matter. Formatted as JSON because it's easier to add on the command line.</p>
158
159
 
159
- <p> --usernames-as-github-logins</p>
160
+ <p> --pr-label [LABEL]</p>
160
161
 
161
- <p> Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</p>
162
+ <p> Set up custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>".</p>
162
163
 
163
- <p> --unreleased-only</p>
164
+ <p> --[no-]issues</p>
164
165
 
165
- <p> Generate log from unreleased closed issues only.</p>
166
+ <p> Include closed issues in changelog. Default is true.</p>
166
167
 
167
- <p> --[no-]unreleased</p>
168
+ <p> --[no-]issues-wo-labels</p>
168
169
 
169
- <p> Add to log unreleased closed issues. Default is true</p>
170
+ <p> Include closed issues without labels in changelog. Default is true.</p>
170
171
 
171
- <p> --unreleased-label [label]</p>
172
+ <p> --[no-]pr-wo-labels</p>
172
173
 
173
- <p> Setup custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>"</p>
174
+ <p> Include pull requests without labels in changelog. Default is true.</p>
174
175
 
175
- <p> --[no-]compare-link</p>
176
+ <p> --[no-]pull-requests</p>
176
177
 
177
- <p> Include compare link (Full Changelog) between older version and newer version. Default is true</p>
178
+ <p> Include pull-requests in changelog. Default is true.</p>
178
179
 
179
- <p> --include-labels x,y,z</p>
180
+ <p> --[no-]filter-by-milestone</p>
180
181
 
181
- <p> Only issues with the specified labels will be included in the changelog.</p>
182
+ <p> Use milestone to detect when issue was resolved. Default is true.</p>
182
183
 
183
- <p> --exclude-labels x,y,z</p>
184
+ <p> --[no-]author</p>
184
185
 
185
- <p> Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
186
+ <p> Add author of pull request at the end. Default is true.</p>
186
187
 
187
- <p> --bug-labels x,y,z</p>
188
+ <p> --usernames-as-github-logins</p>
188
189
 
189
- <p> Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
190
+ <p> Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</p>
190
191
 
191
- <p> --enhancement-labels x,y,z</p>
192
+ <p> --unreleased-only</p>
192
193
 
193
- <p> Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
194
+ <p> Generate log from unreleased closed issues only.</p>
194
195
 
195
- <p> --exclude-tags x,y,z</p>
196
+ <p> --[no-]unreleased</p>
196
197
 
197
- <p> Change log will exclude specified tags</p>
198
+ <p> Add to log unreleased closed issues. Default is true.</p>
198
199
 
199
- <p> --exclude-tags-regex [REGEX]</p>
200
+ <p> --unreleased-label [label]</p>
200
201
 
201
- <p> Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}"</p>
202
+ <p> Set up custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>".</p>
202
203
 
203
- <p> --since-tag x</p>
204
+ <p> --[no-]compare-link</p>
204
205
 
205
- <p> Change log will start after specified tag</p>
206
+ <p> Include compare link (Full Changelog) between older version and newer version. Default is true.</p>
206
207
 
207
- <p> --due-tag x</p>
208
+ <p> --include-labels x,y,z</p>
208
209
 
209
- <p> Change log will end before specified tag</p>
210
+ <p> Of the labeled issues, only include the ones with the specified labels.</p>
210
211
 
211
- <p> --max-issues [NUMBER]</p>
212
+ <p> --exclude-labels x,y,z</p>
212
213
 
213
- <p> Max number of issues to fetch from GitHub. Default is unlimited</p>
214
+ <p> Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.</p>
214
215
 
215
- <p> --release-url [URL]</p>
216
+ <p> --summary-labels x,y,z</p>
216
217
 
217
- <p> The URL to point to for release links, in printf format (with the tag as variable).</p>
218
+ <p> Issues with these labels will be added to a new section, called "Release Summary". The section display only body of issues. Default is 'Release summary,release-summary,Summary,summary'.</p>
218
219
 
219
- <p> --github-site [URL]</p>
220
+ <p> --breaking-labels x,y,z</p>
220
221
 
221
- <p> The Enterprise Github site on which your project is hosted.</p>
222
+ <p> Issues with these labels will be added to a new section, called "Breaking changes". Default is 'backwards-incompatible,breaking'.</p>
222
223
 
223
- <p> --github-api [URL]</p>
224
+ <p> --enhancement-labels x,y,z</p>
224
225
 
225
- <p> The enterprise endpoint to use for your Github API.</p>
226
+ <p> Issues with the specified labels will be added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'.</p>
226
227
 
227
- <p> --simple-list</p>
228
+ <p> --bug-labels x,y,z</p>
228
229
 
229
- <p> Create simple list from issues and pull requests. Default is false.</p>
230
+ <p> Issues with the specified labels will be added to "Fixed bugs" section. Default is 'bug,Bug'.</p>
230
231
 
231
- <p> --future-release [RELEASE-VERSION]</p>
232
+ <p> --deprecated-labels x,y,z</p>
232
233
 
233
- <p> Put the unreleased changes in the specified release number.</p>
234
+ <p> Issues with the specified labels will be added to a section called "Deprecated". Default is 'deprecated,Deprecated'.</p>
234
235
 
235
- <p> --release-branch [RELEASE-BRANCH]</p>
236
+ <p> --removed-labels x,y,z</p>
236
237
 
237
- <p> Limit pull requests to the release branch, such as master or release</p>
238
+ <p> Issues with the specified labels will be added to a section called "Removed". Default is 'removed,Removed'.</p>
238
239
 
239
- <p> --http-cache</p>
240
+ <p> --security-labels x,y,z</p>
240
241
 
241
- <p> Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.</p>
242
+ <p> Issues with the specified labels will be added to a section called "Security fixes". Default is 'security,Security'.</p>
242
243
 
243
- <p> --[no-]cache-file [CACHE-FILE]</p>
244
+ <p> --issue-line-labels x,y,z</p>
244
245
 
245
- <p> Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
246
+ <p> The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].</p>
246
247
 
247
- <p> --cache-log [CACHE-LOG]</p>
248
+ <p> --exclude-tags x,y,z</p>
248
249
 
249
- <p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
250
+ <p> Changelog will exclude specified tags.</p>
250
251
 
251
- <pre><code>--ssl-ca-file [PATH]
252
- </code></pre>
252
+ <p> --exclude-tags-regex [REGEX]</p>
253
253
 
254
- <p> Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
254
+ <p> Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}".</p>
255
255
 
256
- <p> --require file1.rb,file2.rb</p>
256
+ <p> --since-tag x</p>
257
257
 
258
- <p> Paths to Ruby file(s) to require before generating changelog.</p>
258
+ <p> Changelog will start after specified tag.</p>
259
259
 
260
- <p> --[no-]verbose</p>
260
+ <p> --due-tag x</p>
261
261
 
262
- <p> Run verbosely. Default is true</p>
262
+ <p> Changelog will end before specified tag.</p>
263
+
264
+ <p> --max-issues [NUMBER]</p>
265
+
266
+ <p> Maximum number of issues to fetch from GitHub. Default is unlimited.</p>
267
+
268
+ <p> --release-url [URL]</p>
269
+
270
+ <p> The URL to point to for release links, in printf format (with the tag as variable).</p>
271
+
272
+ <p> --github-site [URL]</p>
273
+
274
+ <p> The Enterprise GitHub site where your project is hosted.</p>
275
+
276
+ <p> --github-api [URL]</p>
277
+
278
+ <p> The enterprise endpoint to use for your GitHub API.</p>
279
+
280
+ <p> --simple-list</p>
281
+
282
+ <p> Create a simple list from issues and pull requests. Default is false.</p>
283
+
284
+ <p> --future-release [RELEASE-VERSION]</p>
285
+
286
+ <p> Put the unreleased changes in the specified release number.</p>
287
+
288
+ <p> --release-branch [RELEASE-BRANCH]</p>
289
+
290
+ <p> Limit pull requests to the release branch, such as master or release.</p>
291
+
292
+ <p> --http-cache</p>
293
+
294
+ <p> Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.</p>
295
+
296
+ <p> --[no-]cache-file [CACHE-FILE]</p>
297
+
298
+ <p> Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
299
+
300
+ <p> --cache-log [CACHE-LOG]</p>
301
+
302
+ <p> Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
303
+
304
+ <p> --ssl-ca-file [PATH]</p>
305
+
306
+ <p> Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
307
+
308
+ <p> --require file1.rb,file2.rb</p>
309
+
310
+ <p> Paths to Ruby file(s) to require before generating changelog.</p>
311
+
312
+ <p> --[no-]verbose</p>
313
+
314
+ <p> Run verbosely. Default is true.</p>
263
315
 
264
316
  <p> -v, --version</p>
265
317
 
266
- <p> Print version number</p>
318
+ <p> Print version number.</p>
267
319
 
268
320
  <p> -h, --help</p>
269
321
 
270
- <p> Displays Help</p>
322
+ <p> Displays Help.</p>
323
+
324
+ <h2 id="REBASED-COMMITS">REBASED COMMITS</h2>
325
+
326
+ <p>GitHub pull requests that have been merged whose merge commit SHA has been modified through rebasing, cherry picking, or some other method may be tracked via a special comment on GitHub. Git commit SHAs found in comments on pull requests matching the regular expression <code>/rebased commit: ([0-9a-f]{40})/i</code> will be used in place of the original merge SHA when being added to the changelog.</p>
271
327
 
272
328
  <h2 id="EXAMPLES">EXAMPLES</h2>
273
329
 
@@ -277,16 +333,16 @@
277
333
 
278
334
  <h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
279
335
 
280
- <p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
336
+ <p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/issues" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/issues</a>&gt;</p>
281
337
 
282
338
  <h2 id="SEE-ALSO">SEE ALSO</h2>
283
339
 
284
- <p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
340
+ <p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/</a>&gt;</p>
285
341
 
286
342
 
287
343
  <ol class='man-decor man-foot man foot'>
288
344
  <li class='tl'></li>
289
- <li class='tc'>October 2017</li>
345
+ <li class='tc'>May 2018</li>
290
346
  <li class='tr'>git-generate-changelog(1)</li>
291
347
  </ol>
292
348
 
data/man/git-generate-changelog.html CHANGED
@@ -80,7 +80,7 @@
80
80
 
81
81
  <h2 id="DESCRIPTION">DESCRIPTION</h2>
82
82
 
83
- <p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
83
+ <p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
84
84
 
85
85
  <h2 id="OPTIONS">OPTIONS</h2>
86
86
 
@@ -122,7 +122,7 @@
122
122
 
123
123
  <p> --header-label [LABEL]</p>
124
124
 
125
- <p> Setup custom header label. Default is "# Change Log"</p>
125
+ <p> Setup custom header label. Default is "# Changelog"</p>
126
126
 
127
127
  <p> --pr-label [LABEL]</p>
128
128
 
@@ -186,15 +186,15 @@
186
186
 
187
187
  <p> --exclude-tags x,y,z</p>
188
188
 
189
- <p> Change log will exclude specified tags</p>
189
+ <p> Changelog will exclude specified tags</p>
190
190
 
191
191
  <p> --since-tag x</p>
192
192
 
193
- <p> Change log will start after specified tag</p>
193
+ <p> Changelog will start after specified tag</p>
194
194
 
195
195
  <p> --due-tag x</p>
196
196
 
197
- <p> Change log will end before specified tag</p>
197
+ <p> Changelog will end before specified tag</p>
198
198
 
199
199
  <p> --max-issues [NUMBER]</p>
200
200
 
@@ -220,6 +220,18 @@
220
220
 
221
221
  <p> Put the unreleased changes in the specified release number.</p>
222
222
 
223
+ <p> --configure-sections [HASH, STRING]</p>
224
+
225
+ <p> Define your own set of sections which overrides all default sections") do |v|</p>
226
+
227
+ <p> --add-sections [HASH, STRING]</p>
228
+
229
+ <p> Add new sections but keep the default sections"</p>
230
+
231
+ <p> --include-merged</p>
232
+
233
+ <p> If configure_sections is set, use this to restore the merged pull requests sections</p>
234
+
223
235
  <p> --[no-]verbose</p>
224
236
 
225
237
  <p> Run verbosely. Default is true</p>
@@ -240,11 +252,11 @@
240
252
 
241
253
  <h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
242
254
 
243
- <p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
255
+ <p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/issues" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/issues</a>&gt;</p>
244
256
 
245
257
  <h2 id="SEE-ALSO">SEE ALSO</h2>
246
258
 
247
- <p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
259
+ <p>&lt;<a href="https://github.com/github-changelog-generator/github-changelog-generator/" data-bare-link="true">https://github.com/github-changelog-generator/github-changelog-generator/</a>&gt;</p>
248
260
 
249
261
 
250
262
  <ol class='man-decor man-foot man foot'>
data/man/git-generate-changelog.md CHANGED
@@ -1,4 +1,4 @@
1
- git-generate-changelog(1) - Generate changelog from github
1
+ git-generate-changelog(1) - Generate changelog from GitHub
2
2
  ================================
3
3
 
4
4
  ## SYNOPSIS
@@ -7,17 +7,17 @@ git-generate-changelog(1) - Generate changelog from github
7
7
 
8
8
  ## DESCRIPTION
9
9
 
10
- Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
10
+ Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.
11
11
 
12
12
  ## OPTIONS
13
13
 
14
14
  -u, --user [USER]
15
15
 
16
- Username of the owner of target GitHub repo
16
+ Username of the owner of target GitHub repo.
17
17
 
18
18
  -p, --project [PROJECT]
19
19
 
20
- Name of project on GitHub
20
+ Name of project on GitHub.
21
21
 
22
22
  -t, --token [TOKEN]
23
23
 
@@ -25,176 +25,231 @@ Automatically generate change log from your tags, issues, labels and pull reques
25
25
 
26
26
  -f, --date-format [FORMAT]
27
27
 
28
- Date format. Default is %Y-%m-%d
28
+ Date format. Default is %Y-%m-%d.
29
29
 
30
30
  -o, --output [NAME]
31
31
 
32
- Output file. Default is CHANGELOG.md
32
+ Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md.
33
33
 
34
34
  -b, --base [NAME]
35
35
 
36
36
  Optional base file to append generated changes to.
37
37
 
38
- --bugs-label [LABEL]
38
+ --summary-label [LABEL]
39
39
 
40
- Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
40
+ Set up custom label for the release summary section. Default is "".
41
41
 
42
- --enhancement-label [LABEL]
42
+ --breaking-label [LABEL]
43
43
 
44
- Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
44
+ Set up custom label for breaking changes section. Default is "**Breaking changes:**".
45
45
 
46
- --issues-label [LABEL]
46
+ --enhancement-label [LABEL]
47
47
 
48
- Setup custom label for closed-issues section. Default is "**Closed issues:**"
48
+ Set up custom label for enhancements section. Default is "**Implemented enhancements:**".
49
49
 
50
- --header-label [LABEL]
50
+ --bugs-label [LABEL]
51
51
 
52
- Setup custom header label. Default is "# Change Log"
52
+ Set up custom label for bug-fixes section. Default is "**Fixed bugs:**".
53
53
 
54
- --front-matter [JSON]
54
+ --deprecated-label [LABEL]
55
55
 
56
- Add YAML front matter. Formatted as JSON because it's easier to add on the command line
56
+ Set up custom label for deprecated section. Default is "**Deprecated:**".
57
57
 
58
- --pr-label [LABEL]
58
+ --removed-label [LABEL]
59
59
 
60
- Setup custom label for pull requests section. Default is "**Merged pull requests:**"
60
+ Set up custom label for removed section. Default is "**Removed:**".
61
61
 
62
- --[no-]issues
62
+ --security-label [LABEL]
63
63
 
64
- Include closed issues in changelog. Default is true
64
+ Set up custom label for security section. Default is "**Security:**".
65
65
 
66
- --[no-]issues-wo-labels
66
+ --issues-label [LABEL]
67
67
 
68
- Include closed issues without labels in changelog. Default is true
68
+ Set up custom label for closed-issues section. Default is "**Closed issues:**".
69
69
 
70
- --[no-]pr-wo-labels
70
+ --header-label [LABEL]
71
71
 
72
- Include pull requests without labels in changelog. Default is true
72
+ Set up custom header label. Default is "# Changelog".
73
73
 
74
- --[no-]pull-requests
74
+ --configure-sections [HASH, STRING]
75
75
 
76
- Include pull-requests in changelog. Default is true
76
+ Define your own set of sections which overrides all default sections.
77
77
 
78
- --[no-]filter-by-milestone
78
+ --add-sections [HASH, STRING]
79
79
 
80
- Use milestone to detect when issue was resolved. Default is true
80
+ Add new sections but keep the default sections.
81
81
 
82
- --[no-]author
82
+ --front-matter [JSON]
83
83
 
84
- Add author of pull-request in the end. Default is true
84
+ Add YAML front matter. Formatted as JSON because it's easier to add on the command line.
85
85
 
86
- --usernames-as-github-logins
86
+ --pr-label [LABEL]
87
87
 
88
- Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
88
+ Set up custom label for pull requests section. Default is "**Merged pull requests:**".
89
89
 
90
- --unreleased-only
90
+ --[no-]issues
91
91
 
92
- Generate log from unreleased closed issues only.
92
+ Include closed issues in changelog. Default is true.
93
93
 
94
- --[no-]unreleased
94
+ --[no-]issues-wo-labels
95
95
 
96
- Add to log unreleased closed issues. Default is true
96
+ Include closed issues without labels in changelog. Default is true.
97
97
 
98
- --unreleased-label [label]
98
+ --[no-]pr-wo-labels
99
99
 
100
- Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
100
+ Include pull requests without labels in changelog. Default is true.
101
101
 
102
- --[no-]compare-link
102
+ --[no-]pull-requests
103
103
 
104
- Include compare link (Full Changelog) between older version and newer version. Default is true
104
+ Include pull-requests in changelog. Default is true.
105
105
 
106
- --include-labels x,y,z
106
+ --[no-]filter-by-milestone
107
107
 
108
- Only issues with the specified labels will be included in the changelog.
108
+ Use milestone to detect when issue was resolved. Default is true.
109
109
 
110
- --exclude-labels x,y,z
110
+ --[no-]author
111
111
 
112
- Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
112
+ Add author of pull request at the end. Default is true.
113
113
 
114
- --bug-labels x,y,z
114
+ --usernames-as-github-logins
115
115
 
116
- Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
116
+ Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
117
117
 
118
- --enhancement-labels x,y,z
118
+ --unreleased-only
119
119
 
120
- Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
120
+ Generate log from unreleased closed issues only.
121
121
 
122
- --exclude-tags x,y,z
122
+ --[no-]unreleased
123
123
 
124
- Change log will exclude specified tags
124
+ Add to log unreleased closed issues. Default is true.
125
125
 
126
- --exclude-tags-regex [REGEX]
126
+ --unreleased-label [label]
127
127
 
128
- Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"
128
+ Set up custom label for unreleased closed issues section. Default is "**Unreleased:**".
129
129
 
130
- --since-tag x
130
+ --[no-]compare-link
131
131
 
132
- Change log will start after specified tag
132
+ Include compare link (Full Changelog) between older version and newer version. Default is true.
133
133
 
134
- --due-tag x
134
+ --include-labels x,y,z
135
135
 
136
- Change log will end before specified tag
136
+ Of the labeled issues, only include the ones with the specified labels.
137
137
 
138
- --max-issues [NUMBER]
138
+ --exclude-labels x,y,z
139
139
 
140
- Max number of issues to fetch from GitHub. Default is unlimited
140
+ Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.
141
141
 
142
- --release-url [URL]
142
+ --summary-labels x,y,z
143
143
 
144
- The URL to point to for release links, in printf format (with the tag as variable).
144
+ Issues with these labels will be added to a new section, called "Release Summary". The section display only body of issues. Default is 'Release summary,release-summary,Summary,summary'.
145
145
 
146
- --github-site [URL]
146
+ --breaking-labels x,y,z
147
147
 
148
- The Enterprise Github site on which your project is hosted.
148
+ Issues with these labels will be added to a new section, called "Breaking changes". Default is 'backwards-incompatible,breaking'.
149
149
 
150
- --github-api [URL]
150
+ --enhancement-labels x,y,z
151
151
 
152
- The enterprise endpoint to use for your Github API.
152
+ Issues with the specified labels will be added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'.
153
153
 
154
- --simple-list
154
+ --bug-labels x,y,z
155
155
 
156
- Create simple list from issues and pull requests. Default is false.
156
+ Issues with the specified labels will be added to "Fixed bugs" section. Default is 'bug,Bug'.
157
157
 
158
- --future-release [RELEASE-VERSION]
158
+ --deprecated-labels x,y,z
159
159
 
160
- Put the unreleased changes in the specified release number.
160
+ Issues with the specified labels will be added to a section called "Deprecated". Default is 'deprecated,Deprecated'.
161
161
 
162
- --release-branch [RELEASE-BRANCH]
162
+ --removed-labels x,y,z
163
163
 
164
- Limit pull requests to the release branch, such as master or release
164
+ Issues with the specified labels will be added to a section called "Removed". Default is 'removed,Removed'.
165
165
 
166
- --http-cache
166
+ --security-labels x,y,z
167
167
 
168
- Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
168
+ Issues with the specified labels will be added to a section called "Security fixes". Default is 'security,Security'.
169
169
 
170
- --[no-]cache-file [CACHE-FILE]
170
+ --issue-line-labels x,y,z
171
171
 
172
- Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
172
+ The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].
173
173
 
174
- --cache-log [CACHE-LOG]
174
+ --exclude-tags x,y,z
175
175
 
176
- Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
176
+ Changelog will exclude specified tags.
177
177
 
178
- --ssl-ca-file [PATH]
178
+ --exclude-tags-regex [REGEX]
179
179
 
180
- Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
180
+ Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}".
181
181
 
182
- --require file1.rb,file2.rb
182
+ --since-tag x
183
183
 
184
- Paths to Ruby file(s) to require before generating changelog.
184
+ Changelog will start after specified tag.
185
185
 
186
- --[no-]verbose
186
+ --due-tag x
187
187
 
188
- Run verbosely. Default is true
188
+ Changelog will end before specified tag.
189
+
190
+ --max-issues [NUMBER]
191
+
192
+ Maximum number of issues to fetch from GitHub. Default is unlimited.
193
+
194
+ --release-url [URL]
195
+
196
+ The URL to point to for release links, in printf format (with the tag as variable).
197
+
198
+ --github-site [URL]
199
+
200
+ The Enterprise GitHub site where your project is hosted.
201
+
202
+ --github-api [URL]
203
+
204
+ The enterprise endpoint to use for your GitHub API.
205
+
206
+ --simple-list
207
+
208
+ Create a simple list from issues and pull requests. Default is false.
209
+
210
+ --future-release [RELEASE-VERSION]
211
+
212
+ Put the unreleased changes in the specified release number.
213
+
214
+ --release-branch [RELEASE-BRANCH]
215
+
216
+ Limit pull requests to the release branch, such as master or release.
217
+
218
+ --http-cache
219
+
220
+ Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.
221
+
222
+ --[no-]cache-file [CACHE-FILE]
223
+
224
+ Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
225
+
226
+ --cache-log [CACHE-LOG]
227
+
228
+ Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
229
+
230
+ --ssl-ca-file [PATH]
231
+
232
+ Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
233
+
234
+ --require file1.rb,file2.rb
235
+
236
+ Paths to Ruby file(s) to require before generating changelog.
237
+
238
+ --[no-]verbose
239
+
240
+ Run verbosely. Default is true.
189
241
 
190
242
  -v, --version
191
243
 
192
- Print version number
244
+ Print version number.
193
245
 
194
246
  -h, --help
195
247
 
196
- Displays Help
248
+ Displays Help.
249
+
250
+ ## REBASED COMMITS
197
251
 
252
+ GitHub pull requests that have been merged whose merge commit SHA has been modified through rebasing, cherry picking, or some other method may be tracked via a special comment on GitHub. Git commit SHAs found in comments on pull requests matching the regular expression `/rebased commit: ([0-9a-f]{40})/i` will be used in place of the original merge SHA when being added to the changelog.
198
253
 
199
254
  ## EXAMPLES
200
255
 
@@ -204,8 +259,8 @@ Written by Petr Korolev sky4winder@gmail.com
204
259
 
205
260
  ## REPORTING BUGS
206
261
 
207
- &lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
262
+ &lt;<https://github.com/github-changelog-generator/github-changelog-generator/issues>&gt;
208
263
 
209
264
  ## SEE ALSO
210
265
 
211
- &lt;<https://github.com/skywinder/github-changelog-generator/>&gt;
266
+ &lt;<https://github.com/github-changelog-generator/github-changelog-generator/>&gt;