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.
Files changed (62) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +332 -285
  4. data/Rakefile +1 -1
  5. data/bin/git-generate-changelog +1 -1
  6. data/lib/github_changelog_generator.rb +10 -6
  7. data/lib/github_changelog_generator/generator/entry.rb +218 -0
  8. data/lib/github_changelog_generator/generator/generator.rb +124 -125
  9. data/lib/github_changelog_generator/generator/generator_fetcher.rb +139 -23
  10. data/lib/github_changelog_generator/generator/generator_processor.rb +59 -27
  11. data/lib/github_changelog_generator/generator/generator_tags.rb +25 -21
  12. data/lib/github_changelog_generator/generator/section.rb +124 -0
  13. data/lib/github_changelog_generator/helper.rb +1 -1
  14. data/lib/github_changelog_generator/octo_fetcher.rb +233 -96
  15. data/lib/github_changelog_generator/options.rb +74 -2
  16. data/lib/github_changelog_generator/parser.rb +118 -74
  17. data/lib/github_changelog_generator/parser_file.rb +7 -3
  18. data/lib/github_changelog_generator/reader.rb +2 -2
  19. data/lib/github_changelog_generator/task.rb +4 -3
  20. data/lib/github_changelog_generator/version.rb +1 -1
  21. data/man/git-generate-changelog.1 +144 -45
  22. data/man/git-generate-changelog.1.html +157 -84
  23. data/man/git-generate-changelog.html +19 -7
  24. data/man/git-generate-changelog.md +151 -84
  25. data/spec/files/github-changelog-generator.md +114 -114
  26. data/spec/{install-gem-in-bundler.gemfile → install_gem_in_bundler.gemfile} +2 -0
  27. data/spec/spec_helper.rb +2 -6
  28. data/spec/unit/generator/entry_spec.rb +766 -0
  29. data/spec/unit/generator/generator_processor_spec.rb +103 -41
  30. data/spec/unit/generator/generator_spec.rb +47 -0
  31. data/spec/unit/generator/generator_tags_spec.rb +51 -24
  32. data/spec/unit/generator/section_spec.rb +34 -0
  33. data/spec/unit/octo_fetcher_spec.rb +247 -197
  34. data/spec/unit/options_spec.rb +24 -0
  35. data/spec/unit/parse_file_spec.rb +2 -2
  36. data/spec/unit/reader_spec.rb +4 -4
  37. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_commits/when_API_is_valid/returns_commits.json +1 -0
  38. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_commits_before/when_API_is_valid/returns_commits.json +1 -1
  39. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid.json +1 -1
  40. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issue_with_proper_key/values.json +1 -1
  41. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issues.json +1 -1
  42. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_issues_with_labels.json +1 -1
  43. 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
  44. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_issues_and_pr/when_API_call_is_valid/returns_pull_requests_with_labels.json +1 -1
  45. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid.json +1 -1
  46. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid/returns_correct_pull_request_keys.json +1 -1
  47. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_closed_pull_requests/when_API_call_is_valid/returns_pull_requests.json +1 -1
  48. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_commit/when_API_call_is_valid.json +1 -1
  49. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_commit/when_API_call_is_valid/returns_commit.json +1 -1
  50. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_date_of_tag/when_API_call_is_valid.json +1 -1
  51. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_date_of_tag/when_API_call_is_valid/returns_date.json +1 -1
  52. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid.json +1 -1
  53. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid/populates_issues.json +1 -1
  54. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid.json +1 -1
  55. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid/should_return_tags.json +1 -1
  56. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_API_call_is_valid/should_return_tags_count.json +1 -1
  57. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided.json +1 -1
  58. data/spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided/should_raise_Unauthorized_error.json +1 -1
  59. metadata +71 -38
  60. data/bin/ghclgen +0 -5
  61. data/lib/github_changelog_generator/generator/generator_generation.rb +0 -180
  62. data/spec/unit/generator/generator_generation_spec.rb +0 -73
@@ -31,6 +31,7 @@ module GitHubChangelogGenerator
31
31
  # Sets options using configuration file content
32
32
  def parse!
33
33
  return unless @file
34
+
34
35
  @file.each_with_index { |line, i| parse_line!(line, i + 1) }
35
36
  @file.close
36
37
  end
@@ -46,6 +47,7 @@ module GitHubChangelogGenerator
46
47
 
