Summary
Base class used to provide information about the WoodpeckerCI environment.
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 |
Initializes a new instance of the WoodpeckerCIInfo class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Get |
bool |
Gets an environment variable as a
bool.
|
| Get |
DateTimeOffset |
Gets an environment variable as a
DateTimeOffset from a Unix timestamp.
|
| Get |
int |
Gets an environment variable as a
int.
|
| GetEnvironmentLong |
long |
Gets an environment variable as a
long.
|
| GetEnvironmentString |
string |
Gets an environment variable as a
string.
|
| GetEnvironmentUri |
Uri |
Gets an environment variable as a
System.Uri.
|
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
|
