This is part of the Fake.BuildServer.GitHubActions module.

Environment

Exported environment variables during build. See the official documentation for details.

Static members

Static memberDescription
Environment.Action
Signature: string

The unique identifier (id) of the action.

Environment.Actions
Signature: bool -> bool

Always set to true when GitHub Actions is running the workflow. You can use this variable to differentiate when tests are being run locally or by GitHub Actions.

Environment.Actor
Signature: string

The name of the person or app that initiated the workflow. For example, octocat.

Environment.BaseRef
Signature: string

Only set for forked repositories. The branch of the base repository.

Environment.CI
Signature: bool -> bool

Always set to true, if present.

Environment.EventName
Signature: string

The name of the webhook event that triggered the workflow.

Environment.EventPath
Signature: string

The path of the file with the complete webhook event payload. For example, /github/workflow/event.json.

Environment.HeadRef
Signature: string

Only set for forked repositories. The branch of the head repository.

Environment.Home
Signature: string

The path to the GitHub home directory used to store user data. For example, /github/home.

Environment.Ref
Signature: string

The branch or tag ref that triggered the workflow. For example, refs/heads/feature-branch-1. If neither a branch or tag is available for the event type, the variable will not exist.

Environment.Repository
Signature: string

The owner and repository name. For example, octocat/Hello-World.

Environment.RunId
Signature: string

A unique number for each run within a repository. This number does not change if you re-run the workflow run.

Environment.RunNumber
Signature: string

A unique number for each run of a particular workflow in a repository. This number begins at 1 for the workflow's first run, and increments with each new run. This number does not change if you re-run the workflow run.

Environment.Sha
Signature: string

The commit SHA that triggered the workflow. For example, ffac537e6cbbf934b08745a378932722df287a53.

Environment.Workflow
Signature: string

The name of the workflow.

Environment.Workspace
Signature: string

The GitHub workspace directory path. The workspace directory contains a subdirectory with a copy of your repository if your workflow uses the actions/checkout action. If you don't use the actions/checkout action, the directory will be empty. For example, /home/runner/work/my-repo-name/my-repo-name.