Struct StageContext 

pub struct StageContext {

    pub all: HashMap<String, String>,
    pub env: HashMap<String, String>,
    pub github: Option<Value>,
    pub inputs: HashMap<String, Value>,
    pub job: Option<Value>,
    pub jobs: HashMap<String, Value>,
    pub matrix: HashMap<String, String>,
    pub needs: HashMap<String, Value>,
    pub runner: Option<Value>,
    pub secrets: HashMap<String, String>,
    pub steps: HashMap<String, Value>,
    pub strategy: Option<Value>,
    pub vars: HashMap<String, String>,
}

Fields

all: HashMap<String, String>

Including all vars, priority from low to high, higher priority key could override lower priority key 1. The predefined variables for github/gitlab. 2. The web ui configured vars or envs, exclude secrets.

env: HashMap<String, String>

Contains variables set in a workflow, job, or step. Static data eg: env.ENV_NAME Value is encoded with base64 standard

github: Option<Value>

inputs: HashMap<String, Value>

Contains the inputs of a reusable or manually triggered workflow. Runtime data eg: ${{inputs.INPUT_NAME}} value is jobs.<job_id>.with

job: Option<Value>

jobs: HashMap<String, Value>

For reusable workflows only, contains outputs of jobs from the reusable workflow. Runtime data Initialized when stage is pushed into queue. Updated when stage is updated by api or else. key: job name or stage name value: JobsContext, refer to Github docs. Converted to serde_json::Value for recursively inject variables

matrix: HashMap<String, String>

needs: HashMap<String, Value>

Contains the outputs of all jobs that are defined as a dependency of the current job. Runtime data key: job name value: JobsContext. Converted to serde_json::Value for recursively inject variables.

runner: Option<Value>

secrets: HashMap<String, String>

Contains the names and values of secrets that are available to a workflow run. Sensitive data, only available to the job that will be running. eg: github: secrets.SECRET_NAME gitlab: $SECRET_NAME, secret.SECRET_NAME Value is encoded with base64 standard

steps: HashMap<String, Value>

Information about the steps that have been run in the current job. Runtime data key: step id (set in step yaml) value: refer to StepsContext. Converted to serde_json::Value for recursively inject variables.

strategy: Option<Value>

vars: HashMap<String, String>

Contains variables set at the repository, organization, or environment levels. Static data eg: gitlab: variables.VAR_NAME github: vars.VAR_NAME Value is encoded with base64 standard

Implementations

impl StageContext

pub fn new( all: HashMap<String, String>, env: HashMap<String, String>, github: Option<Value>, inputs: HashMap<String, Value>, job: Option<Value>, jobs: HashMap<String, Value>, matrix: HashMap<String, String>, needs: HashMap<String, Value>, runner: Option<Value>, secrets: HashMap<String, String>, steps: HashMap<String, Value>, strategy: Option<Value>, vars: HashMap<String, String>, ) -> StageContext

Trait Implementations

impl Clone for StageContext

fn clone(&self) -> StageContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StageContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StageContext

fn default() -> StageContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StageContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StageContext

fn eq(&self, other: &StageContext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StageContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StageContext