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!'"
}
}
}
}

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"
}
}
}
}

See also

Constructors

Link copied to clipboard
constructor(init: PowerShellStep.() -> Unit)
constructor()

Types

Link copied to clipboard

A PowerShell edition

Link copied to clipboard

PowerShell script execution mode

Link copied to clipboard

A required platform bitness

Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
var args: <Error class: unknown class>

Additional arguments to be passed to PowerShell

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard
var edition: <Error class: unknown class>

PowerShell edition to use

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var formatStderrAsError: <Error class: unknown 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.

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

Link copied to clipboard
var minRequiredVersion: <Error class: unknown class>

A minimum required PowerShell version installed on a build agent

Link copied to clipboard
var minVersion: <Error class: unknown class>
Link copied to clipboard

Build step name

Link copied to clipboard
var noProfile: <Error class: unknown class>

Whether the script should be executed with the -NoProfile added

Link copied to clipboard
Link copied to clipboard
var platform: <Error class: unknown class>

A required platform bitness

Link copied to clipboard
var scriptArgs: <Error class: unknown class>

Build parameters to be passed as arguments into the PowerShell script

Link copied to clipboard
var scriptExecMode: <Error class: unknown class>

PowerShell execution mode

Link copied to clipboard
var scriptMode: <Error class: unknown class>

PowerShell script execution mode

Link copied to clipboard

Build step type

Link copied to clipboard
var workingDir: <Error class: unknown class>

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

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
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): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard

Run a PowerShell script at the given path

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): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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

Run a PowerShell script with the given content

Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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