WoodpeckerCIEnvironmentInfo Class

Summary

Provides WoodpeckerCI environment 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["WoodpeckerCIEnvironmentInfo"] class Type type-node

Syntax

public sealed class WoodpeckerCIEnvironmentInfo : WoodpeckerCIInfo

Constructors

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

Properties

Name Value Summary
CI string
Gets the CI environment name.
Commit WoodpeckerCICommitInfo
Gets WoodpeckerCI commit information.
Forge WoodpeckerCIForgeInfo
Gets WoodpeckerCI forge information.
Pipeline WoodpeckerCIPipelineInfo
Gets WoodpeckerCI pipeline information.
Repository WoodpeckerCIRepositoryInfo
Gets WoodpeckerCI repository information.
Step WoodpeckerCIStepInfo
Gets WoodpeckerCI step information.
System WoodpeckerCISystemInfo
Gets WoodpeckerCI system information.
Workflow WoodpeckerCIWorkflowInfo
Gets WoodpeckerCI workflow information.
Workspace DirectoryPath
Gets the workspace path.

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