Skip to content

fix: the repo-root README was outside every gate, and seven releases stale - #120

Merged
fas89 merged 1 commit into
mainfrom
fix/root-readme-gate
Sep 14, 2026
Merged

fas89 merged 1 commit into
mainfrom
fix/root-readme-gate

Conversation

@fas89

@fas89 fas89 commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator

README.md:18 advertised CLI 0.8.11 against a 0.15.0 pin, and line 19 claimed scaffolds emit fluidVersion: 0.7.4. This is the first thing a GitHub visitor reads.

It was unreachable by the checker on two separate counts

Which is why it survived a 149-agent audit and five merged clusters:

  1. The version sweep iterates _iter_doc_files(DOCS_DIR) — everything under docs/. The root README is not under docs/, so no pattern was ever applied to it.
  2. Even once included, the CLI release bullet pattern required the version to follow CLI release immediately:
    re.compile(r"(?i)^\s*[-*]\s*CLI\s+release\s*" + _V)
    The README writes "Current CLI release documented here: 0.8.11" — the interposed words defeat the match.

I only found the second because the first didn't work

After widening the file sweep I seeded the stale value back and the gate stayed green. A fix that isn't canary-tested is a guess.

The canary now behaves correctly:

$ # seed 0.8.11 back
FAIL: 1 version claim(s) contradict docs/.vuepress/cli-version.json:
  README.md:18: CLI release bullet says CLI 0.8.11, pin is 0.15.0
      - Current CLI release documented here: `0.8.11`

$ # restore
exit 0

And the gate now runs when that file changes

cli-consistency.yml gains README.md to its path filter. A gate that cannot be triggered by the file it guards is the same defect in a different place.

…stale

`README.md:18` advertised CLI `0.8.11` against a `0.15.0` pin, and line 19
claimed scaffolds emit `fluidVersion: 0.7.4`. This is the first thing a GitHub
visitor reads.

**It was unreachable by the checker on two separate counts**, which is why it
survived a 149-agent audit and five merged clusters:

1. The sweep iterates `_iter_doc_files(DOCS_DIR)` — everything under `docs/`.
   The root README is not under `docs/`, so no pattern was ever applied to it.
2. Even once included, the "CLI release bullet" pattern required the version to
   follow `CLI release` immediately. The README writes "Current CLI release
   **documented here:** `0.8.11`", and the interposed words defeated the match.

Both are fixed, and I only found the second because the first did not work: after
widening the file sweep I seeded the stale value back and the gate stayed green.
A fix that is not canary-tested is a guess. The canary now behaves correctly —
seeding `0.8.11` produces `README.md:18: CLI release bullet says CLI 0.8.11, pin
is 0.15.0`, and restoring it exits 0.

`cli-consistency.yml` gains `README.md` to its path filter, so editing that file
actually runs the job that now checks it. A gate that cannot be triggered by the
file it guards is the same defect in a different place.
@fas89
fas89 merged commit f8ccf0d into main Sep 14, 2026
5 checks passed

This branch was successfully deployed

1 active deployment
github-pages — 18f976c9 Deployed Sep 14, 2026 by fas89 via deploy #148
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