timothy
fba5233caf
168 records -> docs/decisions/records/<area>/<topic>.md (163 active, 23 dirs) and docs/decisions/archive/<area>/<topic>.md (5 archived). The filename IS the key, so one-active-record-per-key becomes a filesystem property rather than a validator check, and supersession becomes a `git mv`. WHY: the monolith was a concurrency problem before an aesthetic one. A 3,900-line append target made parallel sessions collide -- PR #605 and PR #614 both hit append-vs-append conflicts during routine rebases, and hand-resolving those inside the corpus is exactly the operation the rationale-rewrite guard exists to police. HOW IT IS VERIFIED: a ~170-file diff cannot be meaningfully read, so correctness does not rest on reading it. The parser was taught BOTH formats first, so the body-diff guard parses the old form at the merge-base and the new form at head -- the migration validates itself, no bypass. The proof is a field-level equivalence harness: 168 records before and after, zero lost, zero gained, zero field mismatches, zero rationale bodies differing. Reviewers should scrutinise the harness; it is the actual evidence. What measuring caught that reading would not have: - ~500 lines sit OUTSIDE any record -- decisions.md's lifecycle schema and each topic file's preamble, mostly the only copy. Source files are kept and stripped, never deleted. They also cannot be filed per-area: topic files hold several areas and 4 of 23 areas span several files. - Archive discovery was a non-recursive glob; after the split it found ZERO archived records, surfacing as four bogus "supersedes points to unknown key" errors rather than an obvious failure. - ~32 live docs point into the corpus BY DATE, which the split dangles. Each stripped file now ends with a generated "Records formerly in this file" index, which also rescues the identical breadcrumbs in old issue comments. - decisions.md's "In this file:" list was 97 same-file anchor bullets that the split makes WRONG, not merely stale. Dropped; the generated index replaces them with links that resolve. The equivalence harness now runs against a checked-in FIXTURE, not the live corpus. The earlier version migrated the real tree, which made it a one-shot: the moment the migration landed there was nothing left to move and the tests failed for reasons unrelated to the code. A fixture keeps them testing the SCRIPT rather than the repo's current state. Keys preserved verbatim, warts included: `sched` (12) and `scheduling` (1) remain two directories for one concept. Renaming a key is not a move -- it changes identity, breaks the equivalence proof, and invalidates MemPalace's per-key drawers. Taxonomy normalisation is separate work. refs #610
3.3 KiB
key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
| key | title | status | since | supersedes | superseded-by | rule | signals | mechanics |
|---|---|---|---|---|---|---|---|---|
| ci.docs-only-skip-steps | 2026-07-17 — Docs-only CI skip gates STEPS in always-running required jobs, never `if:`-skips them (#416) | active | 2026-07-17 | none | none | A docs-only change must still run every required job (`test`, `migrations`) so their commit-status contexts always report; each heavy job runs `scripts/ci-detect-docs-only.sh` first and gates its real STEPS on `if: steps.detect.outputs.docs_only != 'true'`, never `if:`-skips the whole job (an `if:`-skipped job reports `skipped`, not `success`, which branch protection may never unblock on). Detection biases toward running more on any doubt. | docs-only CI skip, required-context branch protection, step-level gating vs job-level `if:` · paths: `.gitea/workflows/docker-build.yml`, `scripts/ci-detect-docs-only.sh` · issues: #416, #418, #420, #398 | `docs/ci-cd.md` → "Docs-only skip" |
A change touching only docs/** or *.md ran the entire docker-build.yml matrix (test,
migrations incl. its mysql:8.4 service, functional-e2e, format, api-docs) — ~9 min of warm
CI to validate Markdown. docker-build.yml had no path filtering.
Why not paths-ignore / an if:-skipped job — the trap. main's branch protection requires
two contexts by name (Build & test (.NET), EF migration integrity (SQLite + MySql)). If a
docs-only PR produced no run for them, those contexts never report and the PR can never merge
— the naive fix bricks docs PRs instead of speeding them. A probe (throwaway PR #418) confirmed that
on Gitea 1.25.4 an if:-skipped job reports commit-status state skipped (a distinct state,
not success); how branch protection treats a skipped required context is not something we rely
on.
The decision. Each heavy job (test, migrations, functional-e2e, build) runs
scripts/ci-detect-docs-only.sh as its first post-checkout step (id: detect) and gates every real
step on if: steps.detect.outputs.docs_only != 'true'. The job always runs and reports
success in seconds on docs-only — so the two required contexts report unconditionally (safe by
construction). Non-required jobs may skip freely (production proves a skipped non-required context
doesn't block merge — build is skipped on every PR), so build skips its image steps on a
docs-only push to main (docs aren't in the image); tag builds force docs_only=false so a
release is never skipped. api-docs/format already self-short-circuit; docs-reminder/
decisions-guard/ci-image-pin keep running.
Detection biases toward running MORE. docs_only=true only when every changed path is docs;
any code path, a tag build, a non-merge push, or an undeterminable diff → false (run everything). A
false true would skip real tests on a code change (a correctness bug); a false false merely wastes
CI. Trade-off accepted: migrations' mysql service still starts on a docs-only run (a services:
container starts with the job regardless of step if:), but the 787-migration replay — the expensive
part — is skipped.
Two adjacent redundancies are deliberately out of scope: the whole matrix re-running on a PR and
again on the merge-to-main over identical code (#420), and the within-run triple dotnet build
(#398). Full mechanism in ci-cd.md → "Docs-only skip".