Summary
Provides Bamboo build information for a current build.
- Namespace
- Cake
.Common .Build .Bamboo .Data - Base Types
-
- object
- BambooInfo
graph BT
Type-->Base0["BambooInfo"]
click Base0 "/api/Cake.Common.Build.Bamboo/BambooInfo"
Base0-->Base1["object"]
Type["BambooBuildInfo"]
class Type type-node
Syntax
public sealed class BambooBuildInfo : BambooInfo
Constructors
Name | Summary |
---|---|
BambooBuildInfo |
Initializes a new instance of the BambooBuildInfo class.
|
Properties
Name | Value | Summary |
---|---|---|
BuildKey | string |
Gets the job key for the current job, in the form PROJECT-PLAN-JOB, e.g. BAM-MAIN-JOBX.
|
BuildTimestamp | string |
Gets the time when build was started in ISO 8601 format e.g. 2010-01-01T01:00:00.000+01:00.
|
CustomBuild | Bamboo |
Gets Bamboo custom build information.
|
Folder | string |
Gets the path to the clone directory.
|
Number | int |
Gets the build number.
|
ResultKey | string |
Gets the Bamboo Build Result Key.
The result key when this job executes, in the form PROJECT-PLAN-JOB-BUILD e.g. BAM-BOO-JOB1-8, where '8' is the build number.
For deployment projects this variable will not have the JOB component e.g. PROJ-TP-6.
|
ResultsUrl | string |
Gets the URL of the result in Bamboo once the job has finished executing.
|
Methods
Name | Value | Summary |
---|---|---|
Get |
bool |
Gets an environment variable as a
bool .
Inherited from BambooInfo
|
Get |
int |
Gets an environment variable as a
int .
Inherited from BambooInfo
|
GetEnvironmentString |
string |
Gets an environment variable as a
string .
Inherited from BambooInfo
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|