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

BuildType

open class BuildType : BuildTypeSettings, Validatable

Represents TeamCity build configuration.

To appear in UI a buildType should be registered in a project using the buildType method.

The id and name are mandatory properties for a valid buildType (id can be omitted if it matches the class name).

BuildType settings are grouped into blocks similar to tabs in the build configuration admin UI:

options available on the General Settings tab are defined as properties
vcs() corresponds to the Version Control Settings tab
steps() - Build Steps tab
triggers() - Triggers tab
failureConditions() - Failure Conditions tab
features() - Build Features tab
dependencies() - Dependencies tab
params() - Parameters tab
requirements() - Agent Requirements tab

Example. Build configuration with a VCS root, VCS trigger and a single Gradle build step

object RunTests: BuildType({
  id("RunTests")
  name = "Run unit tests"
  description = "Runs all unit tests of the project"

  vcs {
    root(MyProjectVCSRoot)
  }

  steps {
    gradle {
      tasks = "clean build"
      buildFile = "build.gradle"
    }
  }

  triggers {
    vcs {}
  }
})

Example. Build configuration defined in-place

object Main: Project({
  name = "Main"
  description = "The project main branch"

  buildType {
    id("Build")
    name = "Build"

    steps {
      gradle {
        tasks = "clean build"
      }
    }
  }
})

Example. Composite build configuration

object Aggregate: BuildType({
  type = BuildTypeSettings.Type.COMPOSITE

  vcs {
    showDependenciesChanges = true
  }

  dependencies {
    snapshot(BuildPackage) { }
  }
}

Constructors

BuildType

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

Creates a buildType and initializes it with the specified init block

constructor()

Properties

allowExternalStatus

var allowExternalStatus: Boolean

If true, viewing of the configuration status is allowed externally. False by default.

artifactRules

var artifactRules: String

Artifact publishing rules. Empty by default, i.e. no artifacts will be published by the build.

buildNumberPattern

var buildNumberPattern: String

Build number pattern. By default "%build.counter%"

depParamRefs

open val depParamRefs: BuildTypeRefs

Helper for creating references to dependency parameters of this buildType.

description

var description: String

Description of a template or build configuration

detectHangingBuilds

var detectHangingBuilds: Boolean

Enables hanging builds detection. By default true.

enablePersonalBuilds

var enablePersonalBuilds: Boolean

Controls whether personal builds can be triggered in this build configuration. True by default.

generatedBuildConfigurationChecksum

var generatedBuildConfigurationChecksum: String

Checksum of settings that can be set in the build configurations generated by some plugin or REST API script

open override var id: Id?

BuildType or template id. It appears in the web UI and is used in urls. If the entity has a uuid specified, then the id can be changed at any time. If uuid is omitted, then TeamCity treats an entity with a changed id as a new entity, all data associated with the old entity will be lost (e.g. a build history). Id can also be used by some settings, e.g. as a part of parameter reference. If you change the id, you should find all its occurrences in the current project and change them too. Id must be unique across all buildTypes and templates on the server. If id is missing, it will be generated from the class name (if the class is not from the jetbrains.buildServer.configs.kotlin package).

maxRunningBuilds

var maxRunningBuilds: Int

Allows to set maximum number of simultaneously running builds. Default value is 0 - means there is no limit on a number of running builds. See also maxRunningBuildsPerBranch.

maxRunningBuildsPerBranch

var maxRunningBuildsPerBranch: String

Allows to set maximum number of simultaneously running builds per branch. Each line must be in form of branch:number, where branch is either a logical branch name or a pattern containing and number specifies the maximum number of builds which can be simultaneously running in each branch matching the pattern. 0 means there is no limit.

name

var name: String

Build configuration or template name. It must be unique across build configurations or templates in the same project.

paused

var paused: Boolean

Whether the buildType is paused

publishArtifacts

var publishArtifacts: PublishMode

Defines for which builds artifacts should be published. By default, the artifacts are published for successful and failed builds, but are not published for the cancelled and failed to start builds.

reverseDepParamRefs

open val reverseDepParamRefs: BuildTypeRefs

Helper for creating references to reverse dependency parameters of this buildType

templates

var templates: List<IdOwner>

Ids of the templates this buildType is based on

type

var type: BuildTypeSettings.Type

Type of this build configuration, when not specified treated as Type.REGULAR

uuid

var uuid: String

Build configuration or template uuid. If specified, TeamCity uses this uuid to identify the entity. If uuid is not specified, then id is used instead.

Functions

cleanup

fun cleanup(init: Cleanup.() -> Unit)

Configures build clean-up rules

create

open fun create(): BuildType

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

dependencies