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

Pipeline

open class ~~Pipeline~~ : Validatable, IdOwner

Deprecated

Pipelines DSL is in development and should not be used. Breaking changes are expected.

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 jetbrains.buildServer.configs.kotlin.Project.pipeline method.

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

Pipeline settings are grouped into blocks:

job() - defines a job within the pipeline
triggers() - configures pipeline triggers
integrations() - configures pipeline integrations
notifications() - configures pipeline notifications
params() - configures pipeline parameters

Example. Pipeline defined as an object with jobs

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

  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"

  val vcsRoot = GitVcsRoot({
    name = "Main Repository"
    url = "https://github.com/example/repo.git"
    branch = "refs/heads/main"
  })

  mainVcsRoot = PipelineOwnVcsRoot(vcsRoot)

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

Types

PipelineExternalVcsRoot

inner class PipelineExternalVcsRoot(val entity: IdOwner) : Pipeline.PipelineVcsRoot

Represents a reference to an external VCS root.

PipelineOwnVcsRoot

inner class PipelineOwnVcsRoot(val vcsRoot: VcsRoot) : Pipeline.PipelineVcsRoot

Represents a VCS root defined within the pipeline.

PipelineVcsRoot

sealed interface PipelineVcsRoot

Interface for pipeline VCS roots. A pipeline can have either a PipelineOwnVcsRoot or a PipelineExternalVcsRoot.

Properties

additionalVcsRoots

val additionalVcsRoots: MutableList<VcsRoot>

Additional VCS roots for the pipeline.

open override var id: Id?

integrations

val integrations: PipelineIntegrations

jobs

val jobs: MutableList<Job>

Pipeline jobs

mainVcsRoot

var mainVcsRoot: Pipeline.PipelineVcsRoot?

Main VCS root for the pipeline. This is a required property. Can be set using either PipelineOwnVcsRoot or PipelineExternalVcsRoot.

name

var name: String

Pipeline name

notifications

val notifications: PipelineNotifications

params

val params: ParametrizedWithType

Pipeline parameters

triggers

val triggers: PipelineTriggers

Functions

additionalVcsRoot

fun additionalVcsRoot(root: VcsRoot)

Adds an additional VCS root to the pipeline.

fun additionalVcsRoot(init: VcsRoot.() -> Unit): VcsRoot

Adds a new additional VCS root initialized with the specified block.

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.