MSBuildStep

open class MSBuildStep : BuildStep

Deprecated

Deprecated, was previously used to set up a build step for running an MSBuild script.

Replace with

DotnetMsBuildStep

Deprecated, was previously used to set up a build step for running an MSBuild script. Use the .NET MSBuild runner instead. See this link for more information on migrating to the .NET MSBuild runner.

See also

Constructors

Link copied to clipboard
constructor(init: MSBuildStep.() -> Unit)
constructor()

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A required platform bitness

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
var args: <Error class: unknown class>

Additional command line parameters for MSBuild

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard
var coverage: <Error class: unknown class>

Specifies coverage tool to use

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

Link copied to clipboard

Build step name

Link copied to clipboard
Link copied to clipboard
var path: <Error class: unknown class>

A path to the solution to be built relative to the build checkout directory

Link copied to clipboard
var platform: <Error class: unknown class>

A required platform bitness

Link copied to clipboard
var reduceTestFeedback: <Error class: unknown class>

Whether TeamCity should run recently failed tests first to reduce test feedback

Link copied to clipboard
var targets: <Error class: unknown class>

Space- or comma-separated list of MSBuild targets to execute

Link copied to clipboard
var toolsVersion: <Error class: unknown class>

A version of tools that will be used to compile (equivalent to the /toolsversion: commandline argument).

Link copied to clipboard

Build step type

Link copied to clipboard
var version: <Error class: unknown class>

MSBuild version to use

Link copied to clipboard
var workingDir: <Error class: unknown class>

Build working directory for the Ant script. Specify a working directory if it differs from the checkout directory.

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
open fun create(): BuildStep

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.

Link copied to clipboard
Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer