runstatus

Documentation

Overview

Package runstatus provides run statuses.

NOTE: placed in separate package from `run` to avoid import cycles.

templ: version: v0.3.833

Index

• Variables
• func Badge(runID resource.ID, status Status) templ.Component
• func Filter(selected []Status, visible bool) templ.Component
• type Status
  • func All() []Status
  • func (s Status) String() string

Variables

var ThemeMappings = map[Status]string{
	Applied:            "success",
	ApplyQueued:        "secondary",
	Applying:           "accent",
	Canceled:           "warning",
	Confirmed:          "info",
	Discarded:          "warning",
	Errored:            "error",
	ForceCanceled:      "warning",
	Pending:            "primary",
	PlanQueued:         "secondary",
	Planned:            "info",
	PlannedAndFinished: "success",
	Planning:           "primary",
}

Functions

func Badge

func Badge(runID resource.ID, status Status) templ.Component

func Filter

func Filter(selected []Status, visible bool) templ.Component

Types

type Status

type Status string

Status represents a run state.

const (
	// List all available run statuses supported in OTF.
	Applied            Status = "applied"
	ApplyQueued        Status = "apply_queued"
	Applying           Status = "applying"
	Canceled           Status = "canceled"
	Confirmed          Status = "confirmed"
	Discarded          Status = "discarded"
	Errored            Status = "errored"
	ForceCanceled      Status = "force_canceled"
	Pending            Status = "pending"
	PlanQueued         Status = "plan_queued"
	Planned            Status = "planned"
	PlannedAndFinished Status = "planned_and_finished"
	Planning           Status = "planning"

	// OTF doesn't support cost estimation but go-tfe API tests expect this
	// status so it is included expressly to pass the tests.
	CostEstimated Status = "cost_estimated"
)

func All

func All() []Status

func (Status) String

func (s Status) String() string