crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v10.build-steps/-n-ant-step/index.html
2021-01-18 15:27:50 -05:00

302 lines
18 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>NAntStep - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.buildSteps</a>&nbsp;/&nbsp;<a href="./index.html">NAntStep</a><br/>
<br/>
<h1>NAntStep</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NAntStep</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
<p>A <a href="https://www.jetbrains.com/help/teamcity/?NAnt">build step</a> running NAnt scripts</p>
<p><strong>See Also</strong><br/>
<p><a href="../nant.html">nant</a></p>
</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-coverage/index.html">Coverage</a></p>
</td>
<td>
<code><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">Coverage</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-compound-param/index.html"><span class="identifier">CompoundParam</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="-mode/index.html">Mode</a></p>
</td>
<td>
<code><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">Mode</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-compound-param/index.html"><span class="identifier">CompoundParam</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="-platform-bitness/index.html">PlatformBitness</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">PlatformBitness</span></code></td>
</tr>
<tr>
<td>
<p><a href="-platform-version/index.html">PlatformVersion</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">PlatformVersion</span></code></td>
</tr>
<tr>
<td>
<p><a href="-registration/index.html">Registration</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">Registration</span></code></td>
</tr>
<tr>
<td>
<p><a href="-report-order/index.html">ReportOrder</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">ReportOrder</span></code></td>
</tr>
<tr>
<td>
<p><a href="-report-type/index.html">ReportType</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">ReportType</span></code></td>
</tr>
<tr>
<td>
<p><a href="-runtime-version/index.html">RuntimeVersion</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">RuntimeVersion</span></code></td>
</tr>
<tr>
<td>
<p><a href="-target-framework/index.html">TargetFramework</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">TargetFramework</span></code>
<p>Target Framework version</p>
</td>
</tr>
</tbody>
</table>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">NAntStep</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep)/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">NAntStep</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep)/base">base</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">NAntStep</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="args.html">args</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">args</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Space-separated list of additional arguments for NAnt.exe.</p>
</td>
</tr>
<tr>
<td>
<p><a href="coverage.html">coverage</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">coverage</span><span class="symbol">: </span><a href="-coverage/index.html"><span class="identifier">Coverage</span></a><span class="symbol">?</span></code>
<p>Specifies coverage tool to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="mode.html">mode</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">mode</span><span class="symbol">: </span><a href="-mode/index.html"><span class="identifier">Mode</span></a><span class="symbol">?</span></code>
<p>Specifies what Nant script will be executed</p>
</td>
</tr>
<tr>
<td>
<p><a href="nant-home.html">nantHome</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">nantHome</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>A path to NAnt home directory</p>
</td>
</tr>
<tr>
<td>
<p><a href="reduce-test-feedback.html">reduceTestFeedback</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">reduceTestFeedback</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span></code>
<p>Whether TeamCity should run recently failed tests first to reduce test feedback</p>
</td>
</tr>
<tr>
<td>
<p><a href="target-framework.html">targetFramework</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">targetFramework</span><span class="symbol">: </span><a href="-target-framework/index.html"><span class="identifier">TargetFramework</span></a><span class="symbol">?</span></code>
<p>A required target framework (a shortcut for -t: option of NAnt.exe).</p>
</td>
</tr>
<tr>
<td>
<p><a href="targets.html">targets</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">targets</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Space-separated list of NAnt targets to execute</p>
</td>
</tr>
<tr>
<td>
<p><a href="working-dir.html">workingDir</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">workingDir</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p><a href="https://www.jetbrains.com/help/teamcity/?Build+Working+Directory">Build working directory</a> for ant script,
specify it if it is different from the <a href="https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory">checkout directory</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/conditions.html">conditions</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">conditions</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a></code>
<p>Optional collection of build step execution conditions</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/enabled.html">enabled</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">enabled</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
<p>Specifies whether the step is enabled</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/execution-mode.html">executionMode</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">executionMode</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/-execution-mode/index.html"><span class="identifier">ExecutionMode</span></a></code>
<p>Build step <a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/-execution-mode/index.html">execution mode</a></p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/id.html">id</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Id of the step, if not specified will be generated</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/name.html">name</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">name</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Build step name</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/type.html">type</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Build step type</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="dotcover.html">dotcover</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">dotcover</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$dotcover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Coverage.Dotcover, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-coverage/-dotcover/index.html"><span class="identifier">Dotcover</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-coverage/-dotcover/index.html"><span class="identifier">Dotcover</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="nant-file.html">nantFile</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">nantFile</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$nantFile(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Mode.NantFile, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-mode/-nant-file/index.html"><span class="identifier">NantFile</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-mode/-nant-file/index.html"><span class="identifier">NantFile</span></a></code>
<p>Executes the NAnt script at the given path</p>
</td>
</tr>
<tr>
<td>
<p><a href="nant-script.html">nantScript</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">nantScript</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$nantScript(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Mode.NantScript, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-mode/-nant-script/index.html"><span class="identifier">NantScript</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-mode/-nant-script/index.html"><span class="identifier">NantScript</span></a></code>
<p>Executes the NAnt script with the given content</p>
</td>
</tr>
<tr>
<td>
<p><a href="ncover.html">ncover</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">ncover</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$ncover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Coverage.Ncover, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-coverage/-ncover/index.html"><span class="identifier">Ncover</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-coverage/-ncover/index.html"><span class="identifier">Ncover</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="ncover3.html">ncover3</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">ncover3</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$ncover3(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Coverage.Ncover3, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-coverage/-ncover3/index.html"><span class="identifier">Ncover3</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-coverage/-ncover3/index.html"><span class="identifier">Ncover3</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="partcover.html">partcover</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">partcover</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep$partcover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.NAntStep.Coverage.Partcover, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="-coverage/-partcover/index.html"><span class="identifier">Partcover</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="-coverage/-partcover/index.html"><span class="identifier">Partcover</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/conditions.html">conditions</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">conditions</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildStep$conditions(jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Unit)))/base">base</span><span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildStep$conditions(jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Configures <a href="https://www.jetbrains.com/help/teamcity/?Build+Step+Conditions">build step conditions</a></p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>