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

NAntStep

fun BuildSteps.nant(init: NAntStep.() -> Unit): NAntStep

A build step running NAnt scripts

Example. Runs NAnt for specified path, target, target framework and passing an argument

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nant {
            mode = nantFile {
                path = "MyProject"
            }
            targets = "Test"
            targetFramework = NAntStep.TargetFramework.NET_4_0
            args = "-D:arg.abc=bca"
        }
Content copied to clipboard
    }
}

Example. Runs NAnit for specified build file content, target and target framework

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nant {
            mode = nantScript {
                content = """
                    [ put your build file content here ]
                    """.trimIndent()
            }
            targets = "build"
            targetFramework = NAntStep.TargetFramework.NET_4_0
        }
Content copied to clipboard
    }
}

Constructors

NAntStep

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

constructor()

Types

Coverage

sealed class Coverage : CompoundParam<NAntStep.Coverage>

Mode

sealed class Mode : CompoundParam<NAntStep.Mode>

PlatformBitness

enum PlatformBitness : Enum<NAntStep.PlatformBitness>

PlatformVersion

enum PlatformVersion : Enum<NAntStep.PlatformVersion>

Registration

enum Registration : Enum<NAntStep.Registration>

ReportOrder

enum ReportOrder : Enum<NAntStep.ReportOrder>

ReportType

enum ReportType : Enum<NAntStep.ReportType>

RuntimeVersion

enum RuntimeVersion : Enum<NAntStep.RuntimeVersion>

TargetFramework

enum TargetFramework : Enum<NAntStep.TargetFramework>

Target Framework version

Properties

args

var args: String?

Space-separated list of additional arguments for NAnt.exe.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverage

var coverage: NAntStep.Coverage?

Specifies coverage tool to use

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.

mode

var mode: NAntStep.Mode?

Specifies what Nant script will be executed

name

var name: String

Build step name

nantHome

var nantHome: String?

A path to NAnt home directory

params

val params: List<Parameter>

reduceTestFeedback

var reduceTestFeedback: Boolean?

Whether TeamCity should run recently failed tests first to reduce test feedback

targetFramework

var targetFramework: NAntStep.TargetFramework?

A required target framework (a shortcut for -t: option of NAnt.exe).

targets

var targets: String?

Space-separated list of NAnt targets to execute

type

var type: String

Build step type

workingDir

var workingDir: String?

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

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<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