steps

package

v0.9.0 Latest Latest Go to latest Published: May 29, 2026 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/aaronl1011/spec

Links

Open Source Insights

Documentation ¶

Overview ¶

Package steps handles build step execution and transitions.

Index ¶

type Engine
- func NewEngine(userConfig *config.UserConfig) *Engine
type NextStep

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Engine ¶

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

Engine orchestrates build step execution.

func NewEngine ¶

func NewEngine(userConfig *config.UserConfig) *Engine

NewEngine creates a new steps engine.

func (*Engine) AllComplete ¶

func (e *Engine) AllComplete(meta *markdown.SpecMeta) bool

AllComplete returns true if all steps are complete.

func (*Engine) BlockStep ¶

func (e *Engine) BlockStep(meta *markdown.SpecMeta, index int, reason string) error

BlockStep marks a step as blocked with a reason.

func (*Engine) BranchName ¶

func (e *Engine) BranchName(specID string, stepIndex int, description string) string

BranchName generates a branch name for a step.

func (*Engine) CompleteStep ¶

func (e *Engine) CompleteStep(meta *markdown.SpecMeta, index int, prNumber int) error

CompleteStep marks a step as complete.

func (*Engine) CurrentStep ¶

func (e *Engine) CurrentStep(meta *markdown.SpecMeta) *planning.Step

CurrentStep returns the current (first non-complete) step for a spec.

func (*Engine) GetNextStep ¶

func (e *Engine) GetNextStep(meta *markdown.SpecMeta) (*NextStep, error)

GetNextStep determines what to work on next.

func (*Engine) Progress ¶

func (e *Engine) Progress(meta *markdown.SpecMeta) (completed, total int, currentStep *planning.Step)

Progress returns build progress info.

func (*Engine) StartStep ¶

func (e *Engine) StartStep(meta *markdown.SpecMeta, index int) (branchName string, err error)

StartStep marks a step as in-progress and returns the branch name.

func (*Engine) StepByIndex ¶

func (e *Engine) StepByIndex(meta *markdown.SpecMeta, index int) *planning.Step

StepByIndex returns a specific step by 1-based index.

func (*Engine) UnblockStep ¶

func (e *Engine) UnblockStep(meta *markdown.SpecMeta, index int) error

UnblockStep removes the blocked status from a step.

func (*Engine) WorkspacePath ¶

func (e *Engine) WorkspacePath(repoName string) string

WorkspacePath returns the local path for a repo, or empty if not configured.

type NextStep ¶

type NextStep struct {
	Index         int
	Description   string
	Repo          string
	Branch        string
	WorkspacePath string
	IsNewRepo     bool // true if different repo from previous step
}

NextStep returns info about the next step to work on.

Source Files ¶

View all Source files

steps.go

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