Skip to content

DOC: add CI workbench design doc - #132

Open
rok wants to merge 3 commits into
benchx-dev:mainfrom
rok:ci-execution-design
Open

rok wants to merge 3 commits into
benchx-dev:mainfrom
rok:ci-execution-design

Conversation

@rok

@rok rok commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Adds docs/design/ci-workbench.md modeling CI benchmark execution as a CI workbench — the unattended, requester.kind: "ci" sibling of local workbenches (bx, spin bench) rather than a new kind of runner (no "EC2 runner" inside benchx):
    • Provisioning handoff (L0/L1 → benchx): agnostic across dedicated pull nodes, ephemeral self-hosted CI runners, and direct cloud jobs, with rules for stable logical machine identity, declared L0/L1 facts, and leak-safe teardown.
    • Lifecycle: tracking mode (per-commit history) and comparison mode (PR head vs. base via the interleaved session loop), keeping target-provider build failures separate from runner results.
    • Durable delivery & restarts: unit-level incremental write-once staging, forward-only restarts (the ratchet), and serialized idempotent compaction/ingest.
    • Trust & security boundary: trigger gating for PRs, least-privilege credential split between control plane and compute node, and secret hygiene.
    • Packaging & repository boundaries: core benchx holds the contract/runner/schemas without cloud templates; reusable CI workbench templates live in a companion repo once shared; each project repo keeps only its config, target provider, and machine catalog.
  • Broadens docs/design/system-decomposition.md §3.4 (Workbench) to cover both local workbenches and CI workbenches (preserving all existing section numbers and §5 boundaries) and updates the §2 overview diagram accordingly.
  • Cross-references the provisioning handoff and stable logical machine naming from docs/design/benchmark-environments.md §5.4.
  • Registers ci-workbench.md in docs/design/README.md and zensical.toml.

Verification

  • Ran python tools/gen_docs.py and zensical build --strict --clean — passed with no issues.

@rok rok changed the title DOC: add CI execution design doc DOC: add CI workbench design doc Nov 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant