GitLabCIBuildInfo Class

Summary

Provide GitLab CI build information for a current build.
Namespace
Cake.Common.Build.GitLabCI.Data
Base Types
graph BT Type-->Base0["GitLabCIInfo"] click Base0 "/api/Cake.Common.Build.GitLabCI/GitLabCIInfo" Base0-->Base1["object"] Type["GitLabCIBuildInfo"] class Type type-node

Syntax

public sealed class GitLabCIBuildInfo : GitLabCIInfo

Constructors

Name Summary
GitLabCIBuildInfo(ICakeEnvironment) Initializes a new instance of the GitLabCIBuildInfo class.

Properties

Name Value Summary
Id int
Gets the unique id of the current build that GitLab CI uses internally.
Manual bool
Gets a value indicating whether the build was manually started.
Name string
Gets the name of the build as defined in .gitlab-ci.yml.
PipelineId int
Gets the unique id of the current pipeline that GitLab CI uses internally.
PipelineIId int
Gets the unique id of the current pipeline scoped to the project.
Reference string
Gets the commit revision for which project is built.
RefName string
Gets the branch or tag name for which project is built.
RepoUrl string
Gets the URL to clone the Git repository.
Stage string
Gets the name of the stage as defined in .gitlab-ci.yml.
Tag string
Gets the commit tag name. Present only when building tags.
Token string
Gets the token used for authenticating with the GitLab Container Registry.
Triggered bool
Gets a value indicating whether the build was triggered.
UserEmail string
Gets the email of the user who started the build.
UserId int
Gets the id of the user who started the build.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from GitLabCIInfo
GetEnvironmentBoolean(string, string) bool
Gets an environment variable as a bool.
Inherited from GitLabCIInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from GitLabCIInfo
GetEnvironmentInteger(string, string) int
Gets an environment variable as a int.
Inherited from GitLabCIInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from GitLabCIInfo
GetEnvironmentString(string, string) string
Gets an environment variable as a string.
Inherited from GitLabCIInfo

Extension Methods

Name Value Summary
Dump<GitLabCIBuildInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitLabCIBuildInfo>(GitLabCIBuildInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitLabCIBuildInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitLabCIBuildInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitLabCIBuildInfo>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GitLabCIBuildInfo>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin