validate_actions.domain_model.contexts

GitHub Actions context definitions and type system.

This module defines the context objects available in GitHub Actions workflows for expression validation. Contexts provide access to workflow runtime information, environment state, and inter-job communication.

Contexts are organized hierarchically and each property has a defined type for validation purposes. The type system supports GitHub Actions’ dynamic nature while enabling static analysis.

See GitHub’s official documentation: https://docs.github.com/en/actions/learn-github-actions/contexts

Classes

ContainerContext([type_, id, network])

Container context for the current job.

ContextType(*values)

Type system for GitHub Actions context values.

Contexts([github, vars, secrets, inputs, ...])

Root container for all GitHub Actions contexts.

GithubContext([type_, action, action_path, ...])

GitHub context - contains information about the workflow run.

InputsContext([type_, children_])

Inputs context - contains input parameters.

JobContext([type_, container, services, status])

Job context - contains information about the currently running job.

JobVarContext([type_, result, outputs])

Context for a specific job in the jobs context.

JobsContext([type_, children_])

Jobs context - contains information about jobs in the workflow.

MatrixContext([type_, children_])

Matrix context - contains the matrix parameters for the current job.

NeedContext([type_, result, outputs])

Context for a specific job referenced in needs.

NeedOutputsContext([type_, children_])

Outputs context for a job referenced in needs.

NeedsContext([type_, children_])

Needs context - contains information about jobs defined as dependencies.

OutputsContext([type_, children_])

Outputs context for job or step outputs.

RunnerContext([type_, name, os, arch, temp, ...])

Runner context - contains information about the runner executing jobs.

SecretsContext([type_, GITHUB_TOKEN, children_])

Secrets context - contains repository and organization secrets.

ServiceContext([type_, network, ports])

Service context for a specific service container.

ServicesContext([type_, children_])

Services context containing all service containers.

StepOutputsContext([type_, children_])

Outputs context for a specific step.

StepVarContext([type_, outputs, conclusion, ...])

Context for a specific step in the steps context.

StepsContext([type_, children_])

Steps context - contains information about steps in the current job.

StrategyContext([type_, fail_fast, ...])

Strategy context - contains information about the matrix execution strategy.

VarsContext([type_, children_])

Vars context - contains repository and organization variables.
class validate_actions.domain_model.contexts.ContextType(*values)[source]

Bases: Enum

Type system for GitHub Actions context values.

Defines the possible types that context properties can have. Used for expression validation and type checking.

class validate_actions.domain_model.contexts.GithubContext(type_=ContextType(), action=ContextType(), action_path=ContextType(), action_ref=ContextType(), action_repository=ContextType(), action_status=ContextType(), actor=ContextType(), actor_id=ContextType(), api_url=ContextType(), base_ref=ContextType(), env=ContextType(), event=ContextType(), event_name=ContextType(), event_path=ContextType(), graphql_url=ContextType(), head_ref=ContextType(), job=ContextType(), path=ContextType(), ref=ContextType(), ref_name=ContextType(), ref_protected=ContextType(), ref_type=ContextType(), repository=ContextType(), repository_id=ContextType(), repository_owner=ContextType(), repository_owner_id=ContextType(), repositoryUrl=ContextType(), retention_days=ContextType(), run_id=ContextType(), run_number=ContextType(), run_attempt=ContextType(), secret_source=ContextType(), server_url=ContextType(), sha=ContextType(), token=ContextType(), triggering_actor=ContextType(), workflow=ContextType(), workflow_ref=ContextType(), workflow_sha=ContextType(), workspace=ContextType())[source]

Bases: object

GitHub context - contains information about the workflow run.

The github context contains information about the workflow run and the event that triggered the run. You can read most of the github context data in environment variables.

Ordered according to GitHub’s official documentation.

Parameters:
class validate_actions.domain_model.contexts.RunnerContext(type_=ContextType(), name=ContextType(), os=ContextType(), arch=ContextType(), temp=ContextType(), tool_cache=ContextType(), debug=ContextType(), environment=ContextType())[source]

