JenkinsBuildInfo Class

Summary

Provides Jenkins build information for the current build.
Namespace
Cake.Common.Build.Jenkins.Data
Base Types
graph BT Type-->Base0["JenkinsInfo"] click Base0 "/api/Cake.Common.Build.Jenkins/JenkinsInfo" Base0-->Base1["object"] Type["JenkinsBuildInfo"] class Type type-node

Syntax

public sealed class JenkinsBuildInfo : JenkinsInfo

Constructors

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

Properties

Name Value Summary
BuildDisplayName string
Gets the display name of the build.
BuildId string
Gets the build identifier which is identical to BuildNumber starting from Jenkins 1.597 and a YYYY-MM-DD_hh-mm-ss timestamp for older builds.
BuildNumber int
Gets the build number.
BuildTag string
Gets the build tag which is a string of "jenkins-${JOB_NAME}-${BUILD_NUMBER}". All forward slashes (/) in the JOB_NAME are replaced with dashes (-).
BuildUrl string
Gets the build URL.
ExecutorNumber int
Gets the executor number.
Workspace string
Gets the absolute path of the workspace directory assigned to the build.

Methods

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

Extension Methods

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