-
-
Notifications
You must be signed in to change notification settings - Fork 228
/
default-configuration-values.md
440 lines (363 loc) · 14 KB
/
default-configuration-values.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
Order: 20
Description: Available configuration options
RedirectFrom:
- docs/running-builds/default-configuration-values
- docs/fundamentals/default-configuration-values
---
:::{.alert .alert-warning}
Configuration is currently not supported for [Cake Frosting].
:::
The following shows all of the configuration options currently available in [Cake .NET Tool] as well as their default values.
Refer to [set configuration values](/docs/running-builds/configuration/set-configuration-values) for instructions on using a config file.
# Addin NuGet Dependencies
:::{.alert .alert-info}
Available since Cake `0.22.0`.
:::
When using In-Process NuGet installation you can also opt in to automatically installing and referencing NuGet package dependencies.
_Default value:_ `false`
_Valid values:_ `true`, `false`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env1">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config1">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg1">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env1" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_NUGET_LOADDEPENDENCIES</code></pre>
</p>
</div>
<div id="config1" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[NuGet]
LoadDependencies=true</code></pre>
</p>
</div>
<div id="arg1" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--nuget_loaddependencies=true</code></pre>
</p>
</div>
</div>
# Addins Path
This allows the configuration of the addins folder which is used by Cake when restoring addins.
_Default value:_ `./tools/Addins`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env2">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config2">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg2">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env2" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_PATHS_ADDINS</code></pre>
</p>
</div>
<div id="config2" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Paths]
Addins=./tools/Addins</code></pre>
</p>
</div>
<div id="arg2" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--paths_addins=./tools/Addins</code></pre>
</p>
</div>
</div>
# In-Process NuGet installation
:::{.alert .alert-info}
Available since Cake `0.25.0`.
:::
Since Cake `0.25.0` the default is to use the In-Process NuGet Client.
If you require to use `NuGet.exe` instead, you can opt-out by setting this value to false.
_Default value:_ `true`
_Valid values:_ `true`, `false`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env3">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config3">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg3">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env3" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_NUGET_USEINPROCESSCLIENT</code></pre>
</p>
</div>
<div id="config3" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[NuGet]
UseInProcessClient=false</code></pre>
</p>
</div>
<div id="arg3" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--nuget_useinprocessclient=false</code></pre>
</p>
</div>
</div>
# Modules Path
This allows the configuration of the Modules folder which is used by Cake when loading custom Modules.
_Default value:_ `./tools/Modules`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env4">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config4">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg4">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env4" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_PATHS_MODULES</code></pre>
</p>
</div>
<div id="config4" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Paths]
Modules=./tools/Modules</code></pre>
</p>
</div>
<div id="arg4" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--paths_modules=./tools/Modules</code></pre>
</p>
</div>
</div>
# NuGet Configuration File Path
This allows the configuration of the path to NuGet config file for overriding the default file.
_Default value:_ If NuGet config not specified, will use NuGet default mechanism for resolving it.
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env5">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config5">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg5">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env5" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_NUGET_CONFIGFILE</code></pre>
</p>
</div>
<div id="config5" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[NuGet]
ConfigFile=./NuGet.config</code></pre>
</p>
</div>
<div id="arg5" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--nuget_configfile=./NuGet.config</code></pre>
</p>
</div>
</div>
# NuGet Download Url
This allows the control of where Cake downloads NuGet packages from when using the addin and tool preprocessor directives.
This can be useful when it is necessary to work in an offline mode, where direct access to nuget.org is not available.
:::{.alert .alert-info}
Multiple sources can be passed separated by a semicolon.
:::
_Default value:_ `https://packages.nuget.org/api/v2`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env6">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config6">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg6">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env6" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_NUGET_SOURCE</code></pre>
</p>
</div>
<div id="config6" class="tab-pane fade">
<p>
With a single source:
</p>
<p>
<pre><code class="language-sh hljs">[Nuget]
Source=http://myfeed/nuget/</code></pre>
</p>
<p>
With multiple sources:
</p>
<p>
<pre><code class="language-sh hljs">[Nuget]
Source=http://myfeed/nuget/;http://myotherfeed/nuget</code></pre>
</p>
</div>
<div id="arg6" class="tab-pane fade">
<p>
With a single source:
</p>
<p>
<pre><code class="language-sh hljs">--nuget_source=http://myfeed/nuget/</code></pre>
</p>
<p>
With multiple sources:
</p>
<p>
<pre><code class="language-sh hljs">--nuget_source=http://myfeed/nuget/;http://myotherfeed/nuget</code></pre>
</p>
</div>
</div>
# Show Process Command Line
When Cake runs a tool the default behavior is to log the file name and the arguments only when the `Diagnostic` log verbosity is used.
This setting will instruct Cake to always log the file name and arguments regardless of the log verbosity setting.
_Default value:_ `false`
_Valid values:_ `true`, `false`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env7">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config7">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg7">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env7" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_SETTINGS_SHOWPROCESSCOMMANDLINE</code></pre>
</p>
</div>
<div id="config7" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Settings]
ShowProcessCommandLine=true</code></pre>
</p>
</div>
<div id="arg7" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--settings_showprocesscommandline=true</code></pre>
</p>
</div>
</div>
# Skip Verification
If any breaking changes are introduced to Cake, we'll set the minimum supported version of the `Cake.Core` assembly.
Any addin/assembly that references an older version of `Cake.Core` will generate an exception and ultimately abort the execution of the script.
This is to avoid runtime errors during execution of the script.
But if you really need to use an addin/assembly and have verified that the breaking change introduced doesn't concern the addin/assembly directly, i.e. it doesn't use a removed property or changed interface, for this scenario we'll allow you to temporarily opt-out of the assembly verification until addin/assembly author has released a version of the assembly targeting the minimum required version of `Cake.Core`.
:::{.alert .alert-warning}
This setting is global for all addins/assemblies your script references and should therefore be considered a temporary quick fix.
:::
_Default value:_ `false`
_Valid values:_ `true`, `false`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env8">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config8">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg8">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env8" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_SETTINGS_SKIPVERIFICATION</code></pre>
</p>
</div>
<div id="config8" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Settings]
SkipVerification=true</code></pre>
</p>
</div>
<div id="arg8" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--settings_skipverification=true</code></pre>
</p>
</div>
</div>
# Tools Path
This allows the configuration of the tools folder which is used by Cake when restoring tools.
_Default value:_ `./tools`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env9">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config9">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg9">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env9" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_PATHS_TOOLS</code></pre>
</p>
</div>
<div id="config9" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Paths]
Tools=./tools</code></pre>
</p>
</div>
<div id="arg9" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--paths_tools=./tools</code></pre>
</p>
</div>
</div>
# Disable Colors in output text
:::{.alert .alert-info}
Available since Cake `1.1.0`.
:::
By default, Cake outputs colored text when it detects it is running on an environment that supports ANSI escape codes.
To disable output of colored text, set an environment variable with the name [`NO_COLOR`](https://no-color.org) with any value.
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env10">Environment variable name</a></li>
</ul>
<div class="tab-content">
<div id="env10" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">NO_COLOR</code></pre>
</p>
</div>
</div>
# Cache compiled script on disk
:::{.alert .alert-info}
Available since Cake `2.2.0`.
:::
This enables [Cake .NET Tool] to cache script compilation for significantly faster subsequent executions of unchanged scripts.
_Default value:_ `false`
_Valid values:_ `true`, `false`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env11">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config11">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg11">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env11" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_SETTINGS_ENABLESCRIPTCACHE</code></pre>
</p>
</div>
<div id="config11" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Settings]
EnableScriptCache=true</code></pre>
</p>
</div>
<div id="arg11" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--settings_enablescriptcache=true</code></pre>
</p>
</div>
</div>
# Cache Location Path
:::{.alert .alert-info}
Available since Cake `2.2.0`.
:::
This allows the configuration of the folder which is used by [Cake .NET Tool] when caching compiled scrips.
_Default value:_ `./tools/cache`
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#env12">Environment variable name</a></li>
<li><a data-toggle="tab" href="#config12">Config file contents</a></li>
<li><a data-toggle="tab" href="#arg12">Argument name</a></li>
</ul>
<div class="tab-content">
<div id="env12" class="tab-pane fade in active">
<p>
<pre><code class="language-sh hljs">CAKE_PATHS_CACHE</code></pre>
</p>
</div>
<div id="config12" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">[Paths]
Cache=./tools/cache</code></pre>
</p>
</div>
<div id="arg12" class="tab-pane fade">
<p>
<pre><code class="language-sh hljs">--paths_cache=./tools/cache</code></pre>
</p>
</div>
</div>
[Cake .NET Tool]: /docs/running-builds/runners/dotnet-tool
[Cake Frosting]: /docs/running-builds/runners/cake-frosting