Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.context

GitHub1.3.0

Properties
Methods

class GitHub

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

action: "${{ github.action }}"Source

The name of the action currently running, or the id of a step.

GitHub removes special characters, and uses the name __run when the current step runs a script without an id. If you use the same action more than once in the same job, the name will include a suffix with the sequence number with underscore before it. For example, the first script you run will have the name __run, and the second script will be named __run_2. Similarly, the second invocation of actions/checkout will be actionscheckout2.
link

actionPath: "${{ github.action_path }}"Source

The path where an action is located.

This property is only supported in composite actions. You can use this path to access files located in the same repository as the action, for example by changing directories to the path: cd ${{ github.action_path }}.
link

actionRef: "${{ github.action_ref }}"Source

For a step executing an action, this is the ref of the action being executed.

For example, v2. Do not use in the run keyword. To make this context work with composite actions, reference it within the env context of the composite action.
link

actionRepository: "${{ github.action_repository }}"Source

For a step executing an action, this is the owner and repository name of the action.

For example, actions/checkout. Do not use in the run keyword. To make this context work with composite actions, reference it within the env context of the composite action.
link

actionStatus: "${{ github.action_status }}"Source

For a composite action, the current result of the composite action.
link

actor: "${{ github.actor }}"Source

The username of the user that triggered the initial workflow run.

If the workflow run is a re-run, this value may differ from github.triggering_actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the re-run (github.triggering_actor) has different privileges.
link

actorId: "${{ github.actor_id }}"Source

The account ID of the person or app that triggered the initial workflow run.

For example, 1234567. Note that this is different from the actor username.
link

apiUrl: "${{ github.api_url }}"Source

The URL of the GitHub REST API.
link

baseRef: "${{ github.base_ref }}"Source

The base_ref or target branch of the pull request in a workflow run.

This property is only available when the event that triggers a workflow run is either pull_request or pull_request_target.
link

eventName: "${{ github.event_name }}"Source

The name of the event that triggered the workflow run.
link

eventPath: "${{ github.event_path }}"Source

The path to the file on the runner that contains the full event webhook payload.
link

graphqlUrl: "${{ github.graphql_url }}"Source

The URL of the GitHub GraphQL API.
link

headRef: "${{ github.head_ref }}"Source

The head_ref or source branch of the pull request in a workflow run.

This property is only available when the event that triggers a workflow run is either pull_request or pull_request_target.
link

job: "${{ github.job }}"Source

The job_id of the current job.

Note: This context property is set by the Actions runner, and is only available within the execution steps of a job. Otherwise, the value of this property will be null.
link

path: "${{ github.path }}"Source

Path on the runner to the file that sets system PATH variables from workflow commands.

This file is unique to the current step and is a different file for each step in a job.
link

ref: "${{ github.ref }}"Source

The fully-formed ref of the branch or tag that triggered the workflow run.

For workflows triggered by push, this is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is refs/heads/<branch_name>. For pull requests events except pull_request_target, it is refs/pull/<pr_number>/merge. pull_request_target events have the ref from the base branch. For tags it is refs/tags/<tag_name>. For example, refs/heads/feature-branch-1.
link

refName: "${{ github.ref_name }}"Source

The short ref name of the branch or tag that triggered the workflow run.

This value matches the branch or tag name shown on GitHub. For example, feature-branch-1. For pull requests, the format is <pr_number>/merge.
link

refProtected: "${{ github.ref_protected }}"Source

true if branch protections or rulesets are configured for the ref that triggered the workflow run.
link

refType: "${{ github.ref_type }}"Source

The type of ref that triggered the workflow run.

Valid values are branch or tag.
link

repository: "${{ github.repository }}"Source

The owner and repository name.

For example, octocat/Hello-World.
link

repositoryId: "${{ github.repository_id }}"Source

The ID of the repository.

For example, 123456789. Note that this is different from the repository name.
link

repositoryOwner: "${{ github.repository_owner }}"Source

The repository owner's username.

For example, octocat.
link

repositoryOwnerId: "${{ github.repository_owner_id }}"Source

The repository owner's account ID.

For example, 1234567. Note that this is different from the owner's name.
link

repositoryUrl: "${{ github.repository_url }}"Source

The Git URL to the repository.

For example, git://github.com/octocat/hello-world.git.
link

retentionDays: "${{ github.retention_days }}"Source

The number of days that workflow run logs and artifacts are kept.
link

runId: "${{ github.run_id }}"Source

A unique number for each workflow run within a repository.

This number does not change if you re-run the workflow run.
link

runNumber: "${{ github.run_number }}"Source

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.
link

runAttempt: "${{ github.run_attempt }}"Source

A unique number for each attempt of a particular workflow run in a repository.

This number begins at 1 for the workflow run's first attempt, and increments with each re-run.
link

serverUrl: "${{ github.server_url }}"Source

The URL of the GitHub server.

For example: https://github.com.
link

sha: "${{ github.sha }}"Source

The commit SHA that triggered the workflow.

The value of this commit SHA depends on the event that triggered the workflow. For more information, see Events that trigger workflows. For example, ffac537e6cbbf934b08745a378932722df287a53.
link

token: "${{ github.token }}"Source

A token to authenticate on behalf of the GitHub App installed on your repository.

This is functionally equivalent to the GITHUB_TOKEN secret. Note: This context property is set by the Actions runner, and is only available within the execution steps of a job. Otherwise, the value will be null.
link

triggeringActor: "${{ github.triggering_actor }}"Source

The username of the user that initiated the workflow run.

If the workflow run is a re-run, this value may differ from github.actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the re-run (github.triggering_actor) has different privileges.
link

workflow: "${{ github.workflow }}"Source

The name of the workflow.

If the workflow file doesn't specify a name, the value of this property is the full path of the workflow file in the repository.
link

workflowRef: "${{ github.workflow_ref }}"Source

The ref path to the workflow.

For example, octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch.
link

workflowSha: "${{ github.workflow_sha }}"Source

The commit SHA for the workflow file.
link

workspace: "${{ github.workspace }}"Source

The default working directory on the runner for steps, and the default location of your repository when using the checkout action.

For example, /home/runner/work/my-repo-name/my-repo-name.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function

event(name: String): String Source