This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.GitHub.
- Assembly
- Cake
.GitHub .dll - Namespace
- Cake
.GitHub - Base Types
-
- Object
- GitHubSettingsBase
graph BT
Type-->Base0["GitHubSettingsBase"]
click Base0 "/api/Cake.GitHub/GitHubSettingsBase"
Base0-->Base1["Object"]
Type["GitHubStatusSettings"]
class Type type-node
Syntax
public class GitHubStatusSettings : GitHubSettingsBaseAttributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
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 |
| 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:
|
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 |
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 |
From StringExtensions
Requires the Cake.Issues addin
|