Files
ersatztv/docs/decisions/archive/docs/append-only-guard.md
T
timothy fba5233caf
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 11s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Failing after 23s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m17s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 1m29s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m5s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 16m5s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m6s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
feat(610): split the decision corpus into one YAML-frontmatter file per record
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
2026-07-25 19:45:09 +02:00

2.4 KiB

key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
key title status since supersedes superseded-by rule signals mechanics
docs.append-only-guard 2026-07-12 — decisions.md is append-only, enforced; root-screenshot guard (#303 H9/H3) superseded 2026-07-12 none docs.decision-lifecycle@2026-07-21 (superseded) `docs/decisions.md` is append-only, enforced by hook + CI. decisions-guard hook · paths: `.claude/hooks/decisions-guard.sh`, `.husky/commit-msg` · issues: #303 (H9) superseded by `scripts/decisions_validate.py` (ersatztv#521); see `docs/decisions.md` → `docs.decision-lifecycle`

This log is append-only by construction, not just by convention. A commit or PR that deletes or modifies an existing line of docs/decisions.md is blocked — by the Husky commit-msg hook (.claude/hooks/decisions-guard.sh staged) locally and the blocking decisions-guard CI job (same script, range mode) on PRs. Shared detection, deliberately different granularity: the Husky hook gates each commit (its own message must carry the token); CI gates the PR-wide net diff (token in any commit of the range suffices), so the local hook is the stricter primary gate and CI the push/bypass backstop. Insertions anywhere are always allowed, so a normal new entry (TOC line near the top + a block appended at the bottom, both pure insertions) passes untouched. Detection is git diff --numstat deleted-count > 0, which is robust to markdown - list markers (a byte-level - prefix would false-match). The block is lifted only by the literal [decisions-edit] token in the commit message, reserved for two cases: fixing a factual error, and superseding a reversed decision (add the new entry, prepend a > **Superseded …** banner to the old one, tag its Index line (superseded) — keep the old rationale, never silently rewrite). Consolidation of superseded entries is a release-checklist step (docs/ci-cd.md → Versioning & releases), backstopped by a non-blocking 1800-line size floor in the decisions-guard job (the read-cost point past which the log no longer fits one default agent Read), so append-only doesn't accrete contradictory or unreadably-large history between releases (Timothy's call, 2026-07-12: mark-and-keep on reversal, consolidate at each milestone, size-floor backstop).

The companion H3 root-screenshot guard was split out during the #521 migration to the active record ci.root-screenshot-guard in docs/decisions/release-ci-governance.md.