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
GitHubActionsWorkflowInfo(ICakeEnvironment)	Initializes a new instance of the `GitHubActionsWorkflowInfo` class.

Properties

Name	Value	Summary
Action	string	Gets the unique identifier of the action.
ActionPath	DirectoryPath	Gets the path where your action is located. You can use this path to access files located in the same repository as your action. This variable is only supported in composite run steps actions.
Actor	string	Gets the name of the person or app that initiated the workflow.
ApiUrl	string	Gets the API URL.
Attempt	int	Gets the number of attempts for current run.
BaseRef	string	Gets the branch of the base repository.
EventName	string	Gets the name of the webhook event that triggered the workflow.
EventPath	FilePath	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.
RefName	string	Gets the branch or tag name that triggered the workflow run.
RefProtected	bool	Gets a value indicating whether if branch protections are configured for the ref that triggered the workflow run.
RefType	GitHubActionsRefType	Gets the type of ref that triggered the workflow run.
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	DirectoryPath	Gets the GitHub workspace directory path.

Methods

Name	Value	Summary
GetEnvironmentBoolean(string)	bool	Gets an environment variable as a `bool`. Inherited from GitHubActionsInfo
GetEnvironmentDirectoryPath(string)	DirectoryPath	Gets an environment variable as a `DirectoryPath`. Inherited from GitHubActionsInfo
GetEnvironmentFilePath(string)	FilePath	Gets an environment variable as a `FilePath`. Inherited from GitHubActionsInfo
GetEnvironmentInteger(string)	int	Gets an environment variable as a `int`. Inherited from GitHubActionsInfo
GetEnvironmentString(string)	string	Gets an environment variable as a `string`. Inherited from GitHubActionsInfo

Extension Methods