Class GitHubContexts
- Namespace
- Invex.StructuredText.GithubActions
- Assembly
- Invex.StructuredText.GithubActions.dll
Typed references to the github context and the other contexts available to expressions.
public sealed class GitHubContexts
- Inheritance
-
objectGitHubContexts
Properties
Action
github.action: The name of the action currently running, or the id of a step.
public StringExpr Action { get; }
Property Value
ActionPath
github.action_path: The path where an action is located (composite actions only).
public StringExpr ActionPath { get; }
Property Value
ActionRef
github.action_ref: For a step executing an action, the ref of the action being executed.
public StringExpr ActionRef { get; }
Property Value
ActionRepository
github.action_repository: For a step executing an action, the owner and repository name of the action.
public StringExpr ActionRepository { get; }
Property Value
ActionStatus
github.action_status: For a composite action, the current result of the composite action.
public StringExpr ActionStatus { get; }
Property Value
Actor
github.actor: The username of the user that triggered the initial workflow run.
public StringExpr Actor { get; }
Property Value
ActorId
github.actor_id: The account id of the user that triggered the initial workflow run.
public StringExpr ActorId { get; }
Property Value
ApiUrl
github.api_url: The URL of the GitHub REST API.
public StringExpr ApiUrl { get; }
Property Value
BaseRef
github.base_ref: The base ref or target branch of the pull request (pull request events only).
public StringExpr BaseRef { get; }
Property Value
Context
github: The whole github context: information about the workflow run and the event that triggered it.
public JsonExpr Context { get; }
Property Value
Env
env: Variables set in the workflow, job or step. Index by name: Env["NAME"].
public JsonExpr Env { get; }
Property Value
Event
github.event: The full event webhook payload.
public GitHubContextsEventContext Event { get; }
Property Value
EventName
github.event_name: The name of the event that triggered the workflow run.
public StringExpr EventName { get; }
Property Value
EventPath
github.event_path: The path to the file on the runner that contains the full event webhook payload.
public StringExpr EventPath { get; }
Property Value
GitHubEnv
github.env: Path on the runner to the file that sets environment variables from workflow commands.
public StringExpr GitHubEnv { get; }
Property Value
GitHubJob
github.job: The job id of the current job.
public StringExpr GitHubJob { get; }
Property Value
GraphqlUrl
github.graphql_url: The URL of the GitHub GraphQL API.
public StringExpr GraphqlUrl { get; }
Property Value
HeadRef
github.head_ref: The head ref or source branch of the pull request (pull request events only).
public StringExpr HeadRef { get; }
Property Value
Inputs
inputs: The inputs of a reusable or manually triggered workflow. Index by input name.
public JsonExpr Inputs { get; }
Property Value
Job
job: Information about the currently running job.
public GitHubContextsJobContext Job { get; }
Property Value
Jobs
jobs: Results and outputs of jobs in a reusable workflow. Index by job id.
public JsonExpr Jobs { get; }
Property Value
Matrix
matrix: The matrix properties for the current job. Index by dimension name.
public JsonExpr Matrix { get; }
Property Value
Needs
needs: Outputs and results of the jobs the current job depends on. Index by job id.
public JsonExpr Needs { get; }
Property Value
Path
github.path: Path on the runner to the file that sets system PATH variables from workflow commands.
public StringExpr Path { get; }
Property Value
Ref
github.ref: The fully-formed ref of the branch or tag that triggered the workflow run.
public StringExpr Ref { get; }
Property Value
RefName
github.ref_name: The short ref name of the branch or tag that triggered the workflow run.
public StringExpr RefName { get; }
Property Value
RefProtected
github.ref_protected: Whether branch protections or rulesets are configured for the ref that triggered the run.
public BoolExpr RefProtected { get; }
Property Value
RefType
github.ref_type: The type of ref that triggered the workflow run: branch or tag.
public StringExpr RefType { get; }
Property Value
Repository
github.repository: The owner and repository name, e.g. octocat/Hello-World.
public StringExpr Repository { get; }
Property Value
RepositoryId
github.repository_id: The id of the repository.
public StringExpr RepositoryId { get; }
Property Value
RepositoryOwner
github.repository_owner: The repository owner's username.
public StringExpr RepositoryOwner { get; }
Property Value
RepositoryOwnerId
github.repository_owner_id: The repository owner's account id.
public StringExpr RepositoryOwnerId { get; }
Property Value
RepositoryUrl
github.repositoryUrl: The Git URL to the repository.
public StringExpr RepositoryUrl { get; }
Property Value
RetentionDays
github.retention_days: The number of days that workflow run logs and artifacts are kept.
public StringExpr RetentionDays { get; }
Property Value
RunAttempt
github.run_attempt: A unique number for each attempt of a particular workflow run.
public StringExpr RunAttempt { get; }
Property Value
RunId
github.run_id: A unique number for each workflow run within a repository.
public StringExpr RunId { get; }
Property Value
RunNumber
github.run_number: A unique number for each run of a particular workflow in a repository.
public StringExpr RunNumber { get; }
Property Value
Runner
runner: Information about the runner executing the current job.
public GitHubContextsRunnerContext Runner { get; }
Property Value
SecretSource
github.secret_source: The source of a secret used in a workflow: None, Actions, Codespaces or Dependabot.
public StringExpr SecretSource { get; }
Property Value
Secrets
secrets: The secrets available to the run. Index by name.
public GitHubContextsSecretsContext Secrets { get; }
Property Value
ServerUrl
github.server_url: The URL of the GitHub server.
public StringExpr ServerUrl { get; }
Property Value
Sha
github.sha: The commit SHA that triggered the workflow.
public StringExpr Sha { get; }
Property Value
Steps
steps: Information about the steps that have run in the current job. Index by step id.
public JsonExpr Steps { get; }
Property Value
Strategy
strategy: Information about the matrix execution strategy for the current job.
public GitHubContextsStrategyContext Strategy { get; }
Property Value
Token
github.token: A token to authenticate on behalf of the GitHub App installed on the repository.
public StringExpr Token { get; }
Property Value
TriggeringActor
github.triggering_actor: The username of the user that initiated the workflow run.
public StringExpr TriggeringActor { get; }
Property Value
Vars
vars: Configuration variables set at the organization, repository or environment level. Index by name.
public JsonExpr Vars { get; }
Property Value
Workflow
github.workflow: The name of the workflow.
public StringExpr Workflow { get; }
Property Value
WorkflowRef
github.workflow_ref: The ref path to the workflow.
public StringExpr WorkflowRef { get; }
Property Value
WorkflowSha
github.workflow_sha: The commit SHA for the workflow file.
public StringExpr WorkflowSha { get; }
Property Value
Workspace
github.workspace: The default working directory on the runner for steps.
public StringExpr Workspace { get; }