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

DotnetCustomStep

fun BuildSteps.dotnetCustom(init: DotnetCustomStep.() -> Unit): DotnetCustomStep

A dotnet build step to run a custom command

Example. Runs dotnet EXECUTABLE to run specified .NET application

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotnetCustom {
            executables = "MyProgram.exe"
            args = "abc=123"
        }
Content copied to clipboard
    }
}

Constructors

DotnetCustomStep

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

DotnetCustomStep

fun DotnetCustomStep()

Types

Coverage

sealed class Coverage : CompoundParam<DotnetCustomStep.Coverage>

ImagePlatform

enum ImagePlatform : Enum<DotnetCustomStep.ImagePlatform>

Docker image platforms

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.

dotcover

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

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?

Enter additional command line parameters for custom command.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverage

var coverage: DotnetCustomStep.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: DotnetCustomStep.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 = true

Specifies whether the step is enabled, true by default

executables

var executables: String?

Specify paths Specify paths to executable files. Wildcards are supported.

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