Environment (Fake)

GitLab.Environment Type

Namespace: Fake.BuildServer
Assembly: Fake.BuildServer.GitLab.dll
Parent Module: GitLab
Base Type: obj

Exported environment variables during build. See the official documentation for details.

Static members

Static member	Description
`Environment.CommitBeforeSha` Full Usage: `Environment.CommitBeforeSha` Returns: `string`	The previous latest commit present on a branch before a push request. Returns: `string`
`Environment.CommitDescription` Full Usage: `Environment.CommitDescription` Returns: `string`	The description of the commit: the message without first line, if the title is shorter than 100 characters; full message in other case. Returns: `string`
`Environment.CommitMessage` Full Usage: `Environment.CommitMessage` Returns: `string`	The full commit message. Returns: `string`
`Environment.CommitRefName` Full Usage: `Environment.CommitRefName` Returns: `string`	The branch or tag name for which project is built Returns: `string`
`Environment.CommitRefSlug` Full Usage: `Environment.CommitRefSlug` Returns: `string`	`$CI_COMMIT_REF_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. Returns: `string`
`Environment.CommitSha` Full Usage: `Environment.CommitSha` Returns: `string`	The commit revision for which project is built Returns: `string`
`Environment.CommitTag` Full Usage: `Environment.CommitTag` Returns: `string`	The commit tag name. Present only when building tags. Returns: `string`
`Environment.CommitTitle` Full Usage: `Environment.CommitTitle` Returns: `string`	The title of the commit - the full first line of the message Returns: `string`
`Environment.ConfigPath` Full Usage: `Environment.ConfigPath` Returns: `string`	The path to CI config file. Defaults to .gitlab-ci.yml Returns: `string`
`Environment.DebugTrace` Full Usage: `Environment.DebugTrace` Returns: `bool`	Whether debug tracing is enabled Returns: `bool`
`Environment.DeployPassword` Full Usage: `Environment.DeployPassword` Returns: `string`	Authentication password of the GitLab Deploy Token, only present if the Project has one related. Returns: `string`
`Environment.DeployUser` Full Usage: `Environment.DeployUser` Returns: `string`	Authentication username of the GitLab Deploy Token, only present if the Project has one related. Returns: `string`
`Environment.DisposableEnvironment` Full Usage: `Environment.DisposableEnvironment` Returns: `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. Returns: `bool`
`Environment.EnvironmentName` Full Usage: `Environment.EnvironmentName` Returns: `string`	The name of the environment for this job Returns: `string`
`Environment.EnvironmentSlug` Full Usage: `Environment.EnvironmentSlug` Returns: `string`	A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, etc. Returns: `string`
`Environment.EnvironmentUrl` Full Usage: `Environment.EnvironmentUrl` Returns: `string`	The URL of the environment for this job Returns: `string`
`Environment.GetSourcesAttempts` Full Usage: `Environment.GetSourcesAttempts` Returns: `string`	Number of attempts to fetch sources running a job Returns: `string`
`Environment.GitlabCI` Full Usage: `Environment.GitlabCI` Returns: `string`	Mark that job is executed in GitLab CI environment Returns: `string`
`Environment.GitlabFeatures` Full Usage: `Environment.GitlabFeatures` Returns: `string`	The comma separated list of licensed features available for your instance and plan Returns: `string`
`Environment.GitlabUserEmail` Full Usage: `Environment.GitlabUserEmail` Returns: `string`	The email of the user who started the job Returns: `string`
`Environment.GitlabUserId` Full Usage: `Environment.GitlabUserId` Returns: `string`	The id of the user who started the job Returns: `string`
`Environment.GitlabUserLogin` Full Usage: `Environment.GitlabUserLogin` Returns: `string`	The login username of the user who started the job Returns: `string`
`Environment.GitlabUserName` Full Usage: `Environment.GitlabUserName` Returns: `string`	The real name of the user who started the job Returns: `string`
`Environment.JobId` Full Usage: `Environment.JobId` Returns: `string`	The unique id of the current job that GitLab CI uses internally Returns: `string`
`Environment.JobManual` Full Usage: `Environment.JobManual` Returns: `string`	The flag to indicate that job was manually started Returns: `string`
`Environment.JobName` Full Usage: `Environment.JobName` Returns: `string`	The name of the job as defined in .gitlab-ci.yml Returns: `string`
`Environment.JobStage` Full Usage: `Environment.JobStage` Returns: `string`	The name of the stage as defined in .gitlab-ci.yml Returns: `string`
`Environment.JobToken` Full Usage: `Environment.JobToken` Returns: `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 Returns: `string`
`Environment.JobUrl` Full Usage: `Environment.JobUrl` Returns: `string`	Job details URL Returns: `string`
`Environment.PipelineIID` Full Usage: `Environment.PipelineIID` Returns: `string`	The unique id of the current pipeline scoped to project Returns: `string`
`Environment.PipelineId` Full Usage: `Environment.PipelineId` Returns: `string`	The unique id of the current pipeline that GitLab CI uses internally Returns: `string`
`Environment.PipelineSource` Full Usage: `Environment.PipelineSource` Returns: `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 Returns: `string`
`Environment.PipelineTriggered` Full Usage: `Environment.PipelineTriggered` Returns: `bool`	The flag to indicate that job was triggered Returns: `bool`
`Environment.PipelineUrl` Full Usage: `Environment.PipelineUrl` Returns: `string`	Pipeline details URL Returns: `string`
`Environment.ProjectDir` Full Usage: `Environment.ProjectDir` Returns: `string`	The full path where the repository is cloned and where the job is run Returns: `string`
`Environment.ProjectId` Full Usage: `Environment.ProjectId` Returns: `string`	The unique id of the current project that GitLab CI uses internally Returns: `string`
`Environment.ProjectName` Full Usage: `Environment.ProjectName` Returns: `string`	The project name that is currently being built (actually it is project folder name) Returns: `string`
`Environment.ProjectNamespace` Full Usage: `Environment.ProjectNamespace` Returns: `string`	The project namespace (username or groupname) that is currently being built Returns: `string`
`Environment.ProjectPath` Full Usage: `Environment.ProjectPath` Returns: `string`	The namespace with project name Returns: `string`
`Environment.ProjectPathSlug` Full Usage: `Environment.ProjectPathSlug` Returns: `string`	`$CI_PROJECT_PATH` lowercased and with everything except 0-9 and a-z replaced with -. Use in URLs and domain names. Returns: `string`
`Environment.ProjectUrl` Full Usage: `Environment.ProjectUrl` Returns: `string`	The HTTP address to access project Returns: `string`
`Environment.ProjectVisibility` Full Usage: `Environment.ProjectVisibility` Returns: `string`	The project visibility (internal, private, public) Returns: `string`
`Environment.Registry` Full Usage: `Environment.Registry` Returns: `string`	If the Container Registry is enabled it returns the address of GitLab's Container Registry Returns: `string`
`Environment.RegistryImage` Full Usage: `Environment.RegistryImage` Returns: `string`	If the Container Registry is enabled for the project it returns the address of the registry tied to the specific project Returns: `string`
`Environment.RegistryPassword` Full Usage: `Environment.RegistryPassword` Returns: `string`	The password to use to push containers to the GitLab Container Registry Returns: `string`
`Environment.RegistryUser` Full Usage: `Environment.RegistryUser` Returns: `string`	The username to use to push containers to the GitLab Container Registry Returns: `string`
`Environment.RepositoryUrl` Full Usage: `Environment.RepositoryUrl` Returns: `string`	The URL to clone the Git repository Returns: `string`
`Environment.RestoreCacheAttempts` Full Usage: `Environment.RestoreCacheAttempts` Returns: `string`	Number of attempts to restore the cache running a job Returns: `string`
`Environment.RunnerDescription` Full Usage: `Environment.RunnerDescription` Returns: `string`	The description of the runner as saved in GitLab Returns: `string`
`Environment.RunnerExecutableArch` Full Usage: `Environment.RunnerExecutableArch` Returns: `string`	The OS/architecture of the GitLab Runner executable (note that this is not necessarily the same as the environment of the executor) Returns: `string`
`Environment.RunnerId` Full Usage: `Environment.RunnerId` Returns: `string`	The unique id of runner being used Returns: `string`
`Environment.RunnerRevision` Full Usage: `Environment.RunnerRevision` Returns: `string`	GitLab Runner revision that is executing the current job Returns: `string`
`Environment.RunnerTags` Full Usage: `Environment.RunnerTags` Returns: `string`	The defined runner tags Returns: `string`
`Environment.RunnerVersion` Full Usage: `Environment.RunnerVersion` Returns: `string`	GitLab Runner version that is executing the current job Returns: `string`
`Environment.Server` Full Usage: `Environment.Server` Returns: `bool`	Mark that job is executed in CI environment Returns: `bool`
`Environment.ServerName` Full Usage: `Environment.ServerName` Returns: `string`	The name of CI server that is used to coordinate jobs Returns: `string`
`Environment.ServerRevision` Full Usage: `Environment.ServerRevision` Returns: `string`	GitLab revision that is used to schedule jobs Returns: `string`
`Environment.ServerVersion` Full Usage: `Environment.ServerVersion` Returns: `string`	GitLab version that is used to schedule jobs Returns: `string`
`Environment.SharedEnvironment` Full Usage: `Environment.SharedEnvironment` Returns: `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. Returns: `bool`