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

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

NAntStep

fun NAntStep()

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

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

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

fun dotcover(init: NAntStep.Coverage.Dotcover.() -> Unit = {}): NAntStep.Coverage.Dotcover

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

nantFile

fun nantFile(init: NAntStep.Mode.NantFile.() -> Unit = {}): NAntStep.Mode.NantFile

Executes the NAnt script at the given path

nantScript

fun nantScript(init: NAntStep.Mode.NantScript.() -> Unit = {}): NAntStep.Mode.NantScript

Executes the NAnt script with the given content

ncover

fun ncover(init: NAntStep.Coverage.Ncover.() -> Unit = {}): NAntStep.Coverage.Ncover

ncover3

fun ncover3(init: NAntStep.Coverage.Ncover3.() -> Unit = {}): NAntStep.Coverage.Ncover3

param

fun param(name: String, value: String)

Adds parameter with specified name and value

partcover

fun partcover(init: NAntStep.Coverage.Partcover.() -> Unit = {}): NAntStep.Coverage.Partcover

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

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: 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 = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

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