JenkinsChangeInfo Class

Summary

Provides Jenkins change information for the current build in multibranch projects.
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["JenkinsChangeInfo"] class Type type-node

Syntax

public class JenkinsChangeInfo : JenkinsInfo

Constructors

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

Properties

Name Value Summary
Author string
Gets change author.
AuthorDisplayName string
Gets the human name of the change author.
AuthorEmail string
Gets the email address of the change author.
Branch string
Gets the origin branch of the change.
Fork string
Gets the fork name of the change.
Id string
Gets the change id.
IsPullRequest bool
Gets a value indicating whether the current build was started by a pull request.
Target string
Gets the target/base branch of the change.
Title string
Gets the change title.
Url string
Gets the change URL.

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