56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# cc-ci — Co-op Cloud recipe CI server
|
||
|
||
Comment **`!testme`** on a PR in an enrolled Co-op Cloud recipe repo and cc-ci deploys the recipe
|
||
at that commit onto a real single-node Docker Swarm, runs install / upgrade / backup-restore tests
|
||
(Python + Playwright) end-to-end, and reports a live, tail-able run with pass/fail back to the PR.
|
||
|
||
This repo declares the **entire server** as a NixOS flake and holds the test harness, the
|
||
per-recipe test trees, and the docs to enroll a recipe or rebuild the box from scratch.
|
||
|
||
> Status: under active autonomous construction. See `STATUS.md` for the live phase and
|
||
> `plan.md`-driven milestones in `BACKLOG.md`. Definition of Done is D1–D10 (see the build plan).
|
||
|
||
## Layout
|
||
|
||
```
|
||
flake.nix NixOS host(s) + devshell
|
||
hosts/cc-ci/ the cc-ci machine config
|
||
modules/ drone, comment-bridge, swarm, dashboard, secrets (Nix modules)
|
||
secrets/ sops-encrypted infra secrets
|
||
bridge/ !testme webhook listener source
|
||
runner/ run_recipe_ci.py + shared pytest harness
|
||
dashboard/ results overview generator
|
||
tests/<recipe>/ per-recipe install/upgrade/backup tests + playwright/
|
||
docs/ install, enroll-recipe, secrets, architecture, runbook, baseline
|
||
```
|
||
|
||
## Docs
|
||
|
||
- `docs/install.md` — rebuild the server from scratch (D8)
|
||
- `docs/enroll-recipe.md` — add a recipe under CI (D5)
|
||
- `docs/secrets.md` — secret model + rotation (D6)
|
||
- `docs/architecture.md`, `docs/runbook.md` — design + debugging failed runs
|
||
- `docs/baseline.md` — bootstrap snapshot / rollback reference
|
||
|
||
## Linting & formatting
|
||
|
||
The codebase is kept formatted + lint-clean by a single entrypoint, run from the pinned `lint`
|
||
devshell so local and CI use identical tool versions:
|
||
|
||
```sh
|
||
nix develop .#lint --command bash scripts/lint.sh # check-only (what CI runs)
|
||
nix develop .#lint --command bash scripts/lint.sh --fix # auto-format + apply fixes
|
||
```
|
||
|
||
Covers Nix (`nixpkgs-fmt` · `statix` · `deadnix`), Python (`ruff` lint+format), Shell
|
||
(`shellcheck` · `shfmt`), and YAML (`yamllint`). Config lives in `ruff.toml` / `.yamllint.yaml`;
|
||
tool/strictness choices are in `DECISIONS.md`. **CI enforces it:** the `lint` step in the
|
||
`.drone.yml` push pipeline runs the same command and **fails the build** on any unclean file, so
|
||
keep commits clean (`--fix` before pushing).
|
||
|
||
## Loop state (autonomous build)
|
||
|
||
`STATUS.md` (phase/blockers), `BACKLOG.md` (work + adversary findings), `REVIEW.md` (independent
|
||
verification), `JOURNAL.md` (build log), `DECISIONS.md` (architecture choices). See the build plan
|
||
for the two-loop Builder/Adversary protocol.
|