TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/GradleCacheFeature

GradleCacheFeature

open class GradleCacheFeature : BuildFeature

fun BuildFeatures.gradleCache(init: GradleCacheFeature.() -> Unit): GradleCacheFeature

Caches Gradle dependencies to speed up the builds. The feature tracks shared cache directories (<gradle_user_home>/caches/modules-2) used by Gradle steps and caches dependencies in the artifact storage. The cache is automatically updated when dependencies of corresponding Gradle projects change.

Dependency caching is most effective on short-lived agents. For long-lived or permanent cloud agents, periodically review hidden .teamcity.build_cache build artifacts to monitor cache size and contents. This helps prevent redundant dependencies and unnecessary cache bloat.

Example. Enables Gradle dependency cache to speed up the builds

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        gradleCache {
        }
Content copied to clipboard
    }
}

Constructors

GradleCacheFeature

constructor(init: GradleCacheFeature.() -> 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

params

val params: List<Parameter>

type

var type: String

Build feature type

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