jetbrains.buildServer.configs.kotlin.v2017_2.buildSteps / MavenBuildStep

MavenBuildStep

open class MavenBuildStep : BuildStep

A build step running maven

See Also

maven

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<CoverageEngine>

ImagePlatform

enum class ImagePlatform

Docker image platforms

MavenVersion

sealed class MavenVersion : CompoundParam<MavenVersion>

RepositoryScope

enum class RepositoryScope

Maven local repository scope.

Constructors

<init>

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

A build step running maven

Properties

coverageEngine

var coverageEngine: 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: ImagePlatform?

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

dockerPull

var dockerPull: Boolean?

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

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

goals

var goals: String?

Space-separated list of goals to execute

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: RepositoryScope?

mavenVersion

var mavenVersion: MavenVersion?

Maven version to use

pomLocation

var pomLocation: String?

Path to POM file. Should be relative to the checkout directory.

runnerArgs

var runnerArgs: String?

Additional Maven command line parameters.

useOwnLocalRepo

var useOwnLocalRepo: Boolean?

Use own local artifact repository

userSettingsPath

var userSettingsPath: String?

The path to a user settings file

userSettingsSelection

var userSettingsSelection: String?

Use one of the predefined settings files or provide a custom path. By default, the standard Maven settings file location is used.

workingDir

var workingDir: String?

Custom working directory for maven. If not specified, the checkout directory is used.

Inherited Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: ExecutionMode

Build step execution mode

id

var id: String?

Id of the step, if not specified will be generated

name

var name: String

Build step name

type

var type: String

Build step type

Functions

auto

fun auto(): 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.

bundled_2

fun bundled_2(): Bundled_2

Use maven 2 bundled with TeamCity

bundled_3_0

fun bundled_3_0(): Bundled_3_0

Use maven 3.0.5 bundled with TeamCity

bundled_3_1

fun bundled_3_1(): Bundled_3_1

Use maven 3.1.1 bundled with TeamCity

bundled_3_2

fun bundled_3_2(): Bundled_3_2

Use maven 3.2.5 bundled with TeamCity

bundled_3_3

fun bundled_3_3(): Bundled_3_3

Use maven 3.3.9 bundled with TeamCity

bundled_3_5

fun bundled_3_5(): Bundled_3_5

Use maven 3.5.4 bundled with TeamCity

bundled_3_6

fun bundled_3_6(): Bundled_3_6

Use maven 3.6.3 bundled with TeamCity

custom

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

The custom Maven version found at the specified path

default

fun default(): 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(): DefaultProvidedVersion

The default Maven version provided by TeamCity server

idea

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

jacoco

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

validate

open fun validate(consumer: ErrorConsumer): Unit

Validates this object and reports found errors to the provided consumer

Inherited Functions

clearConditions

fun clearConditions(): Unit

Deletes all configured build step conditions

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {}): Unit

Configures build step conditions

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.

toString

open fun toString(): String