StageFreight Documentation

Reference

Generated reference pages — authoritative, always in sync with code:

• CLI Reference — complete command, flag, and subcommand reference
• Config Reference — complete .stagefreight.yml schema reference

Conceptual Docs

Feature-focused guides with concepts, examples, and workflows:

• CI Integration — provider skeletons, required tokens and scopes, cross-pipeline advisory bridge
• Docker Build — builds: + targets: for container images, cache, retention, build strategy
• Release Management — kind: release targets, rolling tags, cross-forge sync
• Package Distribution — kind: generic-package, curl-pullable dev binaries, immutable vs rolling versions
• Narrator & Badges — content composition, badge generation, kind: include
• Security Scanning — vulnerability scanning, SBOM, detail levels
• Linter Configuration — 9 lint modules, cache TTL contract, freshness
• Dependency Update — dependency update command, Go toolchain strategies
• GitLab Components — publishing GitLab CI components for your projects (and why StageFreight no longer ships itself as one)
• Known Issues — active bugs and workarounds

Examples

• Configuration Examples — 24 example .stagefreight.yml manifests for every project archetype
• Quick Examples — minimal, focused config snippets:
• minimal.yml — bare minimum builds + targets
• narrator.yml — badge generation + README embedding
• release.yml — release target with rolling tags
• crucible.yml — two-pass crucible build mode

Shared Primitives

These structures are used across multiple config sections:

• Retention Policy — restic-style tag/release cleanup (reference)
• Pattern Syntax — regex/literal/negated patterns for branches and tags (reference)
• Condition — tag/branch-sensitive rule primitive (reference)
• Template Variables — {version}, {var:name}, {env:VAR}, etc. (reference)

Planning

• Road Map — full product vision, phased feature plan, and tracking index