TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/MSBuildStep

MSBuildStep

~~open~~ ~~class~~ ~~MSBuildStep~~ : ~~BuildStep~~

~~fun~~ BuildSteps.~~msBuild~~(init: MSBuildStep.() -> Unit): MSBuildStep

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.

Constructors

MSBuildStep

fun MSBuildStep(init: MSBuildStep.() -> Unit)

MSBuildStep

fun MSBuildStep()

Types

Coverage

sealed class Coverage : CompoundParam<MSBuildStep.Coverage>

MSBuildToolsVersion

enum MSBuildToolsVersion : Enum<MSBuildStep.MSBuildToolsVersion>

MSBuild ToolsVersion

MSBuildVersion

enum MSBuildVersion : Enum<MSBuildStep.MSBuildVersion>

MSBuild version

Platform

enum Platform : Enum<MSBuildStep.Platform>

A required platform bitness

PlatformBitness

enum PlatformBitness : Enum<MSBuildStep.PlatformBitness>

PlatformVersion

enum PlatformVersion : Enum<MSBuildStep.PlatformVersion>

Registration

enum Registration : Enum<MSBuildStep.Registration>

ReportOrder

enum ReportOrder : Enum<MSBuildStep.ReportOrder>

ReportType

enum ReportType : Enum<MSBuildStep.ReportType>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

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.

dotcover

fun dotcover(init: MSBuildStep.Coverage.Dotcover.() -> Unit = {}): MSBuildStep.Coverage.Dotcover

doubleParameter

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

ncover

fun ncover(init: MSBuildStep.Coverage.Ncover.() -> Unit = {}): MSBuildStep.Coverage.Ncover

ncover3

fun ncover3(init: MSBuildStep.Coverage.Ncover3.() -> Unit = {}): MSBuildStep.Coverage.Ncover3

param

fun param(name: String, value: String)

Adds parameter with specified name and value

partcover

fun partcover(init: MSBuildStep.Coverage.Partcover.() -> Unit = {}): MSBuildStep.Coverage.Partcover

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

args

var args: <ERROR CLASS>

Additional command line parameters for MSBuild

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverage

var coverage: <ERROR CLASS>

Specifies coverage tool to use

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

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.

name

var name: String

Build step name

params