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.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/CHANGELOG.md +3 -0
- data/Gemfile.lock +1 -1
- data/doc/Gitlab.html +117 -0
- data/doc/Gitlab/Release.html +135 -0
- data/doc/Gitlab/Release/ApiClient.html +213 -0
- data/doc/Gitlab/Release/Changelog.html +117 -0
- data/doc/Gitlab/Release/Changelog/Entries.html +603 -0
- data/doc/Gitlab/Release/Changelog/Entry.html +556 -0
- data/doc/Gitlab/Release/Changelog/Generator.html +462 -0
- data/doc/Gitlab/Release/Changelog/Issue.html +225 -0
- data/doc/Gitlab/Release/Changelog/MergeRequest.html +225 -0
- data/doc/Gitlab/Release/Manager.html +430 -0
- data/doc/_index.html +218 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +135 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +135 -0
- data/doc/js/app.js +303 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +187 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/gitlab/release/version.rb +1 -1
- metadata +27 -3
@@ -0,0 +1,117 @@
|
|
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
|
+
Module: Gitlab::Release::Changelog
|
8
|
+
|
9
|
+
— 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";
|
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 (C)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span> » <span class='title'><span class='object_link'><a href="../Release.html" title="Gitlab::Release (module)">Release</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Changelog</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>Module: Gitlab::Release::Changelog
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/gitlab/release/changelog/entry.rb<span class="defines">,<br />
|
82
|
+
lib/gitlab/release/changelog/entries.rb,<br /> lib/gitlab/release/changelog/generator.rb</span>
|
83
|
+
</dd>
|
84
|
+
</dl>
|
85
|
+
|
86
|
+
</div>
|
87
|
+
|
88
|
+
<h2>Defined Under Namespace</h2>
|
89
|
+
<p class="children">
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Changelog/Entries.html" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span>, <span class='object_link'><a href="Changelog/Entry.html" title="Gitlab::Release::Changelog::Entry (class)">Entry</a></span>, <span class='object_link'><a href="Changelog/Generator.html" title="Gitlab::Release::Changelog::Generator (class)">Generator</a></span>, <span class='object_link'><a href="Changelog/Issue.html" title="Gitlab::Release::Changelog::Issue (class)">Issue</a></span>, <span class='object_link'><a href="Changelog/MergeRequest.html" title="Gitlab::Release::Changelog::MergeRequest (class)">MergeRequest</a></span>
|
95
|
+
|
96
|
+
|
97
|
+
</p>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
</div>
|
108
|
+
|
109
|
+
<div id="footer">
|
110
|
+
Generated on Fri Nov 29 14:42:42 2019 by
|
111
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
112
|
+
0.9.20 (ruby-2.4.6).
|
113
|
+
</div>
|
114
|
+
|
115
|
+
</div>
|
116
|
+
</body>
|
117
|
+
</html>
|
@@ -0,0 +1,603 @@
|
|
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::Entries
|
8
|
+
|
9
|
+
— 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::Entries";
|
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> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../../Gitlab.html" title="Gitlab (module)">Gitlab</a></span></span> » <span class='title'><span class='object_link'><a href="../../Release.html" title="Gitlab::Release (module)">Release</a></span></span> » <span class='title'><span class='object_link'><a href="../Changelog.html" title="Gitlab::Release::Changelog (module)">Changelog</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Entries</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::Entries
|
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::Entries</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/entries.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>This class is a collection wrapper of changelog items, useful to generate
|
106
|
+
easily changelog as String.</p>
|
107
|
+
|
108
|
+
|
109
|
+
</div>
|
110
|
+
</div>
|
111
|
+
<div class="tags">
|
112
|
+
|
113
|
+
|
114
|
+
</div>
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
<h2>
|
123
|
+
Instance Method Summary
|
124
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
125
|
+
</h2>
|
126
|
+
|
127
|
+
<ul class="summary">
|
128
|
+
|
129
|
+
<li class="public ">
|
130
|
+
<span class="summary_signature">
|
131
|
+
|
132
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Entries </a>
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
</span>
|
137
|
+
|
138
|
+
|
139
|
+
<span class="note title constructor">constructor</span>
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
<span class="summary_desc"><div class='inline'>
|
149
|
+
<p>A new instance of Entries.</p>
|
150
|
+
</div></span>
|
151
|
+
|
152
|
+
</li>
|
153
|
+
|
154
|
+
|
155
|
+
<li class="public ">
|
156
|
+
<span class="summary_signature">
|
157
|
+
|
158
|
+
<a href="#push-instance_method" title="#push (instance method)">#<strong>push</strong>(element) ⇒ Object </a>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
</span>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<span class="summary_desc"><div class='inline'>
|
173
|
+
<p>Add a new Entry element.</p>
|
174
|
+
</div></span>
|
175
|
+
|
176
|
+
</li>
|
177
|
+
|
178
|
+
|
179
|
+
<li class="public ">
|
180
|
+
<span class="summary_signature">
|
181
|
+
|
182
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
</span>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
197
|
+
<p>Print the changelog without any reference.</p>
|
198
|
+
</div></span>
|
199
|
+
|
200
|
+
</li>
|
201
|
+
|
202
|
+
|
203
|
+
<li class="public ">
|
204
|
+
<span class="summary_signature">
|
205
|
+
|
206
|
+
<a href="#to_s_with_reference-instance_method" title="#to_s_with_reference (instance method)">#<strong>to_s_with_reference</strong> ⇒ String </a>
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
</span>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
<span class="summary_desc"><div class='inline'>
|
221
|
+
<p>Print the changelog with relative reference.</p>
|
222
|
+
</div></span>
|
223
|
+
|
224
|
+
</li>
|
225
|
+
|
226
|
+
|
227
|
+
<li class="public ">
|
228
|
+
<span class="summary_signature">
|
229
|
+
|
230
|
+
<a href="#write_in_file-instance_method" title="#write_in_file (instance method)">#<strong>write_in_file</strong>(path, appending = false, with_reference = true) ⇒ Object </a>
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
</span>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
<span class="summary_desc"><div class='inline'>
|
245
|
+
<p>Write the changelog content as String in a file.</p>
|
246
|
+
</div></span>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
|
251
|
+
</ul>
|
252
|
+
|
253
|
+
|
254
|
+
<div id="constructor_details" class="method_details_list">
|
255
|
+
<h2>Constructor Details</h2>
|
256
|
+
|
257
|
+
<div class="method_details first">
|
258
|
+
<h3 class="signature first" id="initialize-instance_method">
|
259
|
+
|
260
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Gitlab::Release::Changelog::Entries (class)">Entries</a></span></tt>
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
</h3><div class="docstring">
|
267
|
+
<div class="discussion">
|
268
|
+
|
269
|
+
<p>Returns a new instance of Entries</p>
|
270
|
+
|
271
|
+
|
272
|
+
</div>
|
273
|
+
</div>
|
274
|
+
<div class="tags">
|
275
|
+
|
276
|
+
|
277
|
+
</div><table class="source_code">
|
278
|
+
<tr>
|
279
|
+
<td>
|
280
|
+
<pre class="lines">
|
281
|
+
|
282
|
+
|
283
|
+
8
|
284
|
+
9
|
285
|
+
10
|
286
|
+
11</pre>
|
287
|
+
</td>
|
288
|
+
<td>
|
289
|
+
<pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entries.rb', line 8</span>
|
290
|
+
|
291
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
292
|
+
<span class='comment'># @type [Array] elements
|
293
|
+
</span> <span class='ivar'>@elements</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
294
|
+
<span class='kw'>end</span></pre>
|
295
|
+
</td>
|
296
|
+
</tr>
|
297
|
+
</table>
|
298
|
+
</div>
|
299
|
+
|
300
|
+
</div>
|
301
|
+
|
302
|
+
|
303
|
+
<div id="instance_method_details" class="method_details_list">
|
304
|
+
<h2>Instance Method Details</h2>
|
305
|
+
|
306
|
+
|
307
|
+
<div class="method_details first">
|
308
|
+
<h3 class="signature first" id="push-instance_method">
|
309
|
+
|
310
|
+
#<strong>push</strong>(element) ⇒ <tt>Object</tt>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
</h3><div class="docstring">
|
317
|
+
<div class="discussion">
|
318
|
+
|
319
|
+
<p>Add a new Entry element.</p>
|
320
|
+
|
321
|
+
|
322
|
+
</div>
|
323
|
+
</div>
|
324
|
+
<div class="tags">
|
325
|
+
<p class="tag_title">Parameters:</p>
|
326
|
+
<ul class="param">
|
327
|
+
|
328
|
+
<li>
|
329
|
+
|
330
|
+
<span class='name'>element</span>
|
331
|
+
|
332
|
+
|
333
|
+
<span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Gitlab::Release::Changelog::Entry (class)">Entry</a></span></tt>)</span>
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
</li>
|
338
|
+
|
339
|
+
</ul>
|
340
|
+
|
341
|
+
|
342
|
+
</div><table class="source_code">
|
343
|
+
<tr>
|
344
|
+
<td>
|
345
|
+
<pre class="lines">
|
346
|
+
|
347
|
+
|
348
|
+
18
|
349
|
+
19
|
350
|
+
20</pre>
|
351
|
+
</td>
|
352
|
+
<td>
|
353
|
+
<pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entries.rb', line 18</span>
|
354
|
+
|
355
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
|
356
|
+
<span class='ivar'>@elements</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
|
357
|
+
<span class='kw'>end</span></pre>
|
358
|
+
</td>
|
359
|
+
</tr>
|
360
|
+
</table>
|
361
|
+
</div>
|
362
|
+
|
363
|
+
<div class="method_details ">
|
364
|
+
<h3 class="signature " id="to_s-instance_method">
|
365
|
+
|
366
|
+
#<strong>to_s</strong> ⇒ <tt>String</tt>
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
</h3><div class="docstring">
|
373
|
+
<div class="discussion">
|
374
|
+
|
375
|
+
<p>Print the changelog without any reference.</p>
|
376
|
+
|
377
|
+
|
378
|
+
</div>
|
379
|
+
</div>
|
380
|
+
<div class="tags">
|
381
|
+
|
382
|
+
<p class="tag_title">Returns:</p>
|
383
|
+
<ul class="return">
|
384
|
+
|
385
|
+
<li>
|
386
|
+
|
387
|
+
|
388
|
+
<span class='type'>(<tt>String</tt>)</span>
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
</li>
|
393
|
+
|
394
|
+
</ul>
|
395
|
+
|
396
|
+
</div><table class="source_code">
|
397
|
+
<tr>
|
398
|
+
<td>
|
399
|
+
<pre class="lines">
|
400
|
+
|
401
|
+
|
402
|
+
27
|
403
|
+
28
|
404
|
+
29</pre>
|
405
|
+
</td>
|
406
|
+
<td>
|
407
|
+
<pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entries.rb', line 27</span>
|
408
|
+
|
409
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
410
|
+
<span class='id identifier rubyid_internal_to_s_with_reference'>internal_to_s_with_reference</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span>
|
411
|
+
<span class='kw'>end</span></pre>
|
412
|
+
</td>
|
413
|
+
</tr>
|
414
|
+
</table>
|
415
|
+
</div>
|
416
|
+
|
417
|
+
<div class="method_details ">
|
418
|
+
<h3 class="signature " id="to_s_with_reference-instance_method">
|
419
|
+
|
420
|
+
#<strong>to_s_with_reference</strong> ⇒ <tt>String</tt>
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
</h3><div class="docstring">
|
427
|
+
<div class="discussion">
|
428
|
+
|
429
|
+
<p>Print the changelog with relative reference.</p>
|
430
|
+
|
431
|
+
|
432
|
+
</div>
|
433
|
+
</div>
|
434
|
+
<div class="tags">
|
435
|
+
|
436
|
+
<p class="tag_title">Returns:</p>
|
437
|
+
<ul class="return">
|
438
|
+
|
439
|
+
<li>
|
440
|
+
|
441
|
+
|
442
|
+
<span class='type'>(<tt>String</tt>)</span>
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
</li>
|
447
|
+
|
448
|
+
</ul>
|
449
|
+
|
450
|
+
</div><table class="source_code">
|
451
|
+
<tr>
|
452
|
+
<td>
|
453
|
+
<pre class="lines">
|
454
|
+
|
455
|
+
|
456
|
+
36
|
457
|
+
37
|
458
|
+
38</pre>
|
459
|
+
</td>
|
460
|
+
<td>
|
461
|
+
<pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entries.rb', line 36</span>
|
462
|
+
|
463
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s_with_reference'>to_s_with_reference</span>
|
464
|
+
<span class='id identifier rubyid_internal_to_s_with_reference'>internal_to_s_with_reference</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
|
465
|
+
<span class='kw'>end</span></pre>
|
466
|
+
</td>
|
467
|
+
</tr>
|
468
|
+
</table>
|
469
|
+
</div>
|
470
|
+
|
471
|
+
<div class="method_details ">
|
472
|
+
<h3 class="signature " id="write_in_file-instance_method">
|
473
|
+
|
474
|
+
#<strong>write_in_file</strong>(path, appending = false, with_reference = true) ⇒ <tt>Object</tt>
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
</h3><div class="docstring">
|
481
|
+
<div class="discussion">
|
482
|
+
|
483
|
+
<p>Write the changelog content as String in a file.</p>
|
484
|
+
|
485
|
+
|
486
|
+
</div>
|
487
|
+
</div>
|
488
|
+
<div class="tags">
|
489
|
+
<p class="tag_title">Parameters:</p>
|
490
|
+
<ul class="param">
|
491
|
+
|
492
|
+
<li>
|
493
|
+
|
494
|
+
<span class='name'>path</span>
|
495
|
+
|
496
|
+
|
497
|
+
<span class='type'>(<tt>String</tt>)</span>
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
—
|
502
|
+
<div class='inline'>
|
503
|
+
<p>Required. path The file path. You can specify a series of file paths with
|
504
|
+
regex.</p>
|
505
|
+
</div>
|
506
|
+
|
507
|
+
</li>
|
508
|
+
|
509
|
+
<li>
|
510
|
+
|
511
|
+
<span class='name'>appending</span>
|
512
|
+
|
513
|
+
|
514
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
515
|
+
|
516
|
+
|
517
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
518
|
+
|
519
|
+
|
520
|
+
—
|
521
|
+
<div class='inline'>
|
522
|
+
<p>Optional. Append the changelog contents at the bottom of the file. Default:
|
523
|
+
false</p>
|
524
|
+
</div>
|
525
|
+
|
526
|
+
</li>
|
527
|
+
|
528
|
+
<li>
|
529
|
+
|
530
|
+
<span class='name'>with_reference</span>
|
531
|
+
|
532
|
+
|
533
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
534
|
+
|
535
|
+
|
536
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
537
|
+
|
538
|
+
|
539
|
+
—
|
540
|
+
<div class='inline'>
|
541
|
+
<p>Optional. Generate the changelog with MRs and Issues reference. Default
|
542
|
+
true</p>
|
543
|
+
</div>
|
544
|
+
|
545
|
+
</li>
|
546
|
+
|
547
|
+
</ul>
|
548
|
+
|
549
|
+
|
550
|
+
</div><table class="source_code">
|
551
|
+
<tr>
|
552
|
+
<td>
|
553
|
+
<pre class="lines">
|
554
|
+
|
555
|
+
|
556
|
+
47
|
557
|
+
48
|
558
|
+
49
|
559
|
+
50
|
560
|
+
51
|
561
|
+
52
|
562
|
+
53
|
563
|
+
54
|
564
|
+
55
|
565
|
+
56
|
566
|
+
57
|
567
|
+
58
|
568
|
+
59</pre>
|
569
|
+
</td>
|
570
|
+
<td>
|
571
|
+
<pre class="code"><span class="info file"># File 'lib/gitlab/release/changelog/entries.rb', line 47</span>
|
572
|
+
|
573
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_write_in_file'>write_in_file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_appending'>appending</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_with_reference'>with_reference</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
574
|
+
<span class='comment'># @type [String] changelog_string
|
575
|
+
</span> <span class='id identifier rubyid_changelog_string'>changelog_string</span> <span class='op'>=</span> <span class='id identifier rubyid_internal_to_s_with_reference'>internal_to_s_with_reference</span><span class='lparen'>(</span><span class='id identifier rubyid_with_reference'>with_reference</span><span class='rparen'>)</span>
|
576
|
+
|
577
|
+
<span class='id identifier rubyid_searched_paths'>searched_paths</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
578
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_searched_paths'>searched_paths</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
579
|
+
<span class='id identifier rubyid_searched_paths'>searched_paths</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_single_path'>single_path</span><span class='op'>|</span>
|
580
|
+
<span class='id identifier rubyid_internal_write_on_file'>internal_write_on_file</span><span class='lparen'>(</span><span class='id identifier rubyid_single_path'>single_path</span><span class='comma'>,</span> <span class='id identifier rubyid_changelog_string'>changelog_string</span><span class='comma'>,</span> <span class='id identifier rubyid_appending'>appending</span><span class='rparen'>)</span>
|
581
|
+
<span class='kw'>end</span>
|
582
|
+
<span class='kw'>else</span>
|
583
|
+
<span class='id identifier rubyid_internal_write_on_file'>internal_write_on_file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_changelog_string'>changelog_string</span><span class='comma'>,</span> <span class='id identifier rubyid_appending'>appending</span><span class='rparen'>)</span>
|
584
|
+
<span class='kw'>end</span>
|
585
|
+
<span class='kw'>end</span></pre>
|
586
|
+
</td>
|
587
|
+
</tr>
|
588
|
+
</table>
|
589
|
+
</div>
|
590
|
+
|
591
|
+
</div>
|
592
|
+
|
593
|
+
</div>
|
594
|
+
|
595
|
+
<div id="footer">
|
596
|
+
Generated on Fri Nov 29 14:42:42 2019 by
|
597
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
598
|
+
0.9.20 (ruby-2.4.6).
|
599
|
+
</div>
|
600
|
+
|
601
|
+
</div>
|
602
|
+
</body>
|
603
|
+
</html>
|