GitLabCIProjectInfo Class

Summary

Provides GitLab CI project 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["GitLabCIProjectInfo"] class Type type-node

Syntax

public sealed class GitLabCIProjectInfo : GitLabCIInfo

Constructors

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

Properties

Name Value Summary
Directory string
Gets the full path where the repository is cloned and where the build is run.
Id int
Gets the unique id of the current project that GitLab CI uses internally.
Name string
Gets the project name that is currently being built.
Namespace string
Gets the project namespace (username or groupname) that is currently being built.
Path string
Gets the namespace with project name.
Url string
Gets the HTTP address to access the project.

Methods

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

Extension Methods

Name Value Summary
Dump<GitLabCIProjectInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitLabCIProjectInfo>(GitLabCIProjectInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitLabCIProjectInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitLabCIProjectInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitLabCIProjectInfo>(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
ThrowIfNull<GitLabCIProjectInfo>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin