335 lines
18 KiB
HTML
335 lines
18 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>MSBuildStep - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps</a> / <a href="./index.html">MSBuildStep</a><br/>
|
|
<br/>
|
|
<h1>MSBuildStep</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">MSBuildStep</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?MSBuild">build step</a> running MSBuild script</p>
|
|
<p><strong>See Also</strong><br/>
|
|
<p><a href="../ms-build.html">msBuild</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> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-compound-param/index.html"><span class="identifier">CompoundParam</span></a><span class="symbol"><</span><a href="-coverage/index.html"><span class="identifier">Coverage</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-m-s-build-tools-version/index.html">MSBuildToolsVersion</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">MSBuildToolsVersion</span></code>
|
|
<p>MSBuild ToolsVersion</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-m-s-build-version/index.html">MSBuildVersion</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">MSBuildVersion</span></code>
|
|
<p>MSBuild version</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-platform/index.html">Platform</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">Platform</span></code>
|
|
<p>A required platform bitness</p>
|
|
</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>
|
|
</tbody>
|
|
</table>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">MSBuildStep</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">MSBuildStep</span></a><span class="symbol">.</span><span class="symbol">(</span><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><span class="symbol">)</span></code><code><span class="identifier">MSBuildStep</span><span class="symbol">(</span><span class="symbol">)</span></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?MSBuild">build step</a> running MSBuild script</p>
|
|
</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>Additional command line parameters for MSBuild</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="path.html">path</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">path</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 the solution to be built relative to the build <a href="https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory">checkout directory</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="platform.html">platform</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">platform</span><span class="symbol">: </span><a href="-platform/index.html"><span class="identifier">Platform</span></a><span class="symbol">?</span></code>
|
|
<p>A required platform bitness</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="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- or comma-separated list of MSBuild targets to execute</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="tools-version.html">toolsVersion</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">toolsVersion</span><span class="symbol">: </span><a href="-m-s-build-tools-version/index.html"><span class="identifier">MSBuildToolsVersion</span></a><span class="symbol">?</span></code>
|
|
<p>A version of tools to be used to compile (equivalent to the /toolsversion: commandline argument).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="version.html">version</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">version</span><span class="symbol">: </span><a href="-m-s-build-version/index.html"><span class="identifier">MSBuildVersion</span></a><span class="symbol">?</span></code>
|
|
<p>MSBuild version to use</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.v2018_2/-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.v2017_2/-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.v2018_2/-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, true by default</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-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.v2018_2/-build-step/-execution-mode/index.html"><span class="identifier">ExecutionMode</span></a></code>
|
|
<p>Build step <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/-execution-mode/index.html">execution mode</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-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.v2018_2/-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.v2018_2/-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.v2018_2.buildSteps.MSBuildStep$dotcover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep.Coverage.Dotcover, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-coverage/-dotcover/index.html"><span class="identifier">Dotcover</span></a><span class="symbol">.</span><span class="symbol">(</span><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> <span class="symbol">=</span> {}<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="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.v2018_2.buildSteps.MSBuildStep$ncover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep.Coverage.Ncover, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-coverage/-ncover/index.html"><span class="identifier">Ncover</span></a><span class="symbol">.</span><span class="symbol">(</span><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> <span class="symbol">=</span> {}<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.v2018_2.buildSteps.MSBuildStep$ncover3(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep.Coverage.Ncover3, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-coverage/-ncover3/index.html"><span class="identifier">Ncover3</span></a><span class="symbol">.</span><span class="symbol">(</span><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> <span class="symbol">=</span> {}<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.v2018_2.buildSteps.MSBuildStep$partcover(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep.Coverage.Partcover, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-coverage/-partcover/index.html"><span class="identifier">Partcover</span></a><span class="symbol">.</span><span class="symbol">(</span><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> <span class="symbol">=</span> {}<span class="symbol">)</span><span class="symbol">: </span><a href="-coverage/-partcover/index.html"><span class="identifier">Partcover</span></a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="validate.html">validate</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">validate</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_2.buildSteps.MSBuildStep$validate(jetbrains.buildServer.configs.kotlin.v2018_2.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-error-consumer/index.html"><span class="identifier">ErrorConsumer</span></a><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>Validates this object and reports found errors to the provided consumer</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/clear-conditions.html">clearConditions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">clearConditions</span><span class="symbol">(</span><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>Deletes all configured build step conditions</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-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.v2018_2.BuildStep$conditions(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2017_2.BuildStepConditions, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2017_2/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a><span class="symbol">.</span><span class="symbol">(</span><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> <span class="symbol">=</span> {}<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>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/create.html">create</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">create</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
|
|
<p>Creates an instance of this build step via reflection using a no argument constructor,
|
|
used during copying. Throws an error if this class doesn't have a default constructor.
|
|
Subclasses can override it to create an instance without using a default constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-step/to-string.html">toString</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</BODY>
|
|
</HTML>
|