gitlab-release-tools 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/CHANGELOG.md +3 -0
  4. data/Gemfile.lock +1 -1
  5. data/doc/Gitlab.html +117 -0
  6. data/doc/Gitlab/Release.html +135 -0
  7. data/doc/Gitlab/Release/ApiClient.html +213 -0
  8. data/doc/Gitlab/Release/Changelog.html +117 -0
  9. data/doc/Gitlab/Release/Changelog/Entries.html +603 -0
  10. data/doc/Gitlab/Release/Changelog/Entry.html +556 -0
  11. data/doc/Gitlab/Release/Changelog/Generator.html +462 -0
  12. data/doc/Gitlab/Release/Changelog/Issue.html +225 -0
  13. data/doc/Gitlab/Release/Changelog/MergeRequest.html +225 -0
  14. data/doc/Gitlab/Release/Manager.html +430 -0
  15. data/doc/_index.html +218 -0
  16. data/doc/class_list.html +51 -0
  17. data/doc/css/common.css +1 -0
  18. data/doc/css/full_list.css +58 -0
  19. data/doc/css/style.css +496 -0
  20. data/doc/file.README.html +135 -0
  21. data/doc/file_list.html +56 -0
  22. data/doc/frames.html +17 -0
  23. data/doc/index.html +135 -0
  24. data/doc/js/app.js +303 -0
  25. data/doc/js/full_list.js +216 -0
  26. data/doc/js/jquery.js +4 -0
  27. data/doc/method_list.html +187 -0
  28. data/doc/top-level-namespace.html +110 -0
  29. data/lib/gitlab/release/version.rb +1 -1
  30. metadata +27 -3
