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

VisualStudioStep

~~open~~ ~~class~~ ~~VisualStudioStep~~ : ~~BuildStep~~

~~fun~~ BuildSteps.~~visualStudio~~(init: VisualStudioStep.() -> Unit): VisualStudioStep

Deprecated, was previously used to set up a build step for running a Visual Studio solution. Use the .NET Devenv runner instead. See this link for more information on migrating from the Visual Studio (sln) runner.

Constructors

VisualStudioStep

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

VisualStudioStep

fun VisualStudioStep()

Types

MSBuildToolsVersion

enum MSBuildToolsVersion : Enum<VisualStudioStep.MSBuildToolsVersion>

MSBuild ToolsVersion

MSBuildVersion

enum MSBuildVersion : Enum<VisualStudioStep.MSBuildVersion>

MSBuild version

Platform

enum Platform : Enum<VisualStudioStep.Platform>

A required platform bitness

VisualStudioVersion

enum VisualStudioVersion : Enum<VisualStudioStep.VisualStudioVersion>

Microsoft Visual Studio version

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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.

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

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: String?

Additional command line parameters for MSBuild

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

configuration

var configuration: String?

Specify solution configuration for the build.

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.

msBuildToolsVersion

var msBuildToolsVersion: VisualStudioStep.MSBuildToolsVersion?

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

msBuildVersion

var msBuildVersion: VisualStudioStep.MSBuildVersion?

MSBuild version to use

name

var name: String

Build step name

params