GitLab CI Kotlin DSL • opensavvy.gitlab.ci • Environment

Environment

class Environment : YamlExport

Declares which environment this job interacts with.

To declare the environment, see Job.environment.

Types

EnvironmentAction

enum EnvironmentAction : Enum<Environment.EnvironmentAction> 

EnvironmentTier

enum EnvironmentTier : Enum<Environment.EnvironmentTier> 

Functions

action

fun action(action: Environment.EnvironmentAction)

Specify how this job interacts with the environment. See EnvironmentAction.

name

fun name(name: String)

Declares the name of the environment, as it will be displayed in the GitLab UI.

stopJob

fun stopJob(stopJob: Job)

Specifies a stopJob that will be executed once the environment should be stopped.

tier

fun tier(tier: Environment.EnvironmentTier)

Declares which tier this job deploys.

toYaml

open override fun toYaml(): Yaml

Converts this object into a Yaml object.

url

fun url(url: String)

Declares the URL on which the deployed environment is available.