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/Entry.html ADDED
@@ -0,0 +1,556 @@
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::Entry
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::Entry";
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 (E)</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">Entry</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::Entry
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Gitlab::Release::Changelog::Entry</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/gitlab/release/changelog/entry.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>This class represents a single changelog element.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><div id="subclasses">
114
+ <h2>Direct Known Subclasses</h2>
115
+ <p class="children"><span class='object_link'><a href="Issue.html" title="Gitlab::Release::Changelog::Issue (class)">Issue</a></span>, <span class='object_link'><a href="MergeRequest.html" title="Gitlab::Release::Changelog::MergeRequest (class)">MergeRequest</a></span></p>
116
+ </div>
117
+
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+ <span class="note title readonly">readonly</span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'>
147
+ <p>Returns the value of attribute id.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; Object </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+ <span class="note title readonly">readonly</span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'>
176
+ <p>Returns the value of attribute title.</p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ </ul>
183
+
184
+
185
+
186
+
187
+
188
+ <h2>
189
+ Instance Method Summary
190
+ <small><a href="#" class="summary_toggle">collapse</a></small>
191
+ </h2>
192
+
193
+ <ul class="summary">
194
+
195
+ <li class="public ">
196
+ <span class="summary_signature">
197
+
198
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(id, title) &#x21d2; Entry </a>
199
+
200
+
201
+
202
+ </span>
203
+
204
+
205
+ <span class="note title constructor">constructor</span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <span class="summary_desc"><div class='inline'>
215
+ <p>A new instance of Entry.</p>
216
+ </div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <span class="summary_desc"><div class='inline'></div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#to_s_for_changelog-instance_method" title="#to_s_for_changelog (instance method)">#<strong>to_s_for_changelog</strong>(with_reference) &#x21d2; String </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ <span class="summary_desc"><div class='inline'>
261
+ <p>Print this entry with or without reference.</p>
262
+ </div></span>
263
+
264
+ </li>
265
+
266
+
267
+ </ul>
268
+
269
+
270
+ <div id="constructor_details" class="method_details_list">
271
+ <h2>Constructor Details</h2>
272
+
273
+ <div class="method_details first">
274
+ <h3 class="signature first" id="initialize-instance_method">
275
+
276
+ #<strong>initialize</strong>(id, title) &#x21d2; <tt><span class='object_link'><a href="" title="Gitlab::Release::Changelog::Entry (class)">Entry</a></span></tt>
277
+
278
+
279
+
280
+
281
+
282
+ </h3><div class="docstring">
283
+ <div class="discussion">
284
+
285
+ <p>Returns a new instance of Entry</p>
286
+
287
+
288
+ </div>
289
+ </div>
290
+ <div class="tags">
291
+ <p class="tag_title">Parameters:</p>
292
+ <ul class="param">
293
+
294
+ <li>
295
+
296
+ <span class='name'>id</span>
297
+
298
+
299
+ <span class='type'>(<tt>Integer</tt>)</span>
300
+
301
+
302
+
303
+ </li>
304
+
305
+ <li>
306
+
307
+ <span class='name'>title</span>
308
+
309
+
310
+ <span class='type'>(<tt>String</tt>)</span>
311
+
312
+
313
+
314
+ </li>
315
+
316
+ </ul>
317
+
318
+
319
+ </div><table class="source_code">
320
+ <tr>
321
+ <td>
322
+ <pre class="lines">
323
+
324
+
325
+ 12
326
+ 13
327
+ 14
328
+ 15</pre>
329
+ </td>
330
+ <td>
331
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entry.rb', line 12</span>
332
+
333
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span><span class='rparen'>)</span>
334
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
335
+ <span class='ivar'>@title</span> <span class='op'>=</span> <span class='id identifier rubyid_title'>title</span>
336
+ <span class='kw'>end</span></pre>
337
+ </td>
338
+ </tr>
339
+ </table>
340
+ </div>
341
+
342
+ </div>
343
+
344
+ <div id="instance_attr_details" class="attr_details">
345
+ <h2>Instance Attribute Details</h2>
346
+
347
+
348
+ <span id=""></span>
349
+ <div class="method_details first">
350
+ <h3 class="signature first" id="id-instance_method">
351
+
352
+ #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
353
+
354
+
355
+
356
+
357
+
358
+ </h3><div class="docstring">
359
+ <div class="discussion">
360
+
361
+ <p>Returns the value of attribute id</p>
362
+
363
+
364
+ </div>
365
+ </div>
366
+ <div class="tags">
367
+
368
+
369
+ </div><table class="source_code">
370
+ <tr>
371
+ <td>
372
+ <pre class="lines">
373
+
374
+
375
+ 8
376
+ 9
377
+ 10</pre>
378
+ </td>
379
+ <td>
380
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entry.rb', line 8</span>
381
+
382
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
383
+ <span class='ivar'>@id</span>
384
+ <span class='kw'>end</span></pre>
385
+ </td>
386
+ </tr>
387
+ </table>
388
+ </div>
389
+
390
+
391
+ <span id=""></span>
392
+ <div class="method_details ">
393
+ <h3 class="signature " id="title-instance_method">
394
+
395
+ #<strong>title</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
396
+
397
+
398
+
399
+
400
+
401
+ </h3><div class="docstring">
402
+ <div class="discussion">
403
+
404
+ <p>Returns the value of attribute title</p>
405
+
406
+
407
+ </div>
408
+ </div>
409
+ <div class="tags">
410
+
411
+
412
+ </div><table class="source_code">
413
+ <tr>
414
+ <td>
415
+ <pre class="lines">
416
+
417
+
418
+ 8
419
+ 9
420
+ 10</pre>
421
+ </td>
422
+ <td>
423
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entry.rb', line 8</span>
424
+
425
+ <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
426
+ <span class='ivar'>@title</span>
427
+ <span class='kw'>end</span></pre>
428
+ </td>
429
+ </tr>
430
+ </table>
431
+ </div>
432
+
433
+ </div>
434
+
435
+
436
+ <div id="instance_method_details" class="method_details_list">
437
+ <h2>Instance Method Details</h2>
438
+
439
+
440
+ <div class="method_details first">
441
+ <h3 class="signature first" id="to_s-instance_method">
442
+
443
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
444
+
445
+
446
+
447
+
448
+
449
+ </h3><table class="source_code">
450
+ <tr>
451
+ <td>
452
+ <pre class="lines">
453
+
454
+
455
+ 17
456
+ 18
457
+ 19</pre>
458
+ </td>
459
+ <td>
460
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entry.rb', line 17</span>
461
+
462
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
463
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Changelog::Entry { id: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>, title: &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; }</span><span class='tstring_end'>&quot;</span></span>
464
+ <span class='kw'>end</span></pre>
465
+ </td>
466
+ </tr>
467
+ </table>
468
+ </div>
469
+
470
+ <div class="method_details ">
471
+ <h3 class="signature " id="to_s_for_changelog-instance_method">
472
+
473
+ #<strong>to_s_for_changelog</strong>(with_reference) &#x21d2; <tt>String</tt>
474
+
475
+
476
+
477
+
478
+
479
+ </h3><div class="docstring">
480
+ <div class="discussion">
481
+
482
+ <p>Print this entry with or without reference.</p>
483
+
484
+
485
+ </div>
486
+ </div>
487
+ <div class="tags">
488
+ <p class="tag_title">Parameters:</p>
489
+ <ul class="param">
490
+
491
+ <li>
492
+
493
+ <span class='name'>with_reference</span>
494
+
495
+
496
+ <span class='type'>(<tt>Boolean</tt>)</span>
497
+
498
+
499
+
500
+ &mdash;
501
+ <div class='inline'>
502
+ <p>Required. Generate the changelog with MRs and Issues reference.</p>
503
+ </div>
504
+
505
+ </li>
506
+
507
+ </ul>
508
+
509
+ <p class="tag_title">Returns:</p>
510
+ <ul class="return">
511
+
512
+ <li>
513
+
514
+
515
+ <span class='type'>(<tt>String</tt>)</span>
516
+
517
+
518
+
519
+ </li>
520
+
521
+ </ul>
522
+
523
+ </div><table class="source_code">
524
+ <tr>
525
+ <td>
526
+ <pre class="lines">
527
+
528
+
529
+ 27
530
+ 28
531
+ 29</pre>
532
+ </td>
533
+ <td>
534
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entry.rb', line 27</span>
535
+
536
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s_for_changelog'>to_s_for_changelog</span><span class='lparen'>(</span><span class='id identifier rubyid_with_reference'>with_reference</span><span class='rparen'>)</span>
537
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>- </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_title'>title</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
538
+ <span class='kw'>end</span></pre>
539
+ </td>
540
+ </tr>
541
+ </table>
542
+ </div>
543
+
544
+ </div>
545
+
546
+ </div>
547
+
548
+ <div id="footer">
549
+ Generated on Fri Nov 29 14:42:42 2019 by
550
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
551
+ 0.9.20 (ruby-2.4.6).
552
+ </div>
553
+
554
+ </div>
555
+ </body>
556
+ </html>