275 lines
14 KiB
HTML
275 lines
14 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>DevenvBuildStep - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2017_2.buildSteps</a> / <a href="./index.html">DevenvBuildStep</a><br/>
|
|
<br/>
|
|
<h1>DevenvBuildStep</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">DevenvBuildStep</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2017_2/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
|
|
<p>A <a href="https://github.com/JetBrains/teamcity-dotnet-plugin">Visual Studio IDE step</a> to run Visual Studio IDE command</p>
|
|
<p><strong>See Also</strong><br/>
|
|
<p><a href="../dotnet-devenv.html">dotnetDevenv</a></p>
|
|
</p>
|
|
<h3>Types</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-image-platform/index.html">ImagePlatform</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">ImagePlatform</span></code>
|
|
<p>Docker image platforms</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-v-s-action/index.html">VSAction</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">VSAction</span></code>
|
|
<p>MSBuild action</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-v-s-version/index.html">VSVersion</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">VSVersion</span></code>
|
|
<p>Visual Studio version</p>
|
|
</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">DevenvBuildStep</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2017_2.buildSteps.DevenvBuildStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2017_2.buildSteps.DevenvBuildStep, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">DevenvBuildStep</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">DevenvBuildStep</span><span class="symbol">(</span><span class="symbol">)</span></code>
|
|
<p>A <a href="https://github.com/JetBrains/teamcity-dotnet-plugin">Visual Studio IDE step</a> to run Visual Studio IDE command</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="action.html">action</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">action</span><span class="symbol">: </span><a href="-v-s-action/index.html"><span class="identifier">VSAction</span></a><span class="symbol">?</span></code>
|
|
<p>Visual Studio IDE command to execute</p>
|
|
</td>
|
|
</tr>
|
|
<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>Enter additional command line parameters for .NET MSBuild.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="configuration.html">configuration</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">configuration</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>Specifies the project configuration to build or deploy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="docker-image.html">dockerImage</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">dockerImage</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>Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="docker-image-platform.html">dockerImagePlatform</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">dockerImagePlatform</span><span class="symbol">: </span><a href="-image-platform/index.html"><span class="identifier">ImagePlatform</span></a><span class="symbol">?</span></code>
|
|
<p>Specifies which Docker image platform will be used to run this build step.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="docker-pull.html">dockerPull</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">dockerPull</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>If enabled, "docker pull <a href="docker-image.html">image</a>" will be run before docker run.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="docker-run-parameters.html">dockerRunParameters</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">dockerRunParameters</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 docker run command arguments</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="projects.html">projects</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">projects</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>Specify paths to projects and solutions. Wildcards are supported.</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="-v-s-version/index.html"><span class="identifier">VSVersion</span></a><span class="symbol">?</span></code>
|
|
<p>Visual Studio 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
|
|
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.v2017_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.v2017_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.v2017_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.v2017_2/-build-step/-execution-mode/index.html"><span class="identifier">ExecutionMode</span></a></code>
|
|
<p>Build step <a href="../../jetbrains.build-server.configs.kotlin.v2017_2/-build-step/-execution-mode/index.html">execution mode</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2017_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.v2017_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.v2017_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="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.v2017_2.buildSteps.DevenvBuildStep$validate(jetbrains.buildServer.configs.kotlin.v2017_2.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2017_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.v2017_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.v2017_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.v2017_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.v2017_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.v2017_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.v2017_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>
|