BFE Engineering
c756622c96
The repo's documentation framed it as a support repo for one product (WardenOS). Since going public the real audience is anyone with a Luckfox Pico 86 Panel: a maintained 6.18 kernel, an off-device development loop, and a device simulator that exist nowhere else for this board. Reframe the README and top-level docs board-first, with WardenOS documented as the downstream consumer it is (ADR-0008). Also an editorial pass over the whole doc set: - every H1/H2 is now a short title, not a sentence (ADRs, qemu/, patches/, drivers/, architecture, NPU feasibility, config-lint, payload); workflow flowchart titles fixed at the source in tools/flowgen.py and regenerated with fresh bench numbers - README Quick Start commands verified against the scripts; requirements corrected (curl, bare python, gcc >= 14) and the MC/DC gate added as a step (run green locally on gcc 14.2) - dropped the 'needs python (not python3)' vendor dig: build-kernel.sh inherited the same requirement (filed #10 to remove it) - glossed MC/DC and HPMCU on first use; marked the tests/uboot-ab reference as flare-edge; deduplicated the three-simulator list into the root README table
34 lines
2.0 KiB
Markdown
34 lines
2.0 KiB
Markdown
# CI/CD
|
|
|
|
`.github/workflows/ci.yml` — every job runs on GitHub-hosted `ubuntu-latest`.
|
|
No self-hosted runner is (or may be) reachable from this repo's workflows —
|
|
on a public repo, a fork PR that gets one approved run could otherwise
|
|
execute code on private infrastructure (ADR-0007).
|
|
|
|
## Jobs
|
|
|
|
| Job | Runner | What it does |
|
|
|---|---|---|
|
|
| `test` | ubuntu-latest | `cargo test` (sim + config-lint + qemu/rs485-bridge) + `cargo-llvm-cov` line coverage on `sim`; outputs `passed`/`coverage`. |
|
|
| `mcdc` | ubuntu-latest | 100% MC/DC enforced on every `drivers/*/test` (gcc-14 `-fcondition-coverage`). |
|
|
| `bench` | ubuntu-latest | Smoke-runs the sim + rs485-bridge micro-benchmarks; emits ns/op trend JSON. |
|
|
| `patches-apply` | ubuntu-latest | Fetches pristine linux-6.18.46 (cached, sha256-verified) and applies `patches/*` in order. |
|
|
| `qemu-tools` | ubuntu-latest | shellcheck on `qemu/**.sh`; builds the initramfs (pinned busybox) and the A/B disk image. |
|
|
| `kernel-build` | ubuntu-latest, **dispatch-only** | apt-installs the cross toolchain + qemu, `build/build-kernel.sh` → `zImage` + `rv1106-warden.dtb`, QEMU `-M virt` boot smoke (fail-closed), artifact upload (best-effort). Trigger: `gh workflow run ci.yml`. |
|
|
| `prune-artifacts` | ubuntu-latest, dispatch-only | Deletes `kernel-rv1106` artifacts beyond the newest 3. |
|
|
| `badges` | ubuntu-latest | Renders loc/tests/coverage shields on push to `main` (`[skip ci]` + `paths-ignore` loop guard). |
|
|
|
|
## Runner History
|
|
|
|
`kernel-build` originally ran on a repo-scoped self-hosted runner (ADR-0004,
|
|
2026-08-25, verified end-to-end) because hosted minutes were metered on the
|
|
private repo. Going public made hosted minutes free and made a self-hosted
|
|
registration a liability, so ADR-0007 moved the job to `ubuntu-latest` and
|
|
retired the registration. Site-specific install records for that runner live
|
|
in our private deployment log, not here.
|
|
|
|
## Badges
|
|
|
|
Static shields SVGs are committed by the `badges` job. The GitHub-native
|
|
`ci.yml` status badge works live regardless.
|