gitlab-release-tools 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
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/Manager.html ADDED
@@ -0,0 +1,430 @@
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::Manager
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::Manager";
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 (M)</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>
41
+ &raquo;
42
+ <span class="title">Manager</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::Manager
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::Manager</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/manager.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>This class contains some tools to finish a release.</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="#close_milestones-instance_method" title="#close_milestones (instance method)">#<strong>close_milestones</strong>(version_name, options = {}) &#x21d2; Object </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>Close all the milestones containing the version name.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#define_tag-instance_method" title="#define_tag (instance method)">#<strong>define_tag</strong>(tag_name, changelog, options = {}) &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Create a new tag in the Repo.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ </ul>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="ApiClient.html" title="Gitlab::Release::ApiClient (class)">ApiClient</a></span></h3>
191
+ <p class="inherited"><span class='object_link'><a href="ApiClient.html#initialize-instance_method" title="Gitlab::Release::ApiClient#initialize (method)">#initialize</a></span></p>
192
+ <div id="constructor_details" class="method_details_list">
193
+ <h2>Constructor Details</h2>
194
+
195
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="ApiClient.html#initialize-instance_method" title="Gitlab::Release::ApiClient#initialize (method)">Gitlab::Release::ApiClient</a></span></p>
196
+
197
+ </div>
198
+
199
+
200
+ <div id="instance_method_details" class="method_details_list">
201
+ <h2>Instance Method Details</h2>
202
+
203
+
204
+ <div class="method_details first">
205
+ <h3 class="signature first" id="close_milestones-instance_method">
206
+
207
+ #<strong>close_milestones</strong>(version_name, options = {}) &#x21d2; <tt>Object</tt>
208
+
209
+
210
+
211
+
212
+
213
+ </h3><div class="docstring">
214
+ <div class="discussion">
215
+
216
+ <p>Close all the milestones containing the version name.</p>
217
+
218
+
219
+ </div>
220
+ </div>
221
+ <div class="tags">
222
+ <p class="tag_title">Parameters:</p>
223
+ <ul class="param">
224
+
225
+ <li>
226
+
227
+ <span class='name'>version_name</span>
228
+
229
+
230
+ <span class='type'>(<tt>String</tt>)</span>
231
+
232
+
233
+
234
+ &mdash;
235
+ <div class='inline'>
236
+ <p>Required. The name of the version. (ex: 1.0)</p>
237
+ </div>
238
+
239
+ </li>
240
+
241
+ <li>
242
+
243
+ <span class='name'>[String</span>
244
+
245
+
246
+ <span class='type'>(<tt>Hash</tt>)</span>
247
+
248
+
249
+
250
+ &mdash;
251
+ <div class='inline'>
252
+ <p>a customizable set of options</p>
253
+ </div>
254
+
255
+ </li>
256
+
257
+ </ul>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ </div><table class="source_code">
267
+ <tr>
268
+ <td>
269
+ <pre class="lines">
270
+
271
+
272
+ 30
273
+ 31
274
+ 32
275
+ 33
276
+ 34
277
+ 35
278
+ 36</pre>
279
+ </td>
280
+ <td>
281
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/manager.rb', line 30</span>
282
+
283
+ <span class='kw'>def</span> <span class='id identifier rubyid_close_milestones'>close_milestones</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>
284
+ <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>
285
+
286
+ <span class='id identifier rubyid_select_milestones'>select_milestones</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version_name'>version_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_milestone'>milestone</span><span class='op'>|</span>
287
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_edit_milestone'>edit_milestone</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span> <span class='id identifier rubyid_milestone'>milestone</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>state_event:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>close</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
288
+ <span class='kw'>end</span>
289
+ <span class='kw'>end</span></pre>
290
+ </td>
291
+ </tr>
292
+ </table>
293
+ </div>
294
+
295
+ <div class="method_details ">
296
+ <h3 class="signature " id="define_tag-instance_method">
297
+
298
+ #<strong>define_tag</strong>(tag_name, changelog, options = {}) &#x21d2; <tt>Object</tt>
299
+
300
+
301
+
302
+
303
+
304
+ </h3><div class="docstring">
305
+ <div class="discussion">
306
+
307
+ <p>Create a new tag in the Repo.</p>
308
+
309
+
310
+ </div>
311
+ </div>
312
+ <div class="tags">
313
+ <p class="tag_title">Parameters:</p>
314
+ <ul class="param">
315
+
316
+ <li>
317
+
318
+ <span class='name'>tag_name</span>
319
+
320
+
321
+ <span class='type'>(<tt>String</tt>)</span>
322
+
323
+
324
+
325
+ &mdash;
326
+ <div class='inline'>
327
+ <p>Required. The name of the tag. (ex: 1.0)</p>
328
+ </div>
329
+
330
+ </li>
331
+
332
+ <li>
333
+
334
+ <span class='name'>changelog</span>
335
+
336
+
337
+ <span class='type'>(<tt>String</tt>)</span>
338
+
339
+
340
+
341
+ &mdash;
342
+ <div class='inline'>
343
+ <p>Optional. The release notes related to the tag.</p>
344
+ </div>
345
+
346
+ </li>
347
+
348
+ <li>
349
+
350
+ <span class='name'>[String</span>
351
+
352
+
353
+ <span class='type'>(<tt>Hash</tt>)</span>
354
+
355
+
356
+
357
+ &mdash;
358
+ <div class='inline'>
359
+ <p>a customizable set of options</p>
360
+ </div>
361
+
362
+ </li>
363
+
364
+ <li>
365
+
366
+ <span class='name'>[String]</span>
367
+
368
+
369
+ <span class='type'>(<tt>Hash</tt>)</span>
370
+
371
+
372
+
373
+ &mdash;
374
+ <div class='inline'>
375
+ <p>a customizable set of options</p>
376
+ </div>
377
+
378
+ </li>
379
+
380
+ </ul>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 17
398
+ 18
399
+ 19
400
+ 20
401
+ 21
402
+ 22</pre>
403
+ </td>
404
+ <td>
405
+ <pre class="code"><span class="info file"># File 'lib/gitlab/release/manager.rb', line 17</span>
406
+
407
+ <span class='kw'>def</span> <span class='id identifier rubyid_define_tag'>define_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_tag_name'>tag_name</span><span class='comma'>,</span> <span class='id identifier rubyid_changelog'>changelog</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>
408
+ <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>
409
+ <span class='id identifier rubyid_ref'>ref</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ref</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_COMMIT_SHA</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
410
+
411
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_tag'>create_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_project_id'>project_id</span><span class='comma'>,</span> <span class='id identifier rubyid_tag_name'>tag_name</span><span class='comma'>,</span> <span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_changelog'>changelog</span><span class='rparen'>)</span>
412
+ <span class='kw'>end</span></pre>
413
+ </td>
414
+ </tr>
415
+ </table>
416
+ </div>
417
+
418
+ </div>
419
+
420
+ </div>
421
+
422
+ <div id="footer">
423
+ Generated on Fri Nov 29 14:42:42 2019 by
424
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
425
+ 0.9.20 (ruby-2.4.6).
426
+ </div>
427
+
428
+ </div>
429
+ </body>
430
+ </html>
data/doc/_index.html ADDED
@@ -0,0 +1,218 @@
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
+ Documentation by YARD 0.9.20
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ pathId = null;
17
+ relpath = '';
18
+ </script>
19
+
20
+
21
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
24
+
25
+
26
+ </head>
27
+ <body>
28
+ <div class="nav_wrap">
29
+ <iframe id="nav" src="class_list.html?1"></iframe>
30
+ <div id="resizer"></div>
31
+ </div>
32
+
33
+ <div id="main" tabindex="-1">
34
+ <div id="header">
35
+ <div id="menu">
36
+
37
+ </div>
38
+
39
+ <div id="search">
40
+
41
+ <a class="full_list_link" id="class_list_link"
42
+ href="class_list.html">
43
+
44
+ <svg width="24" height="24">
45
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
46
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
47
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
48
+ </svg>
49
+ </a>
50
+
51
+ </div>
52
+ <div class="clear"></div>
53
+ </div>
54
+
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.20</h1>
56
+ <div id="listing">
57
+ <h1 class="alphaindex">Alphabetic Index</h1>
58
+
59
+ <h2>File Listing</h2>
60
+ <ul id="files" class="index_inline_list">
61
+
62
+
63
+ <li class="r1"><a href="index.html" title="README">README</a></li>
64
+
65
+
66
+ </ul>
67
+
68
+ <div class="clear"></div>
69
+ <h2>Namespace Listing A-Z</h2>
70
+
71
+
72
+
73
+
74
+ <table>
75
+ <tr>
76
+ <td valign='top' width="33%">
77
+
78
+
79
+ <ul id="alpha_A" class="alpha">
80
+ <li class="letter">A</li>
81
+ <ul>
82
+
83
+ <li>
84
+ <span class='object_link'><a href="Gitlab/Release/ApiClient.html" title="Gitlab::Release::ApiClient (class)">ApiClient</a></span>
85
+
86
+ <small>(Gitlab::Release)</small>
87
+
88
+ </li>
89
+
90
+ </ul>
91
+ </ul>
92
+
93
+
94
+ <ul id="alpha_C" class="alpha">
95
+ <li class="letter">C</li>
96
+ <ul>
97
+
98
+ <li>
99
+ <span class='object_link'><a href="Gitlab/Release/Changelog.html" title="Gitlab::Release::Changelog (module)">Changelog</a></span>
100
+
101
+ <small>(Gitlab::Release)</small>
102
+
103
+ </li>
104
+
105
+ </ul>
106
+ </ul>
107
+
108
+
109
+ <ul id="alpha_E" class="alpha">
110
+ <li class="letter">E</li>
111
+ <ul>
112
+
113
+ <li>
114
+ <span class='object_link'><a href="Gitlab/Release/Changelog/Entries.html" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span>
115
+
116
+ <small>(Gitlab::Release::Changelog)</small>
117
+
118
+ </li>
119
+
120
+ <li>
121
+ <span class='object_link'><a href="Gitlab/Release/Changelog/Entry.html" title="Gitlab::Release::Changelog::Entry (class)">Entry</a></span>
122
+
123
+ <small>(Gitlab::Release::Changelog)</small>
124
+
125
+ </li>
126
+
127
+ </ul>
128
+ </ul>
129
+
130
+
131
+ <ul id="alpha_G" class="alpha">
132
+ <li class="letter">G</li>
133
+ <ul>
134
+
135
+ <li>
136
+ <span class='object_link'><a href="Gitlab/Release/Changelog/Generator.html" title="Gitlab::Release::Changelog::Generator (class)">Generator</a></span>
137
+
138
+ <small>(Gitlab::Release::Changelog)</small>
139
+
140
+ </li>
141
+
142
+ <li>
143
+ <span class='object_link'><a href="Gitlab.html" title="Gitlab (module)">Gitlab</a></span>
144
+
145
+ </li>
146
+
147
+ </ul>
148
+ </ul>
149
+
150
+
151
+ <ul id="alpha_I" class="alpha">
152
+ <li class="letter">I</li>
153
+ <ul>
154
+
155
+ <li>
156
+ <span class='object_link'><a href="Gitlab/Release/Changelog/Issue.html" title="Gitlab::Release::Changelog::Issue (class)">Issue</a></span>
157
+
158
+ <small>(Gitlab::Release::Changelog)</small>
159
+
160
+ </li>
161
+
162
+ </ul>
163
+ </ul>
164
+
165
+
166
+ <ul id="alpha_M" class="alpha">
167
+ <li class="letter">M</li>
168
+ <ul>
169
+
170
+ <li>
171
+ <span class='object_link'><a href="Gitlab/Release/Manager.html" title="Gitlab::Release::Manager (class)">Manager</a></span>
172
+
173
+ <small>(Gitlab::Release)</small>
174
+
175
+ </li>
176
+
177
+ <li>
178
+ <span class='object_link'><a href="Gitlab/Release/Changelog/MergeRequest.html" title="Gitlab::Release::Changelog::MergeRequest (class)">MergeRequest</a></span>
179
+
180
+ <small>(Gitlab::Release::Changelog)</small>
181
+
182
+ </li>
183
+
184
+ </ul>
185
+ </ul>
186
+
187
+
188
+ <ul id="alpha_R" class="alpha">
189
+ <li class="letter">R</li>
190
+ <ul>
191
+
192
+ <li>
193
+ <span class='object_link'><a href="Gitlab/Release.html" title="Gitlab::Release (module)">Release</a></span>
194
+
195
+ <small>(Gitlab)</small>
196
+
197
+ </li>
198
+
199
+ </ul>
200
+ </ul>
201
+
202
+ </td>
203
+ </tr>
204
+ </table>
205
+
206
+ </div>
207
+
208
+ </div>
209
+
210
+ <div id="footer">
211
+ Generated on Fri Nov 29 14:42:41 2019 by
212
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
213
+ 0.9.20 (ruby-2.4.6).
214
+ </div>
215
+
216
+ </div>
217
+ </body>
218
+ </html>