data/doc/Gitlab/Release/Changelog/Generator.html ADDED
@@ -0,0 +1,462 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Gitlab::Release::Changelog::Generator
8
+
9
+ &mdash; Documentation by YARD 0.9.20
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Gitlab::Release::Changelog::Generator";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (G)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Release.html" title="Gitlab::Release (module)">Release</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Changelog.html" title="Gitlab::Release::Changelog (module)">Changelog</a></span></span>
41
+ &raquo;
42
+ <span class="title">Generator</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Gitlab::Release::Changelog::Generator
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="../ApiClient.html" title="Gitlab::Release::ApiClient (class)">ApiClient</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="../ApiClient.html" title="Gitlab::Release::ApiClient (class)">ApiClient</a></span></li>
78
+
79
+ <li class="next">Gitlab::Release::Changelog::Generator</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/gitlab/release/changelog/generator.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>This class generates the changelog entries</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <h2>
124
+ Instance Method Summary
125
+ <small><a href="#" class="summary_toggle">collapse</a></small>
126
+ </h2>
127
+
128
+ <ul class="summary">
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#changelog-instance_method" title="#changelog (instance method)">#<strong>changelog</strong>(version_name, options = {}) &#x21d2; Entries </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Generate the changelog.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) &#x21d2; Generator </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+ <span class="note title constructor">constructor</span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>A new instance of Generator.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ </ul>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <div id="constructor_details" class="method_details_list">
190
+ <h2>Constructor Details</h2>
191
+
192
+ <div class="method_details first">
193
+ <h3 class="signature first" id="initialize-instance_method">
194
+
195
+ #<strong>initialize</strong>(options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Gitlab::Release::Changelog::Generator (class)">Generator</a></span></tt>
196
+
197
+
198
+
199
+
200
+
201
+ </h3><div class="docstring">
202
+ <div class="discussion">
203
+
204
+ <p>Returns a new instance of Generator</p>
205
+
206
+
207
+ </div>
208
+ </div>
209
+ <div class="tags">
210
+ <p class="tag_title">Parameters:</p>
211
+ <ul class="param">
212
+
213
+ <li>
214
+
215
+ <span class='name'>[String]</span>
216
+
217
+
218
+ <span class='type'>(<tt>Hash</tt>)</span>
219
+
220
+
221
+
222
+ &mdash;
223
+ <div class='inline'>
224
+ <p>a customizable set of options</p>
225
+ </div>
226
+
227
+ </li>
228
+
229
+ <li>
230
+
231
+ <span class='name'>[Integer]</span>
232
+
233
+
234
+ <span class='type'>(<tt>Hash</tt>)</span>
235
+
236
+
237
+
238
+ &mdash;
239
+ <div class='inline'>
240
+ <p>a customizable set of options</p>
241
+ </div>
242
+
243
+ </li>
244
+
245
+ </ul>
246
+
247
+
248
+
249
+
250
+
251
+
252
+ </div><table class="source_code">
253
+ <tr>
254
+ <td>
255
+ <pre class="lines">
256
+
257
+
258
+ 19
259
+ 20
260
+ 21
261
+ 22
262
+ 23</pre>
263
+ </td>
264
+ <td>
265
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/generator.rb', line 19</span>
266
+
267
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
268
+ <span class='ivar'>@max_loops_merge_requests</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:max_loops_merge_requests</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>2000</span>
269
+ <span class='ivar'>@max_loop_issues</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:max_loop_issues</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>2000</span>
270
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
271
+ <span class='kw'>end</span></pre>
272
+ </td>
273
+ </tr>
274
+ </table>
275
+ </div>
276
+
277
+ </div>
278
+
279
+
280
+ <div id="instance_method_details" class="method_details_list">
281
+ <h2>Instance Method Details</h2>
282
+
283
+
284
+ <div class="method_details first">
285
+ <h3 class="signature first" id="changelog-instance_method">
286
+
287
+ #<strong>changelog</strong>(version_name, options = {}) &#x21d2; <tt><span class='object_link'><a href="Entries.html" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span></tt>
288
+
289
+
290
+
291
+
292
+
293
+ </h3><div class="docstring">
294
+ <div class="discussion">
295
+
296
+ <p>Generate the changelog.</p>
297
+
298
+
299
+ </div>
300
+ </div>
301
+ <div class="tags">
302
+ <p class="tag_title">Parameters:</p>
303
+ <ul class="param">
304
+
305
+ <li>
306
+
307
+ <span class='name'>version_name</span>
308
+
309
+
310
+ <span class='type'>(<tt>String</tt>)</span>
311
+
312
+
313
+
314
+ &mdash;
315
+ <div class='inline'>
316
+ <p>Required. The name of the version. (ex: 1.0)</p>
317
+ </div>
318
+
319
+ </li>
320
+
321
+ <li>
322
+
323
+ <span class='name'>[String</span>
324
+
325
+
326
+ <span class='type'>(<tt>Hash</tt>)</span>
327
+
328
+
329
+
330
+ &mdash;
331
+ <div class='inline'>
332
+ <p>a customizable set of options</p>
333
+ </div>
334
+
335
+ </li>
336
+
337
+ <li>
338
+
339
+ <span class='name'>[Boolean]</span>
340
+
341
+
342
+ <span class='type'>(<tt>Hash</tt>)</span>
343
+
344
+
345
+
346
+ &mdash;
347
+ <div class='inline'>
348
+ <p>a customizable set of options</p>
349
+ </div>
350
+
351
+ </li>
352
+
353
+ <li>
354
+
355
+ <span class='name'>[Array[String]]</span>
356
+
357
+
358
+ <span class='type'>(<tt>Hash</tt>)</span>
359
+
360
+
361
+
362
+ &mdash;
363
+ <div class='inline'>
364
+ <p>a customizable set of options</p>
365
+ </div>
366
+
367
+ </li>
368
+
369
+ </ul>
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ <p class="tag_title">Returns:</p>
378
+ <ul class="return">
379
+
380
+ <li>
381
+
382
+
383
+ <span class='type'>(<tt><span class='object_link'><a href="Entries.html" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span></tt>)</span>
384
+
385
+
386
+
387
+ </li>
388
+
389
+ </ul>
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 37
398
+ 38
399
+ 39
400
+ 40
401
+ 41
402
+ 42
403
+ 43
404
+ 44
405
+ 45
406
+ 46
407
+ 47
408
+ 48
409
+ 49
410
+ 50
411
+ 51
412
+ 52
413
+ 53
414
+ 54
415
+ 55
416
+ 56
417
+ 57
418
+ 58</pre>
419
+ </td>
420
+ <td>
421
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/generator.rb', line 37</span>
422
+
423
+ <span class='kw'>def</span> <span class='id identifier rubyid_changelog'>changelog</span><span class='lparen'>(</span><span class='id identifier rubyid_version_name'>version_name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
424
+ <span class='id identifier rubyid_project_id'>project_id</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:project_id</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CI_PROJECT_ID</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
425
+ <span class='id identifier rubyid_include_mrs'>include_mrs</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_mrs</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>true</span>
426
+ <span class='id identifier rubyid_include_issues'>include_issues</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_issues</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>false</span>
427
+ <span class='id identifier rubyid_filtering_mrs_labels'>filtering_mrs_labels</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:filtering_mrs_labels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:filtering_labels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
428
+ <span class='id identifier rubyid_filtering_issue_labels'>filtering_issue_labels</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:filtering_issues_labels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:filtering_labels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
429
+
430
+ <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Entries.html" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entries.html#initialize-instance_method" title="Gitlab::Release::Changelog::Entries#initialize (method)">new</a></span></span>
431
+ <span class='kw'>if</span> <span class='id identifier rubyid_include_mrs'>include_mrs</span>
432
+ <span class='id identifier rubyid_changelog_from_merge_requests'>changelog_from_merge_requests</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span>
433
+ <span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span>
434
+ <span class='id identifier rubyid_version_name'>version_name</span><span class='comma'>,</span>
435
+ <span class='id identifier rubyid_filtering_mrs_labels'>filtering_mrs_labels</span><span class='rparen'>)</span>
436
+ <span class='kw'>end</span>
437
+ <span class='kw'>if</span> <span class='id identifier rubyid_include_issues'>include_issues</span>
438
+ <span class='id identifier rubyid_changelog_from_issues'>changelog_from_issues</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span>
439
+ <span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span>
440
+ <span class='id identifier rubyid_version_name'>version_name</span><span class='comma'>,</span>
441
+ <span class='id identifier rubyid_filtering_issue_labels'>filtering_issue_labels</span><span class='rparen'>)</span>
442
+ <span class='kw'>end</span>
443
+ <span class='id identifier rubyid_entries'>entries</span>
444
+ <span class='kw'>end</span></pre>
445
+ </td>
446
+ </tr>
447
+ </table>
448
+ </div>
449
+
450
+ </div>
451
+
452
+ </div>
453
+
454
+ <div id="footer">
455
+ Generated on Fri Nov 29 14:42:42 2019 by
456
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
457
+ 0.9.20 (ruby-2.4.6).
458
+ </div>
459
+
460
+ </div>
461
+ </body>
462
+ </html>