fix(nixfiles): fix formatting stuff #63

Merged
lyrathorpe merged 1 commits from ci/format-check-all-prs into main 2026-07-10 12:15:35 +01:00
3 changed files with 34 additions and 21 deletions
Showing only changes of commit 4fd26b1662 - Show all commits
+26 -14
View File
@@ -1,15 +1,21 @@
# Flake CI: full `nix flake check` (formatting + deadnix + statix + pre-commit)
# plus an explicit per-host evaluation pass for granular output.
# Flake CI. Formatting (treefmt) runs on *every* PR; the heavier Nix work
# (deadnix/statix/pre-commit lints + per-host evaluation) runs only when the
# change can affect it.
name: CI
# Deliberately no `paths:` filter. This job is a required status check on main,
# and a path-filtered workflow is *skipped* (never runs) for PRs that touch no
# matching file -- which leaves the required check pending forever and blocks the
# merge (e.g. a .renovaterc.json-only change). So the workflow always runs and
# always reports. To avoid burning a full Nix evaluation on changes that can't
# affect it, the "detect" step below diffs the PR and the heavy steps run only
# when a .nix file, flake.lock, or this workflow changed; otherwise they skip and
# the job still passes. The required check is therefore always green-reportable.
# always reports.
#
# Two tiers of checks:
# * Formatting always runs. treefmt covers Markdown, YAML, and JSON as well as
# Nix and shell, so a docs- or config-only PR must be format-checked too. It
# is cheap (no host evaluation).
# * The heavy steps (full `nix flake check` + host evals) run only when a .nix
# file, flake.lock, or this workflow changed; otherwise they skip and the job
# still passes, keeping the required check green-reportable.
on:
push:
branches: [main]
@@ -25,11 +31,10 @@ jobs:
# Full history so the detect step can diff the PR against its base.
fetch-depth: 0
# Decide whether the Nix steps need to run. On a pull_request, diff the PR
# against its base and look for files that can affect the flake: any .nix,
# the lockfile, or this workflow. On any other event (push to main) always
# run. The job itself always succeeds, so the required status check is
# reported even when the heavy steps are skipped.
# Decide whether the *heavy* Nix steps need to run. On a pull_request, diff
# against the base for files that can affect them: any .nix, the lockfile,
# or this workflow. On any other event (push to main) always run. The
# formatting step below is unaffected -- it always runs.
- name: Detect Nix-relevant changes
id: detect
run: |
@@ -45,15 +50,15 @@ jobs:
echo "Changed files:"
echo "$changed"
if echo "$changed" | grep -Eq '(\.nix$|^flake\.lock$|^\.gitea/workflows/ci\.yaml$)'; then
echo "Nix-relevant changes found: running checks."
echo "Nix-relevant changes found: running heavy checks."
echo "run=true" >> "$GITHUB_OUTPUT"
else
echo "No Nix-relevant changes: skipping checks (job still passes)."
echo "No Nix-relevant changes: heavy checks skip (formatting still runs)."
echo "run=false" >> "$GITHUB_OUTPUT"
fi
# Nix drives the formatting check, so install it unconditionally.
- name: Install Nix
if: steps.detect.outputs.run == 'true'
uses: cachix/install-nix-action@a49548c11d9846ad46ecc0115273879b045f001c # v31
with:
extra_nix_config: |
@@ -62,6 +67,13 @@ jobs:
substituters = https://cache.nixos.org https://nix-community.cachix.org
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
# Always run: treefmt formats Markdown/YAML/JSON (docs + config) as well as
# Nix and shell, so documentation-only PRs are format-checked too. This is
# the cheap gate (no host evaluation) and pre-builds the `formatting`
# derivation that the flake check below reuses from cache.
- name: Formatting check
run: nix build --print-build-logs '.#checks.x86_64-linux.formatting'
# Runs every flake check: treefmt formatting, deadnix, statix, and the
# pre-commit hooks (so a --no-verify commit can't ship unlinted).
- name: Flake check
+7 -7
View File
@@ -36,18 +36,18 @@ Excluded from formatting: `*/hardware-configuration.nix` (generated by
newline) are in `.editorconfig`; note Markdown keeps trailing whitespace, which
encodes hard line breaks.
## Docs are checked too — the common trap
## Docs are checked too
prettier formats `*.md`, so **documentation edits must be run through `nix fmt`**
exactly like code. prettier re-aligns Markdown tables in particular; hand-editing
a table almost always leaves it non-conformant and fails the `formatting` check.
Beware a false green: the CI `detect` step skips the heavy checks on a pull
request that touches **no** `.nix`, `flake.lock`, or the workflow file — so a
docs-only PR reports success without ever running prettier. The failure then
surfaces on the push-to-`main` run (which always runs the full check) or on the
next unrelated PR that does touch Nix. Run `nix flake check` locally before
merging a docs change, regardless of what the PR check shows.
The CI `formatting` step runs on **every** PR — including docs- and config-only
changes — so a Markdown/YAML/JSON edit is format-checked before merge, not just
after it lands on `main`. (The heavier `deadnix`/`statix`/`pre-commit` lints and
the per-host evaluation still run only when a `.nix` file, `flake.lock`, or the
workflow changed; see `.gitea/workflows/ci.yaml`.) Run `nix fmt` before you
commit and the formatting check stays green.
## Host evaluation
@@ -10,6 +10,7 @@ metadata:
Long-running project (July 2026) reverse-engineering the **Psion Workabout MX** (SIBO OS, NEC V30MX, TopSpeed C) to build a barcode **inventory demo** (scan UPC → DBF database file; add stock, consume by a quantity unit) and, alongside, **complete device programming documentation**. Repo: Gitea **lyrathorpe/sibo-playground**, working branch **`feat/inventory-phase1-scan`** (unmerged). Gitea needs hand-off / the contents API for pushes — see [[git-network-ops]]; [[git-conventions]] for branch/PR rules.
**Committed on the branch (durable, survive reboot):**
- `docs/reference/00-08` + index — the SIBO/MX programming reference (building apps, system/OS, I/O devices, PLIB core, file system & DBF, UI, hardware, and RE'd boot/OS-call internals).
- `code/inventory/` — app scaffold: `upc.c/.h` (UPC-A check-digit validation, correct), `bcode.c/.h`, `scan.c` (Phase-1 diagnostics), `README.md`, **`SCANNER-API.md`** (all scanner findings), **`CONTINUATION.md`** (the on-device debugging procedure to finish).
- `docs/mx-re/toolchain-and-plan.md` — the RE toolchain.