CI/CD automation
The repository-grounded automation path for CALIBER development: docs generation, focused contract tests, and the human-review boundaries that remain deliberate.
Use this page when you need the practical automation path for CALIBER-related development: local quality gates, docs generation, SDK examples, and the points where human review is still deliberate rather than accidental.
At a glance
| Task | Current repo path |
|---|---|
| backend and UI quality gate | make test, make test-all |
| strict docs rebuild + sync | CALIBER_DOCS_PYTHON=caliber/.venv/bin/python CALIBER_DOCS_STRICT=1 node caliber/caliber-ui/scripts/sync-docs.mjs |
| focused docs validation | caliber/.venv/bin/python -m pytest caliber/tests/test_docs_generation_contract.py caliber/tests/test_sdk_docs_contract.py caliber/tests/test_cookbook_doc_contract.py caliber/tests/test_cookbook_steps_contract.py caliber/tests/test_design_principles_contract.py caliber/tests/test_ci_published_site_gate_contract.py caliber/tests/test_docs_executable_spec_contract.py --no-cov |
| CI docs gate | .github/workflows/ci.yml → docs-validation job (uploads docs-validation-junit.xml) |
1. Keep docs and code in the same automation loop
The current repository already treats documentation as a tested build artifact. Do not separate docs generation from normal development validation.
2. Recommended local sequence
For docs and integration changes in this repository:
- run the strict docs sync command
- run the focused docs contracts
- run the broader quality gate that matches the change surface
The current CI pipeline keeps this explicit:
uibuilds the SPA from the committed docs copiesdocs-validationis the place that regenerates docs, checks generated-copy parity, and fails on invalid snippets, stale routes, or hallucinated config names- Pages publishes only after CI succeeds on
main, so the public HTML comes from a commit that already passed the docs gate
3. Preserve human review where the product expects it
CI/CD should automate build, verification, and publication. It should not silently bypass review, approval, or release boundaries that CALIBER exposes as intentional product controls.