0.6.0

GitLab CI Kotlin DSL/opensavvy.gitlab.ci

Package-level declarations

Jobs, stages, dependencies and more: declaring a GitLab CI pipeline from Kotlin.

Most of the objects are identical, or very similar, to their equivalent in the Yaml format. Some have been renamed or restructured for readability.

Overview

A pipeline is created by the gitlabCi function. It can be converted to Yaml by calling its println function:

gitlabCi {
	// Declare your pipeline here
}.println()

A pipeline is composed of stages, themselves composed of jobs. Each job is a unit of work, which will be executed independently by GitLab. A job can do anything that you can write a program for. Most commonly, jobs use Docker images to provide a ready-to-use environment.

gitlabCi {
	// Create two stages: test and deploy
	val test by stage()
	val deploy by stage()

	// First job to test our app
	val build by job(stage = test) {
		image("ubuntu")

		script {
			shell("make")
		}

		artifacts {
			// The 'build' directory will be stored when the job is over
			include("build")
		}
	}

	if (Value.isDefaultBranch) {
		val publish by job(stage = deploy) {
			image("ubuntu")

			// Wait for 'build' to finish before starting,
			// and download the artifacts it generated
			dependsOn(build, artifacts = true)

			script {
				// Add your own logic
			}
		}
	}
}.println()

Reading order

Start with gitlabCi, stages and jobs.

Types

class Artifacts : YamlExport

class Cache : YamlExport

open class ContainerImage : YamlExport

ContainerService

class ContainerService : ContainerImage

data class Depends(val job: Job, val artifacts: Boolean, val optional: Boolean) : YamlExport

class GitLabCi : YamlExport

Entrypoint to the GitLab CI pipeline generation.

annotation class GitLabCiDsl

Marker for APIs that are part of the GitLab CI DSL.

class Job : YamlExport

A single execution step in a pipeline.

class Retry : YamlExport

Configuration for job retry behavior.

enum RetryCause : Enum<RetryCause> , YamlExport

Failure types that can be used with Retry.on.

data class Stage(val name: String)

A stage in a pipeline.

object Value

object Variable

Predefined variables in GitLab CI.

enum When : Enum<When> , YamlExport

interface YamlExport

Objects that can be converted to Yaml.

Functions

fun gitlabCi(block: GitLabCi.() -> Unit): <Error class: unknown class>

Convenience factory function for GitLabCi.

fun GitLabCi.job(name: String, stage: Stage? = null, block: Job.() -> Unit): <Error class: unknown class>

fun GitLabCi.job(name: String? = null, stage: Stage? = null, block: Job.() -> Unit = {}): <Error class: unknown class>

Declares a new Job in the current pipeline.

fun GitLabCi.stage(name: String): Stage

Creates a stage with a given name.

fun GitLabCi.stage(name: String? = null): DelegateProvider<parent: GitLabCi, ReadOnlyDelegate<Stage>>

Creates a stage automatically named after the variable it is assigned to.