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

PowerShellStep

fun BuildSteps.powerShell(init: PowerShellStep.() -> Unit): PowerShellStep

A build step running PowerShell script

Example. A simple powershell script producing "Hello, World!" output to the build log.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        powerShell {
          scriptMode = script {
            content = "Write-Host 'Hello, World!'"
          }
        }
Content copied to clipboard
    }
}

Example. Run a Powershell script with name "my_script.ps1" in the checkout directory. Use cross-platform "Core" edition of the Powershell.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        powerShell {
          edition = PowerShellStep.Edition.Core
          scriptMode = file {
            path = "my_script.ps1"
          }
        }
Content copied to clipboard
    }
}

Constructors

PowerShellStep

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

PowerShellStep

fun PowerShellStep()

Types

Edition

enum Edition : Enum<PowerShellStep.Edition>

A PowerShell edition

ExecutionMode

enum ExecutionMode : Enum<PowerShellStep.ExecutionMode>

PowerShell script execution mode

Platform

enum Platform : Enum<PowerShellStep.Platform>

A required platform bitness

ScriptMode

sealed class ScriptMode : CompoundParam<PowerShellStep.ScriptMode>

Version

enum Version : Enum<PowerShellStep.Version>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR 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><Parametrized, <ERROR 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><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

file

fun file(init: PowerShellStep.ScriptMode.File.() -> Unit = {}): PowerShellStep.ScriptMode.File

Run a PowerShell script at the given path

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

script

fun script(init: PowerShellStep.ScriptMode.Script.() -> Unit = {}): PowerShellStep.ScriptMode.Script

Run a PowerShell script with the given content

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

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: <ERROR CLASS>

Additional arguments to be passed to PowerShell

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

edition

var edition: <ERROR CLASS>

PowerShell edition to use

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

formatStderrAsError

var formatStderrAsError: <ERROR CLASS>

Specifies how the error output is handled. If set to true any output to stderr is handled as an error. By default any output to stderr is handled as a warning.

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.

minRequiredVersion

var minRequiredVersion: <ERROR CLASS>

A minimum required PowerShell version installed on a build agent

minVersion

~~var~~ ~~minVersion~~: <ERROR CLASS>

name

var name: String

Build step name

noProfile

var noProfile: <ERROR CLASS>

Whether the script should be executed with the -NoProfile added

params