phase

Documentation

Overview

Package phase defines the planning phase sequence and artifact gates.

Index

• type ArtifactValidation
  • func ValidatePrerequisites(repoRoot string, upcoming Phase) ([]ArtifactValidation, error)
• type Phase
  • func ParsePhase(name string) (Phase, error)
  • func (p Phase) Next() Phase
  • func (p Phase) Number() int
  • func (p Phase) String() string

Types

type ArtifactValidation

type ArtifactValidation struct {
	Name      string    `json:"name"`
	Valid     bool      `json:"valid"`
	Message   string    `json:"message,omitempty"`
	CheckedAt time.Time `json:"checked_at"`
}

ArtifactValidation holds the result from validating a runnable phase gate.

func ValidatePrerequisites

func ValidatePrerequisites(repoRoot string, upcoming Phase) ([]ArtifactValidation, error)

ValidatePrerequisites inspects the repo and returns the list of artifact checks that gate the upcoming phase.

type Phase

type Phase int

Phase represents each numbered Governator phase.

const (
	PhaseNew Phase = iota
	PhaseArchitectureBaseline
	PhaseGapAnalysis
	PhaseProjectPlanning
	PhaseTaskPlanning
	PhaseExecution
	PhaseComplete
)

func ParsePhase

func ParsePhase(name string) (Phase, error)

ParsePhase resolves a phase enum from its string name.

func (Phase) Next

func (p Phase) Next() Phase

Next returns the phase that follows the provided one.

func (Phase) Number

func (p Phase) Number() int

Number returns the numeric representation of the phase.

func (Phase) String

func (p Phase) String() string

String returns a human-friendly label for the phase.