47
48
  def parse_line!(line, line_number)
48
49
  return if non_configuration_line?(line)
50
+
49
51
  option_name, value = extract_pair(line)
50
52
  @options[option_key_for(option_name)] = convert_value(value, option_name)
51
53
  rescue StandardError
@@ -54,7 +56,7 @@ module GitHubChangelogGenerator
54
56
 
55
57
  # Returns true if the line starts with a pound sign or a semi-colon.
56
58
  def non_configuration_line?(line)
57
- line =~ /^[\#;]/ || line =~ /^[\s]+$/
59
+ line =~ /^[\#;]/ || line =~ /^\s+$/
58
60
  end
59
61
 
60
62
  # Returns a the option name as a symbol and its string value sans newlines.
@@ -66,8 +68,10 @@ module GitHubChangelogGenerator
66
68
  [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
67
69
  end
68
70
 
69
- KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
70
- enhancement_labels breaking_labels issue_line_labels between_tags exclude_tags]
71
+ KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels
72
+ summary_labels breaking_labels enhancement_labels bug_labels
73
+ deprecated_labels removed_labels security_labels
74
+ issue_line_labels between_tags exclude_tags]
71
75
  KNOWN_INTEGER_KEYS = [:max_issues]
72
76
 
73
77
  def convert_value(value, option_name)
@@ -29,8 +29,8 @@ module GitHubChangelogGenerator
29
29
  defaults = {
30
30
  heading_level: "##",
31
31
  heading_structures: [
32
- /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
33
- /^## (?<version>.+?)( \((?<date>.+?)\))?$/
32
+ /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
33
+ /^## (?<version>.+?)( \((?<date>.+?)\))?$/ # rubocop:disable Lint/MixedRegexpCaptureTypes
34
34
  ]
35
35
  }
36
36
 
@@ -15,11 +15,11 @@ module GitHubChangelogGenerator
15
15
  pulls filter_issues_by_milestone author
16
16
  unreleased_only unreleased unreleased_label
17
17
  compare_link include_labels exclude_labels
18
- bug_labels enhancement_labels
18
+ bug_labels enhancement_labels include_tags_regex
19
19
  between_tags exclude_tags exclude_tags_regex since_tag max_issues
20
20
  github_site github_endpoint simple_list
21
21
  future_release release_branch verbose release_url
22
- base ]
22
+ base configure_sections add_sections http_cache]
23
23
 
24
24
  OPTIONS.each do |o|
25
25
  attr_accessor o.to_sym
@@ -31,13 +31,14 @@ module GitHubChangelogGenerator
31
31
  #
32
32
  # GitHubChangelogGenerator::RakeTask.new
33
33
  def initialize(*args, &task_block)
34
+ super()
34
35
  @name = args.shift || :changelog
35
36
 
36
37
  define(args, &task_block)
37
38
  end
38
39
 
39
40
  def define(args, &task_block)
40
- desc "Generate a Change log from GitHub"
41
+ desc "Generate a Changelog from GitHub"
41
42
 
42
43
  yield(*[self, args].slice(0, task_block.arity)) if task_block
43
44
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module GitHubChangelogGenerator
4
- VERSION = "1.15.0-beta"
4
+ VERSION = "1.16.1"
5
5
  end
@@ -1,28 +1,28 @@
1
1
  .\" generated with Ronn/v0.7.3
2
2
  .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
3
  .
4
- .TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
4
+ .TH "GIT\-GENERATE\-CHANGELOG" "1" "May 2020" "" ""
5
5
  .
6
6
  .SH "NAME"
7
- \fBgit\-generate\-changelog\fR \- Generate changelog from github
7
+ \fBgit\-generate\-changelog\fR \- Generate changelog from GitHub
8
8
  .
9
9
  .SH "SYNOPSIS"
10
10
  \fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
11
11
  .
12
12
  .SH "DESCRIPTION"
13
- Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
13
+ Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
14
14
  .
15
15
  .SH "OPTIONS"
16
16
  \-u, \-\-user [USER]
17
17
  .
18
18
  .P
19
- Username of the owner of target GitHub repo
19
+ Username of the owner of target GitHub repo\.
20
20
  .
21
21
  .P
22
22
  \-p, \-\-project [PROJECT]
23
23
  .
24
24
  .P
25
- Name of project on GitHub
25
+ Name of project on GitHub\.
26
26
  .
27
27
  .P
28
28
  \-t, \-\-token [TOKEN]
@@ -34,13 +34,13 @@ To make more than 50 requests per hour your GitHub token is required\. You can g
34
34
  \-f, \-\-date\-format [FORMAT]
35
35
  .
36
36
  .P
37
- Date format\. Default is %Y\-%m\-%d
37
+ Date format\. Default is %Y\-%m\-%d\.
38
38
  .
39
39
  .P
40
40
  \-o, \-\-output [NAME]
41
41
  .
42
42
  .P
43
- Output file\. Default is CHANGELOG\.md
43
+ Output file\. To print to STDOUT instead, use blank as path\. Default is CHANGELOG\.md\.
44
44
  .
45
45
  .P
46
46
  \-b, \-\-base [NAME]
@@ -49,76 +49,124 @@ Output file\. Default is CHANGELOG\.md
49
49
  Optional base file to append generated changes to\.
50
50
  .
51
51
  .P
52
- \-\-bugs\-label [LABEL]
52
+ \-\-summary\-label [LABEL]
53
+ .
54
+ .P
55
+ Set up custom label for the release summary section\. Default is ""\.
56
+ .
57
+ .P
58
+ \-\-breaking\-label [LABEL]
53
59
  .
54
60
  .P
55
- Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
61
+ Set up custom label for breaking changes section\. Default is "\fBBreaking changes:\fR"\.
56
62
  .
57
63
  .P
58
64
  \-\-enhancement\-label [LABEL]
59
65
  .
60
66
  .P
61
- Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
67
+ Set up custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"\.
68
+ .
69
+ .P
70
+ \-\-bugs\-label [LABEL]
71
+ .
72
+ .P
73
+ Set up custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR"\.
74
+ .
75
+ .P
76
+ \-\-deprecated\-label [LABEL]
77
+ .
78
+ .P
79
+ Set up custom label for deprecated section\. Default is "\fBDeprecated:\fR"\.
80
+ .
81
+ .P
82
+ \-\-removed\-label [LABEL]
83
+ .
84
+ .P
85
+ Set up custom label for removed section\. Default is "\fBRemoved:\fR"\.
86
+ .
87
+ .P
88
+ \-\-security\-label [LABEL]
89
+ .
90
+ .P
91
+ Set up custom label for security section\. Default is "\fBSecurity:\fR"\.
62
92
  .
63
93
  .P
64
94
  \-\-issues\-label [LABEL]
65
95
  .
66
96
  .P
67
- Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
97
+ Set up custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"\.
68
98
  .
69
99
  .P
70
100
  \-\-header\-label [LABEL]
71
101
  .
72
102
  .P
73
- Setup custom header label\. Default is "# Change Log"
103
+ Set up custom header label\. Default is "# Changelog"\.
104
+ .
105
+ .P
106
+ \-\-configure\-sections [HASH, STRING]
107
+ .
108
+ .P
109
+ Define your own set of sections which overrides all default sections\.
110
+ .
111
+ .P
112
+ \-\-add\-sections [HASH, STRING]
113
+ .
114
+ .P
115
+ Add new sections but keep the default sections\.
74
116
  .
75
117
  .P
76
118
  \-\-front\-matter [JSON]
77
119
  .
78
120
  .P
79
- Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
121
+ Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line\.
80
122
  .
81
123
  .P
82
124
  \-\-pr\-label [LABEL]
83
125
  .
84
126
  .P
85
- Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
127
+ Set up custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"\.
86
128
  .
87
129
  .P
88
130
  \-\-[no\-]issues
89
131
  .
90
132
  .P
91
- Include closed issues in changelog\. Default is true
133
+ Include closed issues in changelog\. Default is true\.
92
134
  .
93
135
  .P
94
136
  \-\-[no\-]issues\-wo\-labels
95
137
  .
96
138
  .P
97
- Include closed issues without labels in changelog\. Default is true
139
+ Include closed issues without labels in changelog\. Default is true\.
98
140
  .
99
141
  .P
100
142
  \-\-[no\-]pr\-wo\-labels
101
143
  .
102
144
  .P
103
- Include pull requests without labels in changelog\. Default is true
145
+ Include pull requests without labels in changelog\. Default is true\.
104
146
  .
105
147
  .P
