Environment

Static members

Static memberDescription
Environment.CommitBeforeSha
Signature: string

The previous latest commit present on a branch before a push request.

Environment.CommitDescription
Signature: string

The description of the commit: the message without first line, if the title is shorter than 100 characters; full message in other case.

Environment.CommitMessage
Signature: string

The full commit message.

Environment.CommitRefName
Signature: string

The branch or tag name for which project is built

Environment.CommitRefSlug
Signature: string

$CICOMMITREF_NAME lowercased, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.

Environment.CommitSha
Signature: string

The commit revision for which project is built

Environment.CommitTag
Signature: string

The commit tag name. Present only when building tags.

Environment.CommitTitle
Signature: string

The title of the commit - the full first line of the message

Environment.ConfigPath
Signature: string

The path to CI config file. Defaults to .gitlab-ci.yml

Environment.DebugTrace
Signature: bool

Whether debug tracing is enabled

Environment.DeployPassword
Signature: string

Authentication password of the GitLab Deploy Token, only present if the Project has one related.

Environment.DeployUser
Signature: string

Authentication username of the GitLab Deploy Token, only present if the Project has one related.

Environment.DisposableEnvironment
Signature: bool

Marks that the job is executed in a disposable environment (something that is created only for this job and disposed of/destroyed after the execution - all executors except shell and ssh). If the environment is disposable, it is set to true, otherwise it is not defined at all.

Environment.EnvironmentName
Signature: string

The name of the environment for this job

Environment.EnvironmentSlug
Signature: string

A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, etc.

Environment.EnvironmentUrl
Signature: string

The URL of the environment for this job

Environment.GetSourcesAttempts
Signature: string

Number of attempts to fetch sources running a job

Environment.GitlabCI
Signature: string

Mark that job is executed in GitLab CI environment

Environment.GitlabFeatures
Signature: string

The comma separated list of licensed features available for your instance and plan

Environment.GitlabUserEmail
Signature: string

The email of the user who started the job

Environment.GitlabUserId
Signature: string

The id of the user who started the job

Environment.GitlabUserLogin
Signature: string

The login username of the user who started the job

Environment.GitlabUserName
Signature: string

The real name of the user who started the job

Environment.JobId
Signature: string

The unique id of the current job that GitLab CI uses internally

Environment.JobManual
Signature: string

The flag to indicate that job was manually started

Environment.JobName
Signature: string

The name of the job as defined in .gitlab-ci.yml

Environment.JobStage
Signature: string

The name of the stage as defined in .gitlab-ci.yml

Environment.JobToken
Signature: string

Token used for authenticating with GitLab Container Registry, downloading dependent repositories, authenticate with multi-project pipelines when triggers are involved, and for downloading job artifacts

Environment.JobUrl
Signature: string

Job details URL

Environment.PipelineId
Signature: string

The unique id of the current pipeline that GitLab CI uses internally

Environment.PipelineIID
Signature: string

The unique id of the current pipeline scoped to project

Environment.PipelineSource
Signature: string

Indicates how the pipeline was triggered. Possible options are: push, web, trigger, schedule, api, and pipeline. For pipelines created before GitLab 9.5, this will show as unknown

Environment.PipelineTriggered
Signature: bool

The flag to indicate that job was triggered

Environment.PipelineUrl
Signature: string

Pipeline details URL

Environment.ProjectDir
Signature: string

The full path where the repository is cloned and where the job is run

Environment.ProjectId
Signature: string

The unique id of the current project that GitLab CI uses internally

Environment.ProjectName
Signature: string

The project name that is currently being built (actually it is project folder name)

Environment.ProjectNamespace
Signature: string

The project namespace (username or groupname) that is currently being built

Environment.ProjectPath
Signature: string

The namespace with project name

Environment.ProjectPathSlug
Signature: string

$CIPROJECTPATH lowercased and with everything except 0-9 and a-z replaced with -. Use in URLs and domain names.

Environment.ProjectUrl
Signature: string

The HTTP address to access project

Environment.ProjectVisibility
Signature: string

The project visibility (internal, private, public)

Environment.Registry
Signature: string

If the Container Registry is enabled it returns the address of GitLab's Container Registry

Environment.RegistryImage
Signature: string

If the Container Registry is enabled for the project it returns the address of the registry tied to the specific project

Environment.RegistryPassword
Signature: string

The password to use to push containers to the GitLab Container Registry

Environment.RegistryUser
Signature: string

The username to use to push containers to the GitLab Container Registry

Environment.RepositoryUrl
Signature: string

The URL to clone the Git repository

Environment.RestoreCacheAttempts
Signature: string

Number of attempts to restore the cache running a job

Environment.RunnerDescription
Signature: string

The description of the runner as saved in GitLab

Environment.RunnerExecutableArch
Signature: string

The OS/architecture of the GitLab Runner executable (note that this is not necessarily the same as the environment of the executor)

Environment.RunnerId
Signature: string

The unique id of runner being used

Environment.RunnerRevision
Signature: string

GitLab Runner revision that is executing the current job

Environment.RunnerTags
Signature: string

The defined runner tags

Environment.RunnerVersion
Signature: string

GitLab Runner version that is executing the current job

Environment.Server
Signature: bool

Mark that job is executed in CI environment

Environment.ServerName
Signature: string

The name of CI server that is used to coordinate jobs

Environment.ServerRevision
Signature: string

GitLab revision that is used to schedule jobs

Environment.ServerVersion
Signature: string

GitLab version that is used to schedule jobs

Environment.SharedEnvironment
Signature: bool

Marks that the job is executed in a shared environment (something that is persisted across CI invocations like shell or ssh executor). If the environment is shared, it is set to true, otherwise it is not defined at all.