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

DevenvBuildStep

fun BuildSteps.dotnetDevenv(init: DevenvBuildStep.() -> Unit): DevenvBuildStep

A Visual Studio IDE step to run Visual Studio IDE command

Example. Runs devenv.exe command for all solution files in the build checkout directory.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotnetDevenv {
            projects = "*.sln"
            version = DevenvBuildStep.VSVersion.Any
            action = DevenvBuildStep.VSAction.Clean
        }
Content copied to clipboard
    }
}

Constructors

DevenvBuildStep

constructor(init: DevenvBuildStep.() -> Unit)

constructor()

Types

Coverage

sealed class Coverage : CompoundParam<DevenvBuildStep.Coverage>

ImagePlatform

enum ImagePlatform : Enum<DevenvBuildStep.ImagePlatform>

Docker image platforms

VSAction

enum VSAction : Enum<DevenvBuildStep.VSAction>

MSBuild action

VSVersion

enum VSVersion : Enum<DevenvBuildStep.VSVersion>

Visual Studio version

Properties

action

var action: DevenvBuildStep.VSAction?

Visual Studio IDE command to execute

args

var args: String?

Enter additional command line parameters for .NET MSBuild.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

configuration

var configuration: String?

Specifies the project configuration to build or deploy.

coverage

var coverage: DevenvBuildStep.Coverage?

Specifies coverage tool to use

dockerImage

var dockerImage: String?

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.

dockerImagePlatform

var dockerImagePlatform: DevenvBuildStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

name

var name: String

Build step name

params

val params: List<Parameter>

projects

var projects: String?

Specify paths to projects and solutions. Wildcards are supported.

sdk

var sdk: String?

.NET SDK versions separated by semicolon to be required on agents.

type

var type: String

Build step type

version

var version: DevenvBuildStep.VSVersion?

Visual Studio version to use

workingDir

var workingDir: String?

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

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

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