TeamCity Kotlin DSL

TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/ArtifactDependency

ArtifactDependency

class ArtifactDependency

TeamCity artifact dependency.

Example. Artifact dependency on artifacts of some pinned build

See also artifact dependency

dependencies {
    artifacts(AnotherBuild) {
        buildRule = lastPinned()
        // this rule will find all the jar files in the build artifacts root directory
        // and place them under the "library" folder on the agent
        artifactRules = "*.jar => libraries"
        // this will ensure that "libraries" folder is cleaned up before the .jar files are placed there
        cleanDestination = true
    }
}

Example. Artifact dependency on a build outside of Kotlin DSL project

dependencies {
    artifacts(AbsoluteId("Another_Project_Library")) {
        buildRule = lastSuccessful()
        artifactRules = "*.jar => libraries"
        cleanDestination = true
    }
}

In this example "Another_Project_Library" is an id of a build configuration which is not defined in the Kotlin DSL project, but exists somewhere else in the TeamCity projects hierarchy.

Constructors

ArtifactDependency

fun ArtifactDependency()

Functions

fun build(buildNumber: String): BuildRule

Creates a build rule matching a build with the specified build number

fun lastFinished(branch: String? = null): BuildRule

Creates a build rule matching the last finished build in the specified branch

fun lastPinned(branch: String? = null): BuildRule

Creates a build rule matching a last pinned build in the specified branch

fun lastSuccessful(branch: String? = null): BuildRule

Creates a build rule matching the last successful build in the specified branch

sameChainOrLastFinished

fun sameChainOrLastFinished(): BuildRule

Creates a build rule matching the build from the same build chain or last finished build

fun tag(tag: String, branch: String? = null): BuildRule

Creates a build rule matching a build with the specified tag in the specified branch

Properties

var artifactRules: String

New-line separated list of artifact rules specifying the way artifacts from the dependency should be copied. Mandatory, empty by default.

var buildRule: BuildRule

Rule for selecting a dependency build, when not specified sameChainOrLastFinished is used

cleanDestination

var cleanDestination: Boolean = false

Whether destination directory on agent should be cleaned before copying artifacts, false by default

var enabled: Boolean = true

Allows to disable the dependency, it is enabled by default

var id: String? = null

Dependency id, if not specified will be generated

var rules: List<ArtifactRule>

Typed API for artifactRules

Extensions

fun ArtifactDependency.copy(): ArtifactDependency

Copies the receiver artifact dependency