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