Skip to content

Expand the legacy series-wiring checklist from four places to eight - #204

Merged
ericof merged 2 commits into
mainfrom
docs-wiring-checklist
Aug 28, 2026
Merged

ericof merged 2 commits into
mainfrom
docs-wiring-checklist

Conversation

@ericof

@ericof ericof commented Aug 28, 2026

Copy link
Copy Markdown
Member

legacy/README.md told contributors to "keep four places in sync" when adding a series. That undercounted it.

The sentence named the directory, the matrix table, the Makefile and the workflow — and omitted:

  • the version's own README.md (its validated/hypothesised ledger)
  • the image table in the root README.md
  • the CHANGES.md entry
  • the matrix table's own "remaining N follow these" count

It also collapsed the workflow's paths-filter entry and its ALL list into a single item, though they are separate edits in different parts of the file, with different consequences.

Why it matters

Missing an entry does not break the build, which is exactly why the list needs to be right:

Omission Symptom
ALL entry the image is simply never built on pushes to main — CI stays green
paths-filter entry the series is never rebuilt when shared code changes
a table row the docs quietly disagree with what actually ships

All three are silent. Nothing turns red.

Evidence

Seven series have now been ported against that sentence (#180, #182, #183, #184, #185, #186, #187). Each port recovered the real list from the previous port's commit diff rather than from the document meant to carry it — which works, but only because there was always a previous port to copy from.

The change

The sentence becomes a numbered list of the eight places, with the two workflow edits split apart and the silent-failure mode named. It also records the verification steps that follow: make lint, make -n on all four targets for the new series (the GNU Make 3.81 stem trap), and both smoke gates — SMOKE_CREATE_SITE=1 make test-<version> and make test-demo-<version>.

Docs only — no Dockerfile, Makefile or workflow changes. Four series remain to be ported (#194, #195, #196, #197), all copy-and-wire, so this lands before they do.

The "keep four places in sync" sentence undercounted the work. It named the
directory, the matrix table, the Makefile and the workflow, but omitted the
version's own README, the root README's image table, the CHANGES.md entry, and
the matrix table's "remaining N" count -- and it collapsed the workflow's
paths-filter and its ALL list into one item, though they are separate edits with
different consequences.

Seven series have now been ported against that sentence, and each one had to
recover the real list from the previous port's diff rather than from the
document meant to carry it.

The failure mode is worth naming, so the new text does: missing an entry does
not break the build. A forgotten ALL entry means the image is simply never built
on main; a forgotten table row means the docs disagree with what ships. Both are
silent.

Also records the verification steps that follow the edits -- make lint, make -n
on the four targets for the new series, and both smoke gates.
@ericof ericof self-assigned this Aug 28, 2026
@ericof
ericof merged commit 7573741 into main Aug 28, 2026
6 checks passed
@ericof
ericof deleted the docs-wiring-checklist branch August 28, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant