Summary
Provide GitHub Actions workflow information for a current build.
- Namespace
- Cake
.Common .Build .GitHubActions .Data - Base Types
-
- object
- GitHubActionsInfo
graph BT
Type-->Base0["GitHubActionsInfo"]
click Base0 "/api/Cake.Common.Build.GitHubActions/GitHubActionsInfo"
Base0-->Base1["object"]
Type["GitHubActionsWorkflowInfo"]
class Type type-node
Syntax
public sealed class GitHubActionsWorkflowInfo : GitHubActionsInfo
Constructors
Name | Summary |
---|---|
Git |
Initializes a new instance of the GitHubActionsWorkflowInfo class.
|
Properties
Name | Value | Summary |
---|---|---|
Action | string |
Gets the unique identifier of the action.
|
Actor | string |
Gets the name of the person or app that initiated the workflow.
|
ApiUrl | string |
Gets the API URL.
|
BaseRef | string |
Gets the branch of the base repository.
|
EventName | string |
Gets the name of the webhook event that triggered the workflow.
|
EventPath | string |
Gets the path of the file with the complete webhook event payload.
|
GraphQLUrl | string |
Gets the GraphQL API URL.
|
HeadRef | string |
Gets the branch of the head repository.
|
Job | string |
Gets the job name.
|
Ref | string |
Gets the branch or tag ref that triggered the workflow.
|
Repository | string |
Gets the owner and repository name.
|
RepositoryOwner | string |
Gets the repository owner.
|
RunId | string |
Gets the unique number for each run within the repository.
|
RunNumber | int |
Gets the unique number for each run of a particular workflow in the repository.
|
ServerUrl | string |
Gets the URL of the GitHub server.
|
Sha | string |
Gets the commit SHA that triggered the workflow.
|
Workflow | string |
Gets the name of the workflow.
|
Workspace | string |
Gets the GitHub workspace directory path.
|
Methods
Name | Value | Summary |
---|---|---|
Get |
bool |
Gets an environment variable as a
bool .
Inherited from GitHubActionsInfo
|
Get |
int |
Gets an environment variable as a
int .
Inherited from GitHubActionsInfo
|
GetEnvironmentString |
string |
Gets an environment variable as a
string .
Inherited from GitHubActionsInfo
|
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 Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator 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
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|