TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/Swabra

Swabra

fun BuildFeatures.swabra(init: Swabra.() -> Unit): Swabra

A build feature cleaning files and processes created during a build

Example. Enables cleanup of the build files on the agent before the first build step starts. Also detects all the processes locking the files under the build checkout directory (Windows only), and kills them. If build files cleaning fails for some reason, then forces the agent to perform clean checkout.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        swabra {
          forceCleanCheckout = true
          lockingProcesses = Swabra.LockingProcessPolicy.KILL
        }
Content copied to clipboard
    }
}

Constructors

Swabra

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

constructor()

Types

FilesCleanup

enum FilesCleanup : Enum<Swabra.FilesCleanup>

Files clean-up mode

LockingProcessPolicy

enum LockingProcessPolicy : Enum<Swabra.LockingProcessPolicy>

Specifies how to handle processes locking some files

Properties

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

filesCleanup

var filesCleanup: Swabra.FilesCleanup?

A files clean-up mode to use

forceCleanCheckout

var forceCleanCheckout: Boolean?

Force clean checkout if cannot restore clean directory state

var id: String?

Build feature id, if not specified will be generated

lockingProcesses

var lockingProcesses: Swabra.LockingProcessPolicy?

Whether to inspect the checkout directory for processes locking files in this directory, and what to do with such processes

params

val params: List<Parameter>

paths

var paths: String?

Paths to monitor

type

var type: String

Build feature type

verbose

var verbose: Boolean?

Enables detailed logging to build log

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature 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