Bases: object

Runner context - contains information about the runner executing jobs.

The runner context contains information about the runner that is executing the current job.

Parameters:
class validate_actions.domain_model.contexts.SecretsContext(type_=ContextType(), GITHUB_TOKEN=ContextType(), children_=<factory>)[source]

Bases: object

Secrets context - contains repository and organization secrets.

The secrets context is used to access repository and organization secrets.

Parameters:
class validate_actions.domain_model.contexts.VarsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Vars context - contains repository and organization variables.

The vars context is used to access repository and organization variables.

Parameters:
class validate_actions.domain_model.contexts.ContainerContext(type_=ContextType(), id=ContextType(), network=ContextType())[source]

Bases: object

Container context for the current job.

Parameters:
class validate_actions.domain_model.contexts.ServiceContext(type_=None, network=ContextType(), ports=<factory>)[source]

Bases: object

Service context for a specific service container.

Parameters:
class validate_actions.domain_model.contexts.ServicesContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Services context containing all service containers.

Parameters:
class validate_actions.domain_model.contexts.JobContext(type_=ContextType(), container=<factory>, services=<factory>, status=ContextType())[source]

Bases: object

Job context - contains information about the currently running job.

The job context contains information about the currently running job.

Parameters:
class validate_actions.domain_model.contexts.OutputsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Outputs context for job or step outputs.

Parameters:
class validate_actions.domain_model.contexts.JobVarContext(type_=None, result=ContextType(), outputs=<factory>)[source]

Bases: object

Context for a specific job in the jobs context.

Parameters:
class validate_actions.domain_model.contexts.JobsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Jobs context - contains information about jobs in the workflow.

The jobs context contains information about jobs in the current workflow run.

Parameters:
class validate_actions.domain_model.contexts.StepOutputsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Outputs context for a specific step.

Parameters:
class validate_actions.domain_model.contexts.StepVarContext(type_=ContextType(), outputs=<factory>, conclusion=ContextType(), outcome=ContextType())[source]

Bases: object

Context for a specific step in the steps context.

Parameters:
class validate_actions.domain_model.contexts.StepsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Steps context - contains information about steps in the current job.

The steps context contains information about the steps in the current job that have already run.

Parameters:
class validate_actions.domain_model.contexts.StrategyContext(type_=ContextType(), fail_fast=ContextType(), job_index=ContextType(), job_total=ContextType(), max_parallel=ContextType())[source]

Bases: object

Strategy context - contains information about the matrix execution strategy.

The strategy context contains information about the matrix execution strategy for the current job.

Parameters:
class validate_actions.domain_model.contexts.MatrixContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Matrix context - contains the matrix parameters for the current job.

The matrix context contains the matrix parameters defined in the workflow for the current job.

Parameters:
class validate_actions.domain_model.contexts.NeedOutputsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Outputs context for a job referenced in needs.

Parameters:
class validate_actions.domain_model.contexts.NeedContext(type_=ContextType(), result=ContextType(), outputs=<factory>)[source]

Bases: object

Context for a specific job referenced in needs.

Parameters:
class validate_actions.domain_model.contexts.NeedsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Needs context - contains information about jobs defined as dependencies.

The needs context contains outputs from all jobs that are defined as dependencies of the current job.

Parameters:
class validate_actions.domain_model.contexts.InputsContext(type_=ContextType(), children_=<factory>)[source]

Bases: object

Inputs context - contains input parameters.

The inputs context contains input properties passed to a reusable workflow, or to a manually triggered workflow.

Parameters:
class validate_actions.domain_model.contexts.Contexts(github=<factory>, vars=<factory>, secrets=<factory>, inputs=<factory>, runner=None, job=None, jobs=None, steps=<factory>, strategy=None, matrix=None, needs=<factory>)[source]

Bases: object

Root container for all GitHub Actions contexts.

Aggregates all available contexts following GitHub’s official documentation order. Context availability depends on the workflow execution scope.

Parameters: