ContinuaCIBuildInfo Class

Summary

Provides Continua CI build information for a current build.
Namespace
Cake.Common.Build.ContinuaCI.Data
Base Types
graph BT Type-->Base0["ContinuaCIInfo"] click Base0 "/api/Cake.Common.Build.ContinuaCI/ContinuaCIInfo" Base0-->Base1["object"] Type["ContinuaCIBuildInfo"] class Type type-node

Syntax

public sealed class ContinuaCIBuildInfo : ContinuaCIInfo

Constructors

Name Summary
ContinuaCIBuildInfo(ICakeEnvironment, string) Initializes a new instance of the ContinuaCIBuildInfo class.

Properties

Name Value Summary
BuildNumber int
Gets the build number.
ChangesetCount int
Gets build the number of changesets associated with this build.
ChangesetRevisions IEnumerable<string>
Gets list of changeset revisions.
ChangesetTagNames IEnumerable<string>
Gets list of changeset tag names.
ChangesetUserNames IEnumerable<string>
Gets list of changeset user names.
Elapsed TimeSpan?
Gets build elapsed time on queue as a time span.
HasNewChanges bool
Gets a value indicating whether the build has new changes.
Id int
Gets the build id.
IsFeatureBranchBuild bool
Gets a value indicating whether the build uses the feature branch.
IssueCount int
Gets build the number of issues associated with this build.
LatestChangeset ContinuaCIChangesetInfo
Gets the latest build changeset.
Repositories IEnumerable<string>
Gets list of repository names.
RepositoryBranches IEnumerable<string>
Gets list of repository branch names.
Started DateTime?
Gets the build start date and time.
StartedBy string
Gets the name of the user or trigger starting the build.
TimeOnQueue long
Gets build time on queue in ticks.
TriggeringBranch string
Gets triggering branch name.
UsesDefaultBranch bool
Gets a value indicating whether the build uses the default branch.
Version string
Gets the build version.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from ContinuaCIInfo
GetEnvironmentDateTime(string) DateTime?
Gets an environment variable as a DateTime.
Inherited from ContinuaCIInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from ContinuaCIInfo
GetEnvironmentLong(string) long
Gets an environment variable as a long.
Inherited from ContinuaCIInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from ContinuaCIInfo
GetEnvironmentStringDictionary(string) IDictionary<string, string>
Gets matching list of environment variables as an dictionary of string.
Inherited from ContinuaCIInfo
GetEnvironmentStringList(string) IEnumerable<string>
Gets an environment variable as an array of string.
Inherited from ContinuaCIInfo
GetEnvironmentTimeSpan(string) TimeSpan?
Gets an environment variable as a TimeSpan.
Inherited from ContinuaCIInfo

Extension Methods

Name Value Summary
Dump<ContinuaCIBuildInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ContinuaCIBuildInfo>(ContinuaCIBuildInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ContinuaCIBuildInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ContinuaCIBuildInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ContinuaCIBuildInfo>(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<ContinuaCIBuildInfo>(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