Retracted: v0.1.0 published no binaries: its release run failed on macOS and Windows, and the publish job was correctly gated behind that failure. The tag is installable, but the release/release-decision.md inside it describes those two platforms as gated-but-not-yet-observed when the run that observed them had already failed. Retracted so a false platform claim is not selectable. The code itself is sound on linux/amd64. Use v0.1.1.

state

package

v0.1.0 Latest Latest Go to latest Published: Aug 1, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/0xkhdr/specd-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Encode(s State) ([]byte, error)
type Mutator
type Projection
type State
- func (s State) Project() Projection
- func (s State) Validate(expectedChange string) error

Constants ¶

View Source

const (
	CodeCorrupt  = "state_corrupt"
	CodeSchema   = "state_schema_unsupported"
	CodeIdentity = "state_identity_mismatch"
)

Stable refusal codes for state decode/validate. All name external repair as the sole next action; the split exists because a future schema and a mismatched identity are diagnosed differently by an operator.

View Source

const SchemaVersion = 1

Variables ¶

This section is empty.

Functions ¶

func Encode ¶

func Encode(s State) ([]byte, error)

Types ¶

type Mutator ¶

type Mutator func(*State) error

type Projection ¶

type Projection struct {
	Change     string `json:"change"`
	Schema     int    `json:"schemaVersion"`
	Stage      string `json:"stage"`
	Condition  string `json:"condition"`
	Revision   uint64 `json:"revision"`
	NextAction string `json:"nextAction"`
}

type State ¶

type State struct {
	SchemaVersion  int                        `json:"schemaVersion"`
	Change         string                     `json:"change"`
	Stage          string                     `json:"stage"`
	Condition      string                     `json:"condition"`
	Revision       uint64                     `json:"revision"`
	Approvals      []json.RawMessage          `json:"approvals"`
	Tasks          map[string]json.RawMessage `json:"tasks"`
	CreatedBy      string                     `json:"createdBy"`
	LastTransition string                     `json:"lastTransition"`
	Extensions     map[string]json.RawMessage `json:"extensions,omitempty"`
}

func Decode ¶

func Decode(data []byte, expectedChange string) (State, error)

func Initial ¶

func Initial(change, creationID string) State

func Mutate ¶

func Mutate(path, expectedChange string, expectedRevision uint64, mutate Mutator) (State, error)

Mutate takes only the change lock. Callers needing a root lock must acquire it first: root before change is the global lock order.

path is <change>/state.json, so the one change lock is <change>/.lock, the same file corepath.Owner.ChangeLock names and every other state writer takes.

func (State) Project ¶

func (s State) Project() Projection

func (State) Validate ¶

func (s State) Validate(expectedChange string) error

Source Files ¶

View all Source files

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