WoodpeckerCIPipelineInfo Class

Summary

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

Syntax

public class WoodpeckerCIPipelineInfo : WoodpeckerCIInfo

Constructors

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

Properties

Name Value Summary
Author string
Gets the pipeline author username.
Avatar Uri
Gets the pipeline author avatar.
Created DateTimeOffset
Gets the pipeline created timestamp.
DeployTarget string
Gets the pipeline deploy target.
DeployTask string
Gets the pipeline deploy task.
Event string
Gets the pipeline event.
Files string
Gets the pipeline files.
ForgeUrl Uri
Gets the pipeline forge URL.
Number int
Gets the pipeline number.
Parent int
Gets the pipeline parent number.
Started DateTimeOffset
Gets the pipeline started timestamp.
Url Uri
Gets the pipeline URL.

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