106
148
  \-\-[no\-]pull\-requests
107
149
  .
108
150
  .P
109
- Include pull\-requests in changelog\. Default is true
151
+ Include pull\-requests in changelog\. Default is true\.
110
152
  .
111
153
  .P
112
154
  \-\-[no\-]filter\-by\-milestone
113
155
  .
114
156
  .P
115
- Use milestone to detect when issue was resolved\. Default is true
157
+ Use milestone to detect when issue was resolved\. Default is true\.
158
+ .
159
+ .P
160
+ \-\-[no\-]issues\-of\-open\-milestones
161
+ .
162
+ .P
163
+ Include issues of open milestones\. Default is true\.
116
164
  .
117
165
  .P
118
166
  \-\-[no\-]author
119
167
  .
120
168
  .P
121
- Add author of pull\-request in the end\. Default is true
169
+ Add author of pull request at the end\. Default is true\.
122
170
  .
123
171
  .P
124
172
  \-\-usernames\-as\-github\-logins
@@ -136,79 +184,115 @@ Generate log from unreleased closed issues only\.
136
184
  \-\-[no\-]unreleased
137
185
  .
138
186
  .P
139
- Add to log unreleased closed issues\. Default is true
187
+ Add to log unreleased closed issues\. Default is true\.
140
188
  .
141
189
  .P
142
190
  \-\-unreleased\-label [label]
143
191
  .
144
192
  .P
145
- Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
193
+ Set up custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"\.
146
194
  .
147
195
  .P
148
196
  \-\-[no\-]compare\-link
149
197
  .
150
198
  .P
151
- Include compare link (Full Changelog) between older version and newer version\. Default is true
199
+ Include compare link (Full Changelog) between older version and newer version\. Default is true\.
152
200
  .
153
201
  .P
154
202
  \-\-include\-labels x,y,z
155
203
  .
156
204
  .P
157
- Only issues with the specified labels will be included in the changelog\.
205
+ Of the labeled issues, only include the ones with the specified labels\.
158
206
  .
159
207
  .P
160
208
  \-\-exclude\-labels x,y,z
161
209
  .
162
210
  .P
163
- Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
211
+ Issues with the specified labels will be excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'\.
164
212
  .
165
213
  .P
166
- \-\-bug\-labels x,y,z
214
+ \-\-summary\-labels x,y,z
167
215
  .
168
216
  .P
169
- Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
217
+ 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\'\.
218
+ .
219
+ .P
220
+ \-\-breaking\-labels x,y,z
221
+ .
222
+ .P
223
+ Issues with these labels will be added to a new section, called "Breaking changes"\. Default is \'backwards\-incompatible,breaking\'\.
170
224
  .
171
225
  .P
172
226
  \-\-enhancement\-labels x,y,z
173
227
  .
174
228
  .P
175
- Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
229
+ Issues with the specified labels will be added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'\.
230
+ .
231
+ .P
232
+ \-\-bug\-labels x,y,z
233
+ .
234
+ .P
235
+ Issues with the specified labels will be added to "Fixed bugs" section\. Default is \'bug,Bug\'\.
236
+ .
237
+ .P
238
+ \-\-deprecated\-labels x,y,z
239
+ .
240
+ .P
241
+ Issues with the specified labels will be added to a section called "Deprecated"\. Default is \'deprecated,Deprecated\'\.
242
+ .
243
+ .P
244
+ \-\-removed\-labels x,y,z
245
+ .
246
+ .P
247
+ Issues with the specified labels will be added to a section called "Removed"\. Default is \'removed,Removed\'\.
176
248
  .
177
249
  .P
178
- \-\-between\-tags x,y,z
250
+ \-\-security\-labels x,y,z
179
251
  .
180
252
  .P
181
- Change log will be filled only between specified tags
253
+ Issues with the specified labels will be added to a section called "Security fixes"\. Default is \'security,Security\'\.
254
+ .
255
+ .P
256
+ \-\-issue\-line\-labels x,y,z
257
+ .
258
+ .P
259
+ The specified labels will be shown in brackets next to each matching issue\. Use "ALL" to show all labels\. Default is []\.
182
260
  .
183
261
  .P
184
262
  \-\-exclude\-tags x,y,z
185
263
  .
186
264
  .P
187
- Change log will exclude specified tags
265
+ Changelog will exclude specified tags\.
188
266
  .
