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

CSharpScriptFileBuildStep

open class CSharpScriptFileBuildStep : BuildStep

fun BuildSteps.csharpFile(init: CSharpScriptFileBuildStep.() -> Unit): CSharpScriptFileBuildStep

A build step running a C# script with from a specified file

Example. Runs a C# script with help of C# script tool

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        csharpFile {
            path = "MyScript.csi"
            tool = "%teamcity.tool.TeamCity.csi.DEFAULT%"
        }


Content copied to clipboard
    }
}

Constructors

CSharpScriptFileBuildStep

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

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<CSharpScriptFileBuildStep.ImagePlatform>

Docker image platforms

Properties

arguments

var arguments: <Error class: unknown class>

Space-separated list of additional arguments for C# script

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

dockerImage

var dockerImage: <Error class: unknown class>

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: <Error class: unknown class>

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

dockerPull

var dockerPull: <Error class: unknown class>

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

dockerRunParameters

var dockerRunParameters: <Error class: unknown class>

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>

path

var path: <Error class: unknown class>

A path to a file with .main.kts extension

sources

var sources: <Error class: unknown class>

Space-separated list of NuGet package source (URL, UNC/folder path)

tool

var tool: <Error class: unknown class>

C# tool path

type

var type: String

Build step type

workingDir

var workingDir: <Error class: unknown class>

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

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown 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: unknown class><Parametrized, <Error class: unknown 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.

doubleParameter

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam