VisualStudioStep

open class VisualStudioStep : BuildStep
fun BuildSteps.visualStudio(init: VisualStudioStep.() -> Unit): VisualStudioStep

A build step running Visual Studio solution.

See also

Constructors

Link copied to clipboard
fun VisualStudioStep(init: VisualStudioStep.() -> Unit)
Link copied to clipboard
fun VisualStudioStep()

Types

Link copied to clipboard

MSBuild ToolsVersion

Link copied to clipboard
enum MSBuildVersion : Enum<VisualStudioStep.MSBuildVersion>

MSBuild version

Link copied to clipboard
enum Platform : Enum<VisualStudioStep.Platform>

A required platform bitness

Link copied to clipboard

Microsoft Visual Studio version

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): SingleDelegateProvider<Boolean>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun clearConditions()

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>
Link copied to clipboard
fun conditions(init: BuildStepConditions.() -> Unit = {})
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
fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>
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): SingleDelegateProvider<Int>
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
fun stringParameter(customName: String? = null): SingleDelegateProvider<String>
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

Properties

Link copied to clipboard
var args: String?

Additional command line parameters for MSBuild

Link copied to clipboard
var conditions: BuildStepConditions

Optional collection of build step execution conditions

Link copied to clipboard
var configuration: String?

Specify solution configuration for the build.

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the step is enabled, true by default

Link copied to clipboard
var executionMode: BuildStep.ExecutionMode

Build step execution mode

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
var msBuildVersion: VisualStudioStep.MSBuildVersion?

MSBuild version to use

Link copied to clipboard
var name: String

Build step name

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var path: String?

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

Link copied to clipboard
var platform: String?

Specify solution platform for the build.

Link copied to clipboard
var runPlatform: VisualStudioStep.Platform?

A required platform bitness

Link copied to clipboard
var targets: String?

Specify list of MSBuild targets to execute.

Link copied to clipboard
var type: String

Build step type

Link copied to clipboard
var version: VisualStudioStep.VisualStudioVersion?

Visual Studio version to use

Link copied to clipboard
var workingDir: String?

Build working directory for ant script, specify it if it is different from the checkout directory.