GitHubStatusSettings Class

Assembly
Cake.GitHub.dll
Namespace
Cake.GitHub
Base Types
graph BT Type-->Base0["GitHubSettingsBase"] click Base0 "/api/Cake.GitHub/GitHubSettingsBase" Base0-->Base1["Object"] Type["GitHubStatusSettings"] class Type type-node

Syntax

public class GitHubStatusSettings : GitHubSettingsBase

Constructors

Name Summary
GitHubStatusSettings()

Properties

Name Value Summary
Context string
A string label to differentiate this status from the status of other systems.

The default value is default.

Description string
A short description of the status.
State GitHubStatusState
The state of the status. Can be one of error, failure, pending, or success.
TargetUrl string
The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.

For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:

http://ci.example.com/user/repo/build/sha

Extension Methods

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