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

Cleanup

Specifies clean-up rules for project, build configuration, or template

Example. Keep all builds finished within 5 days after the last build

cleanup {
    keepRule {
        id = "MyCleanupRule"
        keepAtLeast = days(5) {
            since = lastBuild()
        }
        dataToKeep = everything()
        applyPerEachBranch = true
        preserveArtifactsDependencies = true
    }
}

This cleanup rule tells TeamCity to keep all the builds which were fiished within 5 days since the last build.

The builds are kept per each branch individually.

Example. Keep not more than 10 personal builds

cleanup {
    keepRule {
        id = "Keep10PersonalBuilds"
        keepAtLeast = builds(10)
        applyToBuilds {
            inPersonalBuilds = onlyPersonal()
        }
        dataToKeep = everything()
        preserveArtifactsDependencies = true
    }
}

Note: this should not be the only cleanup rule in the project, otherwise all other non-personal builds will be removed.

Example. Keep per-build statistics data for every build produced within 365 days since the last build

cleanup {
    keepRule {
        id = "KeepStatisticsFor1Year"
        keepAtLeast = days(365) {
          since = lastBuild()
        }
        dataToKeep = statisticsOnly()
    }
}

Note: dataToKeep = statisticsOnly() means that only statistic values will be preserved for the builds, everything else, like build logs, artifacts and the build itself will be removed. Preserved statistics values still allow to show data on the custom charts for such builds.

Example. Sets custom base cleanup rules options.

cleanup {
    baseRule {
        history(builds = 3, days = 5)
        artifacts(builds = 3, days = 5, artifactPatterns = "+:log*")
        preventDependencyCleanup = true
    }
}

Constructors

Cleanup

constructor()

Types

BaseRuleWrapper

inner class BaseRuleWrapper

Holds a base rule

KeepRule

class KeepRule

Specifies a keep rule. A keep rule defines what particular data to preserve during the clean-up. Multiple keep rules can be assigned to a project or build configuration.

Properties

keepRules

val keepRules: ArrayList<Cleanup.KeepRule>

preventDependencyCleanup

var preventDependencyCleanup: Boolean?

Specifies whether dependency builds should be cleaned. Null means use default, true means prevent clean-up, false means don't prevent clean-up.

Functions

all

fun all(days: Int? = null, builds: Int? = null)

Adds an 'everything'-level clean-up rule. Either days or builds must be non-null. If they are both null, clean-up will not be configured.

artifacts

fun artifacts(days: Int? = null, builds: Int? = null, artifactPatterns: String? = null)

Adds an artifacts-level clean-up rule. Either days or builds must be non-null. If they are both null, clean-up will not be configured.

baseRule

fun baseRule(init: Cleanup.BaseRuleWrapper.() -> Unit)

Specifies a base rule. A base rule defines what data to clean up in general. Allows preserving a specified number of successful builds and/or choose the time period to keep builds in the history.

copy

fun Cleanup.copy(): Cleanup

Copies the receiver cleanup

copyTo