Summary
Provides WoodpeckerCI commit information for the current build.
- Namespace
- Cake
.Common .Build .WoodpeckerCI .Data - Base Types
-
- object
- WoodpeckerCIInfo
graph BT
Type-->Base0["WoodpeckerCIInfo"]
click Base0 "/api/Cake.Common.Build.WoodpeckerCI/WoodpeckerCIInfo"
Base0-->Base1["object"]
Type["WoodpeckerCICommitInfo"]
class Type type-node
Syntax
public class WoodpeckerCICommitInfo : WoodpeckerCIInfo
Constructors
| Name | Summary |
|---|---|
| Woodpecker |
Initializes a new instance of the WoodpeckerCICommitInfo class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Author | string |
Gets the commit author username.
|
| AuthorEmail | string |
Gets the commit author email address.
|
| Branch | string |
Gets the commit branch.
|
| Message | string |
Gets the commit message.
|
| PreRelease | bool |
Gets a value indicating whether the release is a pre-release.
|
| PullRequest | string |
Gets the commit pull request number.
|
| PullRequestLabels | string |
Gets the commit pull request labels.
|
| Ref | string |
Gets the commit ref.
|
| Refspec | string |
Gets the commit ref spec.
|
| Sha | string |
Gets the commit SHA.
|
| SourceBranch | string |
Gets the commit source branch.
|
| Tag | string |
Gets the commit tag name.
|
| TargetBranch | string |
Gets the commit target branch.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Get |
bool |
Gets an environment variable as a
bool.
Inherited from WoodpeckerCIInfo
|
| Get |
DateTimeOffset |
Gets an environment variable as a
DateTimeOffset from a Unix timestamp.
Inherited from WoodpeckerCIInfo
|
| Get |
int |
Gets an environment variable as a
int.
Inherited from WoodpeckerCIInfo
|
| GetEnvironmentLong |
long |
Gets an environment variable as a
long.
Inherited from WoodpeckerCIInfo
|
| GetEnvironmentString |
string |
Gets an environment variable as a
string.
Inherited from WoodpeckerCIInfo
|
| GetEnvironmentUri |
Uri |
Gets an environment variable as a
System.Uri.
Inherited from WoodpeckerCIInfo
|
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 IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp 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
|
