Environment (Fake)

6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See

GitHubActions.Environment Type

Namespace: Fake.BuildServer
Assembly: Fake.BuildServer.GitHubActions.dll
Parent Module: GitHubActions
Base Type: obj

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

Static members

Static member	Description
`Environment.Action` Full Usage: `Environment.Action` Returns: `string`	The unique identifier (id) of the action. Returns: `string`
`Environment.Actions` Full Usage: `Environment.Actions` Returns: `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. Returns: `bool -> bool`
`Environment.Actor` Full Usage: `Environment.Actor` Returns: `string`	The name of the person or app that initiated the workflow. For example, octocat. Returns: `string`
`Environment.BaseRef` Full Usage: `Environment.BaseRef` Returns: `string`	Only set for forked repositories. The branch of the base repository. Returns: `string`
`Environment.CI` Full Usage: `Environment.CI` Returns: `bool -> bool`	Always set to true, if present. Returns: `bool -> bool`
`Environment.EventName` Full Usage: `Environment.EventName` Returns: `string`	The name of the webhook event that triggered the workflow. Returns: `string`
`Environment.EventPath` Full Usage: `Environment.EventPath` Returns: `string`	The path of the file with the complete webhook event payload. For example, /github/workflow/event.json. Returns: `string`
`Environment.HeadRef` Full Usage: `Environment.HeadRef` Returns: `string`	Only set for forked repositories. The branch of the head repository. Returns: `string`
`Environment.Home` Full Usage: `Environment.Home` Returns: `string`	The path to the GitHub home directory used to store user data. For example, /github/home. Returns: `string`
`Environment.Ref` Full Usage: `Environment.Ref` Returns: `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. Returns: `string`
`Environment.Repository` Full Usage: `Environment.Repository` Returns: `string`	The owner and repository name. For example, octocat/Hello-World. Returns: `string`
`Environment.RunId` Full Usage: `Environment.RunId` Returns: `string`	A unique number for each run within a repository. This number does not change if you re-run the workflow run. Returns: `string`
`Environment.RunNumber` Full Usage: `Environment.RunNumber` Returns: `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. Returns: `string`
`Environment.Sha` Full Usage: `Environment.Sha` Returns: `string`	The commit SHA that triggered the workflow. For example, ffac537e6cbbf934b08745a378932722df287a53. Returns: `string`
`Environment.Workflow` Full Usage: `Environment.Workflow` Returns: `string`	The name of the workflow. Returns: `string`
`Environment.Workspace` Full Usage: `Environment.Workspace` Returns: `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. Returns: `string`