WoodpeckerCIInfo Class

Summary

Base class used to provide information about the WoodpeckerCI environment.
Namespace
Cake.Common.Build.WoodpeckerCI
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["WoodpeckerCIInfo"] class Type type-node Derived0["WoodpeckerCIRepositoryInfo"]-->Type click Derived0 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIRepositoryInfo" Derived1["WoodpeckerCICommitInfo"]-->Type click Derived1 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCICommitInfo" Derived2["WoodpeckerCIPipelineInfo"]-->Type click Derived2 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIPipelineInfo" Derived3["WoodpeckerCISystemInfo"]-->Type click Derived3 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCISystemInfo" Derived4["WoodpeckerCIWorkflowInfo"]-->Type click Derived4 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIWorkflowInfo" Derived5["WoodpeckerCIForgeInfo"]-->Type click Derived5 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIForgeInfo" Derived6["WoodpeckerCIStepInfo"]-->Type click Derived6 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIStepInfo" Derived7["WoodpeckerCIEnvironmentInfo"]-->Type click Derived7 "/api/Cake.Common.Build.WoodpeckerCI.Data/WoodpeckerCIEnvironmentInfo"

Syntax

public abstract class WoodpeckerCIInfo

Constructors

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

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
GetEnvironmentDateTimeOffset(string) DateTimeOffset
Gets an environment variable as a DateTimeOffset from a Unix timestamp.
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
GetEnvironmentLong(string) long
Gets an environment variable as a long.
GetEnvironmentString(string) string
Gets an environment variable as a string.
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.

Extension Methods

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