Table of Contents

Class GitHub.VariableNames

Namespace
Invex.Atom.Module.GitHubWorkflows
Assembly
Invex.Atom.Module.GitHubWorkflows.dll

Contains constant strings for all known GitHub Actions environment variable names.

public static class GitHub.VariableNames
Inheritance
object
GitHub.VariableNames

Fields

Actions

The name of the environment variable indicating if the workflow is running on GitHub Actions.

public const string Actions = "GITHUB_ACTIONS"

Field Value

string

Actor

The name of the actor that triggered the workflow.

public const string Actor = "GITHUB_ACTOR"

Field Value

string

ActorId

The ID of the actor that triggered the workflow.

public const string ActorId = "GITHUB_ACTOR_ID"

Field Value

string

ApiUrl

The URL of the GitHub API.

public const string ApiUrl = "GITHUB_API_URL"

Field Value

string

BaseRef

The base ref or target branch of the pull request in a pull_request event.

public const string BaseRef = "GITHUB_BASE_REF"

Field Value

string

Env

The path to a file that contains environment variables to set.

public const string Env = "GITHUB_ENV"

Field Value

string

EventName

The name of the event that triggered the workflow.

public const string EventName = "GITHUB_EVENT_NAME"

Field Value

string

EventPath

The path to the file that contains the complete event webhook payload.

public const string EventPath = "GITHUB_EVENT_PATH"

Field Value

string

GraphqlUrl

The URL of the GitHub GraphQL API.

public const string GraphqlUrl = "GITHUB_GRAPHQL_URL"

Field Value

string

HeadRef

The head ref or source branch of the pull request in a pull_request event.

public const string HeadRef = "GITHUB_HEAD_REF"

Field Value

string

Job

The name of the current job.

public const string Job = "GITHUB_JOB"

Field Value

string

Output

The path to a file that contains workflow commands to set outputs.

public const string Output = "GITHUB_OUTPUT"

Field Value

string

Path

The path to a file that contains paths to add to the system PATH.

public const string Path = "GITHUB_PATH"

Field Value

string

Ref

The Git ref that triggered the workflow (e.g., refs/heads/main).

public const string Ref = "GITHUB_REF"

Field Value

string

RefName

The short name of the Git ref that triggered the workflow.

public const string RefName = "GITHUB_REF_NAME"

Field Value

string

RefProtected

A boolean indicating if the ref is protected.

public const string RefProtected = "GITHUB_REF_PROTECTED"

Field Value

string

RefType

The type of the Git ref (e.g., branch, tag).

public const string RefType = "GITHUB_REF_TYPE"

Field Value

string

Repository

The owner and repository name (e.g., octocat/Hello-World).

public const string Repository = "GITHUB_REPOSITORY"

Field Value

string

RepositoryId

The ID of the repository.

public const string RepositoryId = "GITHUB_REPOSITORY_ID"

Field Value

string

RepositoryOwner

The owner of the repository.

public const string RepositoryOwner = "GITHUB_REPOSITORY_OWNER"

Field Value

string

RepositoryOwnerId

The ID of the repository owner.

public const string RepositoryOwnerId = "GITHUB_REPOSITORY_OWNER_ID"

Field Value

string

RetentionDays

The number of days to retain workflow runs and artifacts.

public const string RetentionDays = "GITHUB_RETENTION_DAYS"

Field Value

string

RunAttempt

The attempt number of the current workflow run.

public const string RunAttempt = "GITHUB_RUN_ATTEMPT"

Field Value

string

RunId

The unique ID of the workflow run.

public const string RunId = "GITHUB_RUN_ID"

Field Value

string

RunNumber

The unique number of the workflow run within the repository.

public const string RunNumber = "GITHUB_RUN_NUMBER"

Field Value

string

RunnerArch

The architecture of the runner machine (e.g., X64).

public const string RunnerArch = "RUNNER_ARCH"

Field Value

string

RunnerDebug

A boolean indicating if runner debugging is enabled.

public const string RunnerDebug = "RUNNER_DEBUG"

Field Value

string

RunnerEnvironment

The environment of the runner machine (e.g., github-hosted).

public const string RunnerEnvironment = "RUNNER_ENVIRONMENT"

Field Value

string

RunnerName

The name of the runner machine.

public const string RunnerName = "RUNNER_NAME"

Field Value

string

RunnerOs

The operating system of the runner machine (e.g., Linux, Windows).

public const string RunnerOs = "RUNNER_OS"

Field Value

string

RunnerPerfLog

The path to the runner performance log.

public const string RunnerPerfLog = "RUNNER_PERFLOG"

Field Value

string

RunnerTemp

The path to the runner's temporary directory.

public const string RunnerTemp = "RUNNER_TEMP"

Field Value

string

RunnerToolCache

The path to the runner's tool cache directory.

public const string RunnerToolCache = "RUNNER_TOOL_CACHE"

Field Value

string

RunnerTrackingId

The tracking ID of the runner.

public const string RunnerTrackingId = "RUNNER_TRACKING_ID"

Field Value

string

RunnerUser

The user account that the runner is running as.

public const string RunnerUser = "RUNNER_USER"

Field Value

string

RunnerWorkspace

The path to the runner's workspace directory.

public const string RunnerWorkspace = "RUNNER_WORKSPACE"

Field Value

string

ServerUrl

The URL of the GitHub server (e.g., https://github.com).

public const string ServerUrl = "GITHUB_SERVER_URL"

Field Value

string

Sha

The commit SHA that triggered the workflow.

public const string Sha = "GITHUB_SHA"

Field Value

string

State

The path to a file that contains workflow commands to save state.

public const string State = "GITHUB_STATE"

Field Value

string

StepSummary

The path to a file that contains content to append to the job summary.

public const string StepSummary = "GITHUB_STEP_SUMMARY"

Field Value

string

TriggeringActor

The actor that triggered the workflow, even if it was a bot.

public const string TriggeringActor = "GITHUB_TRIGGERING_ACTOR"

Field Value

string

Workflow

The name of the workflow.

public const string Workflow = "GITHUB_WORKFLOW"

Field Value

string

WorkflowRef

The full ref of the workflow file (e.g., octocat/Hello-World/.github/workflows/my-workflow.yml@refs/heads/main).

public const string WorkflowRef = "GITHUB_WORKFLOW_REF"

Field Value

string

WorkflowSha

The commit SHA of the workflow file.

public const string WorkflowSha = "GITHUB_WORKFLOW_SHA"

Field Value

string

Workspace

The path to the GitHub workspace directory.

public const string Workspace = "GITHUB_WORKSPACE"

Field Value

string