Struct RunnerContext 

pub struct RunnerContext {

    pub github: Octocrab,
    pub owner: String,
    pub repo: String,
    pub commit_sha: Vec<u8>,
    pub commit_ref: Option<String>,
    pub global_dir_host: PathBuf,
    pub workflow_repo_path: String,
    pub run_id: RunId,
    pub run_number: i64,
    pub job_id: JobId,
    pub actor: String,
    pub token: String,
    pub override_env: Vec<(String, String)>,
}

This contains various configuration values needed to run a Github Actions workflow. Most of these values are exposed to actions via standard GHA environment variables.

Fields

github: Octocrab

The Octocrab Github client used to fetch workflow resources. This can be configured with or without authentication; in the latter case all required resources must be public.

owner: String

The Github owner name, e.g. Pernosco.

repo: String

The Github repo name, e.g. github-actions-test.

commit_sha: Vec<u8>

The repo commit-SHA decoded from hex, e.g. using hex::decode(sha_string.has_bytes()).

commit_ref: Option<String>

An optional git ref for the commit. Exposed as $GITHUB_REF in the GHA steps.

global_dir_host: PathBuf

A global working directory whose contents are exposed to all containers as /github. The runner will create files under this directory.

workflow_repo_path: String

Name of workflow file in the repo, e.g. .github/workflows/build.yml.

run_id: RunId

The workflow run ID. Exposed as $GITHUB_RUN_ID in the GHA steps. Can usually just be (e.g.) 1, but you might want to match the ID of some real workflow run.

run_number: i64

The rerun number. Exposed as $GITHUB_RUN_NUMBER in the GHA steps. Can usually just be 1.

job_id: JobId

The job ID. Exposed as $GITHUB_JOB in the GHA steps. Can usually just be 1.

actor: String

Exposed as $GITHUB_ACTOR in the GHA steps.

token: String

A Github personal access token for actions to use for checkouts and other Github operations. This must be valid. See zero_access_token() for a token you can use.

override_env: Vec<(String, String)>

(key, value) pairs that override environment variable settings in a step. These are applied after all workflow-defined environment variables.

Trait Implementations

impl Clone for RunnerContext

fn clone(&self) -> RunnerContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.