TeamCity Kotlin DSL 2026.1/jetbrains.buildServer.configs.kotlin.pipelines/Pipeline

Pipeline

open class Pipeline : Validatable, IdOwner

Represents TeamCity pipeline, which is a collection of jobs that can be executed in a specific order.

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

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

Pipeline settings are grouped into blocks:

job() - defines a job within the pipeline
repositories() - configures VCS repositories for the pipeline
triggers() - configures pipeline triggers
integrations() - configures pipeline integrations
params() - configures pipeline parameters

Example. Pipeline defined as an object with jobs

object DeployPipeline: Pipeline({
  id("DeployPipeline")
  name = "Deploy Pipeline"

  repositories {
    main(DslContext.settingsRoot)
  }

  job("build") {
    name = "Build Application"
    steps {
      gradle {
        tasks = "clean build"
      }
    }
  }

  job("test") {
    name = "Run Tests"
    steps {
      gradle {
        tasks = "test"
      }
    }
    dependency("build")
  }

  job("deploy") {
    name = "Deploy Application"
    steps {
      script {
        scriptContent = "deploy.sh"
      }
    }
    dependency("test")
  }
})

Example. Pipeline with VCS root and triggers

pipeline {
  id("CIPipeline")
  name = "CI Pipeline"

  triggers {
    vcs {
      branchFilter = "+:*"
    }
  }

  job("build") {
    name = "Build"
    steps {
      // job steps
    }
  }
}

Constructors

Pipeline

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

Creates a pipeline and initializes it with the specified init block.

constructor()

Properties

dependencies

val dependencies: Dependencies

open override var id: Id?

integrations

val integrations: PipelineIntegrations

jobs

val jobs: MutableList<Job>

Pipeline jobs

name

var name: String

Pipeline name

outputParams

val outputParams: Parametrized

Pipeline output parameters exposed to downstream pipelines and build configurations.

params

val params: ParametrizedWithType

Pipeline parameters

repositories

val repositories: PipelineRepositories

Pipeline repositories

triggers

val triggers: PipelineTriggers

Functions

create

open fun create(): Pipeline

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

fun dependencies(init: Dependencies.() -> Unit)

Configures dependencies

fun id(id: String)

Sets the relative part of the id to the specified value.

integrations

fun integrations(init: PipelineIntegrations.() -> Unit)

Configures pipeline integrations.

job

fun job(job: Job)

fun job(init: Job.() -> Unit): Job

Adds a job to the pipeline.

outputParams

fun outputParams(init: Parametrized.() -> Unit)

Configures pipeline output parameters. Output parameters are exposed to downstream pipelines and build configurations via %dep.PipelineId.paramName% syntax.

params