WoodpeckerCICommitInfo Class

Summary

Provides WoodpeckerCI commit information for the current build.
Namespace
Cake.Common.Build.WoodpeckerCI.Data
Base Types
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
WoodpeckerCICommitInfo(ICakeEnvironment) 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
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from WoodpeckerCIInfo
GetEnvironmentDateTimeOffset(string) DateTimeOffset
Gets an environment variable as a DateTimeOffset from a Unix timestamp.
Inherited from WoodpeckerCIInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from WoodpeckerCIInfo
GetEnvironmentLong(string) long
Gets an environment variable as a long.
Inherited from WoodpeckerCIInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from WoodpeckerCIInfo
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
Inherited from WoodpeckerCIInfo

Extension Methods

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