planstate

package

v0.7.225 Latest Latest Go to latest Published: Oct 28, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CircleCI-Public/chunk-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package planstate reads a factory plan's state, as factory names it: "Phase - Actor", such as "Planning - Human", or a bare word such as "Unprioritized". Factory may add or rename states before chunk knows them, so every reading here has an answer for a state it does not recognise.

Index ¶

Constants
func IsUnprioritized(state string) bool
type Actor
- func Parse(state string) (phase string, actor Actor)

Constants ¶

View Source

const Unprioritized = "Unprioritized"

Unprioritized is the state of a plan nobody has started.

Variables ¶

This section is empty.

Functions ¶

func IsUnprioritized ¶

func IsUnprioritized(state string) bool

IsUnprioritized is whether state is the state of a plan nobody has started.

Types ¶

type Actor ¶

type Actor int

Actor is who factory waits on to move a plan on.

const (
	// Unknown is a state that names no actor chunk recognises, or none.
	Unknown Actor = iota
	// Human is a state that waits on the developer.
	Human
	// Agent is a state that waits on factory's agent.
	Agent
)

func Parse ¶

func Parse(state string) (phase string, actor Actor)

Parse splits state into its phase and the actor it waits on. A state without a recognised actor comes back whole as the phase, with Unknown.

Source Files ¶

View all Source files

planstate.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL