Skip to content

v0.20.1 — Documentation hygiene + validation CI

Choose a tag to compare

@pedrofuentes pedrofuentes released this 02 Jul 21:14
· 19 commits to main since this release
f8e1b04

Documentation-hygiene release. A full repo audit found the manual release checks (root AGENTS.md §Versioning / §Testing Changes) had leaked drift across several surfaces. All fixes are pointer/typo corrections — no template behavior changes. The same checks are now automated in CI so this class of drift can't recur.

Added

  • Repo validation CI (scripts/validate.sh + .github/workflows/validate.yml): automates the checks root AGENTS.md already prescribed manually — version sync across all surfaces, setup-placeholder inventory audit (with runtime-placeholder allowlist), the ≤135/≤178 line budgets, setup-block marker integrity, relative-link and §-reference validity, Structure-tree ↔ file-layout agreement, and a severity-level tripwire guarding the deliberate 3-place duplication. Pure bash, no dependencies; repo infrastructure only — nothing added to template/. On its first run it caught a live drift (see Fixed).

Fixed

  • Stale root version marker (root AGENTS.md line 1): read v0.12.2 through 8 subsequent releases. Bumped, and §Versioning now enumerates every version surface.
  • Contradictory compression budget (root AGENTS.md §ASK FIRST): said ≤130 non-blank lines post-setup while §Compression says ≤135. Aligned to ≤135.
  • Dangling cross-references to a removed section: README §Invoking Sentinel and SETUP.md §After Customization pointed at docs/SENTINEL.md §Infrastructure Enforcement, which no longer exists. README now carries a Method A/B/C legend (the table used those labels without defining them); SETUP.md describes Method B inline and points at the real §Deploy / release gating section.
  • Post-adoption dangling pointer (SETUP.md): "see README.md" — README isn't copied downstream. Replaced with self-contained text.
  • Runtime-placeholder trap (SETUP.md §Verification): the "no results = done" check could push a setup agent to "fix" SENTINEL.md's intentional {{branch}}/{{sha}} runtime placeholders. Explicit exception list added.
  • Website advertised a removed feature (docs/index.html): fixability classification (🔧/🧠/👤) and unverifiable timing claims removed.
  • CHANGELOG date typo: [0.14.0] corrected to 2026-05-26 (its tag date), restoring monotonic ordering.
  • SETUP.md placeholder-inventory mismatch (caught by the new validate.sh on its first run): aligned to the actual DEVELOPMENT-WORKFLOW.md token.
  • README template/docs/sentinel/ row now mentions SEVERITY-RUBRIC.md and BACKLOG-HYGIENE.md; .gitignore now covers .impeccable/.

Also retro-tagged v0.1.0, v0.5.0, v0.12.2, v0.13.1 (releases documented in the CHANGELOG that were never tagged). v0.8.0 was not retro-tagged: its changes shipped inside the same squashed commit as v0.9.0 (7b7fc08), so no distinct commit exists for it.

Full changelog: https://github.com/pedrofuentes/agents-template/blob/main/CHANGELOG.md