NAntStep

open class NAntStep : BuildStep

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






}
}




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
}







}
}




See also

Constructors

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

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Target Framework version

Properties

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

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

Link copied to clipboard

Optional collection of build step execution conditions

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

Specifies coverage tool to use

Link copied to clipboard

Specifies whether the step is enabled, true by default

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

Specifies what Nant script will be executed

Link copied to clipboard

Build step name

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

A path to NAnt home directory

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

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

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

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

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

Space-separated list of NAnt targets to execute

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

Executes the NAnt script at the given path

Link copied to clipboard

Executes the NAnt script with the given content

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
Link copied to clipboard
fun removeRawParam(paramName: String)
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