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

MavenBuildStep

fun BuildSteps.maven(init: MavenBuildStep.() -> Unit): MavenBuildStep

A build step running maven

Example. Adds a simple Maven build step in the checkout directory and pom.xml located in the checkout directory. Default bundled maven tool is used, JDK from JAVA_HOME environment variable is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        maven {
            name = "Install step"
            goals = "clean install"
        }
Content copied to clipboard
    }
}

Example. Adds a Maven build step with custom path to project root and pom.xml. Extra maven command line argumant is specified. Custom bundled maven version is specified. JDK is set to the environment variable value.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        maven {
            goals = "clean install"
            pomLocation = "intergation-tests/pom.xml"
            runnerArgs = "-X"
            workingDir = "intergation-tests"

            mavenVersion = bundled_3_8()
            userSettingsSelection = "settings.xml"

            jdkHome = "%env.JDK_11_0_x64%"
            jvmArgs = "-Xmx2048m"
        }
Content copied to clipboard
    }
}

Example. Adds a Maven build step with customized path to maven executable and JDK. Custom Maven settings provided on project level are set. This build step will run even if some previous build steps are failed.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        maven {
            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            goals = "clean install"
            mavenVersion = custom {
                path = "my/own/mvn"
            }
            userSettingsSelection = "settings.xml"
            jdkHome = "/path/to/java/home"
        }
Content copied to clipboard
    }
}

Example. Adds a Maven build step with Maven executable taken from M2_HOME environment variable, otherwise the current default version is used. Incremental Building is enabled, and local artifact repository settings is set to use a separate repository to store artifacts, produced by all builds of the current build configuration. IDEA-based code coverage is enabled.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        maven {
            goals = "clean install"
            mavenVersion = auto()
            localRepoScope = MavenBuildStep.RepositoryScope.BUILD_CONFIGURATION
            isIncremental = true

            coverageEngine = idea {
                includeClasses = """
                    org.myorg.*
                    org.package.sample
                """.trimIndent()
                excludeClasses = "org.myorg.test"
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Maven build step to be run inside a Docker container. This step will we executed only if build status is sucessfull for previous build steps and extra condition is met.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        maven {
            executionMode = BuildStep.ExecutionMode.RUN_ON_SUCCESS
            conditions {
                equals("teamcity.build.branch", "release")
            }

            goals = "clean install"
            mavenVersion = auto()

            dockerImage = "dockerImage"
            dockerImagePlatform = MavenBuildStep.ImagePlatform.Linux
            dockerPull = true
        }
Content copied to clipboard
    }
}

Constructors

MavenBuildStep

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

MavenBuildStep

fun MavenBuildStep()

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<MavenBuildStep.CoverageEngine>

ImagePlatform

enum ImagePlatform : Enum<MavenBuildStep.ImagePlatform>

Docker image platforms

MavenVersion

sealed class MavenVersion : CompoundParam<MavenBuildStep.MavenVersion>

RepositoryScope

enum RepositoryScope : Enum<MavenBuildStep.RepositoryScope>

Maven local repository scope.

Functions

auto

fun auto(): MavenBuildStep.MavenVersion.Auto

Maven version specified by the M2_HOME environment variable. If the environment variable is empty, then the default Maven version provided by TeamCity server will be used.

booleanParameter

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

bundled_2

fun bundled_2(): MavenBuildStep.MavenVersion.Bundled_2

Use maven 2 bundled with TeamCity

bundled_3_0

fun bundled_3_0(): MavenBuildStep.MavenVersion.Bundled_3_0

Use maven 3.0.5 bundled with TeamCity

bundled_3_1

fun bundled_3_1(): MavenBuildStep.MavenVersion.Bundled_3_1

Use maven 3.1.1 bundled with TeamCity

bundled_3_2

fun bundled_3_2(): MavenBuildStep.MavenVersion.Bundled_3_2

Use maven 3.2.5 bundled with TeamCity

bundled_3_3

fun bundled_3_3(): MavenBuildStep.MavenVersion.Bundled_3_3

Use maven 3.3.9 bundled with TeamCity

bundled_3_5

fun bundled_3_5(): MavenBuildStep.MavenVersion.Bundled_3_5

Use maven 3.5.4 bundled with TeamCity

bundled_3_6

fun bundled_3_6(): MavenBuildStep.MavenVersion.Bundled_3_6

Use maven 3.6.3 bundled with TeamCity

bundled_3_8

fun bundled_3_8(): MavenBuildStep.MavenVersion.Bundled_3_8

Use maven 3.8.6 bundled with TeamCity

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.

custom

fun custom(init: MavenBuildStep.MavenVersion.Custom.() -> Unit = {}): MavenBuildStep.MavenVersion.Custom

The custom Maven version found at the specified path

default

~~fun~~ ~~default~~(): MavenBuildStep.MavenVersion.Default

In TeamCity 10.0 the meaning of this option was: Maven version specified in M2_HOME environment variable, if the environment variable is empty, then the Maven version 3.0.5. In TeamCity 2017.1 this option is renamed to auto(), please use it instead. If you want to always use the default Maven version provided by TeamCity server, switch to defaultProvidedVersion().

defaultProvidedVersion

fun defaultProvidedVersion(): MavenBuildStep.MavenVersion.DefaultProvidedVersion

The default Maven version provided by TeamCity server

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

idea

fun idea(init: MavenBuildStep.CoverageEngine.Idea.() -> Unit = {}): MavenBuildStep.CoverageEngine.Idea

intParameter

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

jacoco

fun jacoco(init: MavenBuildStep.CoverageEngine.Jacoco.() -> Unit = {}): MavenBuildStep.CoverageEngine.Jacoco

param

fun param(name: String, value: String)

Adds parameter with specified name and value

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

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverageEngine

var coverageEngine: MavenBuildStep.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: MavenBuildStep.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 = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

goals

var goals: String?

Space-separated list of goals to execute

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.

isIncremental

var isIncremental: Boolean?

Enable incremental building

jdkHome

var jdkHome: String?

A path to JDK to use. By default the JAVA_HOME environment variable or the agent's own Java is used.

jvmArgs

var jvmArgs: String?

Space-separated list of additional arguments for JVM

localRepoScope

var localRepoScope: MavenBuildStep.RepositoryScope?

mavenVersion