chain

type ChainExecutor ¶

type ChainExecutor struct {
	// contains filtered or unexported fields
}

ChainExecutor manages the execution of a workflow chain.

func NewExecutor(
	client GitHubClient, w RunWatcher, chainName string, chain *config.Chain, opts ...Option,
) *ChainExecutor

func NewExecutorFromHistory(
	client GitHubClient,
	w RunWatcher,
	chainName string,
	chain *config.Chain,
	previousResults []PreviousStepResult,
	resumeFromStep int,
) *ChainExecutor

func (e *ChainExecutor) Start(variables map[string]string, branch string) error

func (e *ChainExecutor) State() ChainState

func (e *ChainExecutor) Stop()

func (e *ChainExecutor) Updates() <-chan ChainUpdate

type ChainState ¶

type ChainState struct {
	Error        error
	StepResults  map[int]*StepResult
	ChainName    string
	Status       ChainStatus
	StepStatuses []StepStatus
	CurrentStep  int
}

ChainState represents the current state of a chain execution.

type ChainStatus ¶

type ChainStatus string

ChainStatus represents the overall status of a chain execution.

const (
	ChainPending   ChainStatus = "pending"
	ChainRunning   ChainStatus = "running"
	ChainCompleted ChainStatus = "completed"
	ChainFailed    ChainStatus = "failed"
)

type ChainUpdate ¶

type ChainUpdate struct {
	State ChainState
}

ChainUpdate is sent when the chain state changes.

type Dispatcher ¶ added in v1.8.0

type Dispatcher func(cfg runner.RunConfig, client GitHubClient) (int64, error)

Dispatcher starts one workflow and reports the run it started.

The executor holds one rather than calling the runner directly, because the dispatch is the one step a test cannot take: internal/exec's mutation guard panics on `gh workflow run`, so the branch and failure handling around it were unreachable while the call was hard-wired.

type ExistingRunResolver ¶ added in v1.12.0

type ExistingRunResolver func(client GitHubClient, workflow, branch string) (*github.WorkflowRun, error)

ExistingRunResolver finds the run a source: existing step should adopt, rather than dispatching a fresh one.

type GitHubClient ¶

type GitHubClient interface {
	GetWorkflowRun(runID int64) (*github.WorkflowRun, error)
	GetWorkflowRunJobs(runID int64) ([]github.Job, error)
	GetLatestRun(workflowName string) (*github.WorkflowRun, error)
	ListRuns(q github.RunQuery) ([]github.WorkflowRun, error)
	Owner() string
	Repo() string
}

GitHubClient defines the interface for GitHub API operations needed by the chain executor.

type InterpolationContext ¶

type InterpolationContext struct {
	Var      map[string]string // chain-level variables (replaces Trigger)
	Previous *StepResult
	Steps    map[int]*StepResult
}

InterpolationContext provides values for template interpolation.

type Option ¶ added in v1.8.0

type Option func(*ChainExecutor)

Option configures an executor.

func WithDispatcher(d Dispatcher) Option

func WithExistingRunResolver(r ExistingRunResolver) Option

func WithPollInterval(d time.Duration) Option

type PreviousStepResult ¶

type PreviousStepResult struct {
	Workflow   string
	Status     string
	Conclusion string
	RunID      int64
}

PreviousStepResult contains the result of a previously completed step.

type ResolvedStep ¶ added in v1.2.1

type ResolvedStep struct {
	Inputs map[string]string
	// Err is the interpolation failure, if the step had one. A preview renders
	// it and carries on; only the executor treats it as fatal.
	Err      error
	Workflow string
	// Command is the gh dispatch command a dispatch-source step runs. Empty
	// for a source: existing step, which adopts a run instead of starting one.
	Command string
	Source  config.SourceKind
}

ResolvedStep is one chain step with its templates interpolated and the gh command it dispatches. Building it once is what keeps the preview modal, the bash export, and the command list a chain records in history agreeing with what ChainExecutor actually runs.

func ResolveSteps(chain *config.Chain, variables map[string]string, branch string) []ResolvedStep

type RunWatcher ¶

type RunWatcher interface {
	Watch(runID int64, workflowName string)
	Unwatch(runID int64)
	Updates() <-chan watcher.RunUpdate
}

RunWatcher defines the interface for watching workflow runs.

type StepResult ¶

type StepResult struct {
	Inputs     map[string]string
	Workflow   string
	RunURL     string
	Status     StepStatus
	Conclusion string
	RunID      int64
}

StepResult represents the result of a completed step.

type StepStatus ¶

type StepStatus string

StepStatus represents the status of a single step.

const (
	StepPending   StepStatus = "pending"
	StepRunning   StepStatus = "running"
	StepWaiting   StepStatus = "waiting"
	StepCompleted StepStatus = "completed"
	StepFailed    StepStatus = "failed"
	StepSkipped   StepStatus = "skipped"
)