This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user