189
267
  .P
190
268
  \-\-exclude\-tags\-regex [REGEX]
191
269
  .
192
270
  .P
193
- Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"
271
+ Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"\.
194
272
  .
195
273
  .P
196
274
  \-\-since\-tag x
197
275
  .
198
276
  .P
199
- Change log will start after specified tag
277
+ Changelog will start after specified tag\.
200
278
  .
201
279
  .P
202
280
  \-\-due\-tag x
203
281
  .
204
282
  .P
205
- Change log will end before specified tag
283
+ Changelog will end before specified tag\.
284
+ .
285
+ .P
286
+ \-\-since\-commit x
287
+ .
288
+ .P
289
+ Fetch only commits after this time\. eg\. "2017\-01\-01 10:00:00"
206
290
  .
207
291
  .P
208
292
  \-\-max\-issues [NUMBER]
209
293
  .
210
294
  .P
211
- Max number of issues to fetch from GitHub\. Default is unlimited
295
+ Maximum number of issues to fetch from GitHub\. Default is unlimited\.
212
296
  .
213
297
  .P
214
298
  \-\-release\-url [URL]
@@ -220,19 +304,19 @@ The URL to point to for release links, in printf format (with the tag as variabl
220
304
  \-\-github\-site [URL]
221
305
  .
222
306
  .P
223
- The Enterprise Github site on which your project is hosted\.
307
+ The Enterprise GitHub site where your project is hosted\.
224
308
  .
225
309
  .P
226
310
  \-\-github\-api [URL]
227
311
  .
228
312
  .P
229
- The enterprise endpoint to use for your Github API\.
313
+ The enterprise endpoint to use for your GitHub API\.
230
314
  .
231
315
  .P
232
316
  \-\-simple\-list
233
317
  .
234
318
  .P
235
- Create simple list from issues and pull requests\. Default is false\.
319
+ Create a simple list from issues and pull requests\. Default is false\.
236
320
  .
237
321
  .P
238
322
  \-\-future\-release [RELEASE\-VERSION]
@@ -244,13 +328,13 @@ Put the unreleased changes in the specified release number\.
244
328
  \-\-release\-branch [RELEASE\-BRANCH]
245
329
  .
246
330
  .P
247
- Limit pull requests to the release branch, such as master or release
331
+ Limit pull requests to the release branch, such as master or release\.
248
332
  .
249
333
  .P
250
334
  \-\-http\-cache
251
335
  .
252
336
  .P
253
- Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
337
+ Use HTTP Cache to cache GitHub API requests (useful for large repos)\. Default is true\.
254
338
  .
255
339
  .P
256
340
  \-\-[no\-]cache\-file [CACHE\-FILE]
@@ -265,22 +349,37 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
265
349
  Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
266
350
  .
267
351
  .P
352
+ \-\-ssl\-ca\-file [PATH]
353
+ .
354
+ .P
355
+ Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
356
+ .
357
+ .P
358
+ \-\-require file1\.rb,file2\.rb
359
+ .
360
+ .P
361
+ Paths to Ruby file(s) to require before generating changelog\.
362
+ .
363
+ .P
268
364
  \-\-[no\-]verbose
269
365
  .
270
366
  .P
271
- Run verbosely\. Default is true
367
+ Run verbosely\. Default is true\.
272
368
  .
273
369
  .P
274
370
  \-v, \-\-version
275
371
  .
276
372
  .P
277
- Print version number
373
+ Print version number\.
278
374
  .
279
375
  .P
280
376
  \-h, \-\-help
281
377
  .
282
378
  .P
283
- Displays Help
379
+ Displays Help\.
380
+ .
381
+ .SH "REBASED COMMITS"
382
+ 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 \fB/rebased commit: ([0\-9a\-f]{40})/i\fR will be used in place of the original merge SHA when being added to the changelog\.
284
383
  .
285
384
  .SH "EXAMPLES"
286
385
  .
@@ -288,7 +387,7 @@ Displays Help
288
387
  Written by Petr Korolev sky4winder@gmail\.com
289
388
  .
290
389
  .SH "REPORTING BUGS"
291
- <\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
390
+ <\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/issues\fR>
292
391
  .
293
392
  .SH "SEE ALSO"
294
- <\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>
393
+ <\fIhttps://github\.com/github\-changelog\-generator/github\-changelog\-generator/\fR>