Development¶

go test ./...          # the step tests run real containers
go test -short ./...   # without them

The engine tests run against the local engine with everything else. Against Hatchet they need one to talk to, so they run when asked, with this process as the worker:

set -a; . dev/.env; set +a
STARCI_TEST_HATCHET=1 go test ./internal/engine/hatchet -run TestEngine

This documentation¶

The pages in docs/ are built with Zensical, which reads mkdocs.yml and gives the Material for MkDocs look. docs/examples is a copy of examples/ made by the script, which also writes a page for each example (dev/docs-examples.py): the script, and for a basic one what it compiles to for GitHub Actions and for CircleCI. A new example has to be added to the nav in mkdocs.yml, and the build says so if it is not. Building needs Go, since the page of a basic example draws its plan with starci plan.

The release processes (branches, events, wrapping-release-actions, deploy-gate, canary) are played from drawings in docs/animations, with dottie.js; a page gets one by having a drawing named for its example. See dev/animations/README.md.

dev/docs.sh serve   # while writing
dev/docs.sh         # the same build CI does; a broken link fails it

Zensical is before 1.0, so its version is pinned, in dev/docs.sh and in .github/workflows/docs.yml.