TeamCity Kotlin DSL 2025.03/jetbrains.buildServer.configs.kotlin.buildFeatures/BuildCacheFeature

BuildCacheFeature

open class BuildCacheFeature : BuildFeature

fun BuildFeatures.buildCache(init: BuildCacheFeature.() -> Unit): BuildCacheFeature

Provides build cache functionality.

This feature is not recommended for builds that require a clean environment, such as release builds.

Example. Publish local .m2 directory with downloaded dependencies to the cache with name "maven-cache"

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        buildCache {
          name = "maven-cache"
          publish = true
          rules = ".m2"
        }
Content copied to clipboard
    }
}

Example. Publish a set of files to the cache

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        buildCache {
          name = "my-cache"
          publish = true
          rules = """
              target/artifact.jar
              settings.txt
          """.trimIndent()
        }
Content copied to clipboard
    }
}

Example. Use the given cache

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        buildCache {
          name = "my-cache"
          publish = false
        }
Content copied to clipboard
    }
}

Example. Publish and use the given cache in the same build. Publish cache only it was changed during the build.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        buildCache {
          name = "my-cache"
          publish = true
          rules = """
            target/artifact.jar
            settings.txt
          """.trimIndent()
          publishOnlyChanged = true
          use = true
        }
Content copied to clipboard
    }
}

Constructors

BuildCacheFeature

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

constructor()

Properties

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

name

var name: String?

Name of the cache

params

val params: List<Parameter>

publish

var publish: Boolean?

If true, publishes the files matched by rules to cache.

publishOnlyChanged

var publishOnlyChanged: Boolean?

If enabled, cache will be published only if it was used and its files were changed during the build.

rules

var rules: String?

Newline-separated list of paths relative to the checkout directory of the files or directories that should be cached. Wildcards are not supported.

type

var type: String

Build feature type

use

var use: Boolean?

If true, downloads cached files to the agent before the build steps are executed.

Functions

booleanParameter

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

clear

fun clear()

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(): BuildFeature

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