TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.triggers/MavenArtifactDependencyTrigger

MavenArtifactDependencyTrigger

open class MavenArtifactDependencyTrigger : Trigger

fun Triggers.mavenArtifact(init: MavenArtifactDependencyTrigger.() -> Unit): MavenArtifactDependencyTrigger

A trigger running builds when there is a modification of the maven dependency content.

Example. Adds a simple Maven Artifact Dependency Trigger for given atrifact the latest snapshot version with default Maven settings.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        mavenArtifact {
            groupId = "org.example.group"
            artifactId = "example-atrifact"
            version = "1.0-SNAPSHOT"
            userSettingsSelection = "userSettingsSelection:default"
        }
Content copied to clipboard
    }
}

Example. Adds a Maven Artifact Dependency Trigger for given atrifact with specified version range, custom classifier, Maven repository and user settings. This trigger will not trigger a build if currently running builds can produce this artifact.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        mavenArtifact {
            groupId = "org.example.group"
            artifactId = "example-atrifact"
            version = "[1.0,2.0)"
            classifier = "sources"
            repoUrl = "https://mypackages.org/maven/"
            repoId = "my-repo-id"
            skipIfRunning = true
            userSettingsSelection = "userSettingsSelection:byPath"
            userSettingsPath = "path/to/user/settings.xml"
        }
Content copied to clipboard
    }
}

Example. Adds a simple Maven Artifact Dependency Trigger for given atrifact the latest snapshot version with Maven settings provided on project level. Enables build customization which deletes all the files from the checkout directory for the triggered build and its dependencies and also adds a new parameter to the triggered build with the dependency parameter reference.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        mavenArtifact {
            groupId = "org.example.group"
            artifactId = "example-atrifact"
            version = "1.0-SNAPSHOT"
            userSettingsSelection = "settings.xml"

            enforceCleanCheckout = true
            enforceCleanCheckoutForDependencies = true
            buildParams {
                param("triggered.version", "dep.Project_BuildID.version")
            }
        }
Content copied to clipboard
    }
}

Constructors

MavenArtifactDependencyTrigger

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

constructor()

Properties

artifactId

var artifactId: String?

A watched maven artifact id

artifactType

var artifactType: String?

A type of the watched artifact. By default, the type is "jar".

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

classifier

var classifier: String?

Optional classifier of the watched artifact.

enabled

var enabled: Boolean

Specifies whether the trigger is enabled

enforceCleanCheckout

var enforceCleanCheckout: Boolean

Whether the build should be triggered with clean checkout

enforceCleanCheckoutForDependencies

var enforceCleanCheckoutForDependencies: Boolean

When the enforceCleanCheckout is set to true specifies whether the clean checkout should also be applied to all dependencies.

groupId

var groupId: String?

A maven group identifier to the watched artifact belongs to

var id: String?

Trigger id, if not set will be generated

params

val params: List<Parameter>

repoId

var repoId: String?

Maven repository ID to match authentication from applied maven settings

repoUrl

var repoUrl: String?

Maven repository URL

skipIfRunning

var skipIfRunning: Boolean?

Do not trigger a build if currently running builds can produce this artifact

type

var type: String

Trigger type

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.

version

var version: String?

Version or Version range

Functions

booleanParameter

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

buildParams

fun buildParams(init: TriggerBuildParameters.() -> Unit)

Configures build parameters that are applied to triggered builds

clear

fun clear()

clearBuildParams

fun clearBuildParams()

Deletes all configured build parameters

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): Trigger

Creates an instance of this trigger 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