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

AntBuildStep

fun BuildSteps.ant(init: AntBuildStep.() -> Unit): AntBuildStep

A build step running ant script

Example. Adds a simpe Ant build step with specified build file and targets. Default JDK is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            mode = antFile {
                path = "my-build.xml"
            }
            targets = "target1 target2"
        }
Content copied to clipboard
    }
}

Example. Adds an Ant build step with build file content specified directly in the step settings. Custom working directory is set. Custom Ant setup is provided, as well as custom JDK home and JVM parameters are set. IDEA-based code coverage is configured.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            mode = antScript {
                content = """
                    // Example Build file
                    // content goes here ...
                """.trimIndent()
            }
            workingDir = "ant-project/"
            targets = "target1 target2"

            antHome = "my-ant/home"
            antArguments = "-quiet"

            jdkHome = "%env.JDK_11_0%"
            jvmArgs = "-Xmx512m"

            coverageEngine = idea {
                includeClasses = "org.sample.*"
                excludeClasses = "org.sample.test.*"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an Ant build step with build file content specified directly in the step settings to be run inside a Docker container. Custom test parameter is set. This build step will run even if some previous build steps are failed.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ant {
            name = "My Ant step"
            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            mode = antScript {
                content = """
                    // Example Build file
                    // content goes here ...
                """.trimIndent()
            }
            targets = "target1 target2"
            reduceTestFeedback = AntBuildStep.TestPolicy.RECENTLY_FAILED_AND_MODIFIED

            dockerImage = "myImage:2.4"
            dockerImagePlatform = AntBuildStep.ImagePlatform.Linux
            dockerPull = true
        }
Content copied to clipboard
    }
}

Constructors

AntBuildStep

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

constructor()

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<AntBuildStep.CoverageEngine>

ImagePlatform

enum ImagePlatform : Enum<AntBuildStep.ImagePlatform>

Docker image platforms

Mode

sealed class Mode : CompoundParam<AntBuildStep.Mode>

TestPolicy

enum TestPolicy : Enum<AntBuildStep.TestPolicy>

Tests reordering policy

Properties

antArguments

var antArguments: String?

Space-separated list of additional arguments for ant

antHome

var antHome: String?

Path to ant distribution on the agent, specify it when you want to use custom ant instead of the bundled ant 1.9.7

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverageEngine

var coverageEngine: AntBuildStep.CoverageEngine?

Specifies coverage engine to use

dockerImage

var dockerImage: String?

Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.

dockerImagePlatform

var dockerImagePlatform: AntBuildStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

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.

jdkHome

var jdkHome: String?

Custom JDK to use. The default is JAVA_HOME environment variable or the agent's own Java.

jvmArgs

var jvmArgs: String?

Space-separated list of additional arguments for JVM

mode

var mode: AntBuildStep.Mode?

Specifies what ant script will be executed

name

var name: String

Build step name

params

val params: List<Parameter>

reduceTestFeedback

var reduceTestFeedback: AntBuildStep.TestPolicy?

Whether TeamCity should reorder tests to reduce test feedback

targets

var targets: String?

Space-separated list of ant 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

antFile

fun antFile(init: AntBuildStep.Mode.AntFile.() -> Unit = {}): AntBuildStep.Mode.AntFile

Executes the ant script at the given path

antScript

fun antScript(init: AntBuildStep.Mode.AntScript.() -> Unit = {}): AntBuildStep.Mode.AntScript

Executes the ant script with the given content

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.

doubleParameter

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

emma

fun emma(init: AntBuildStep.CoverageEngine.Emma.() -> Unit = {}): AntBuildStep.CoverageEngine.Emma

Emma coverage engine Emma is out of date and it does not support Java 8. Consider using IntelliJ IDEA or JaCoCo coverage runners. Add a 'clean' target to your Ant build for this coverage runner to work.

enumParameter