feat(readme): ADR-004 Phase B — readme-derive reusable workflow + vocab gate#475
Merged
Merged
Conversation
…ab gate Implements the accepted ADR-004 (README single-source derivation): - .github/workflows/readme-derive-reusable.yml: workflow_call reusable that reads a [publishing.readme] declaration from descriptiles ECOSYSTEM.a2ml (6a2 fallback during migration), and ONLY for opted-in repos derives README.md from README.adoc (asciidoctor-reducer -> docbook -> pandoc gfm), stamps a GENERATED banner + SPDX, runs the vocab gate, then a fail-and-tell freshness check. Undeclared repos are skipped — the anti-runaway guard. - .github/scripts/readme-vocab-gate.sh: fail-closed >=98% vocabulary- preservation gate (tested: 100% on faithful conversion, hard-fails on loss). - doc-format.yml: reverse the runaway-era rule. README.adoc is canonical; a README.md beside it is valid only as a GENERATED-stamped derived artefact, otherwise flagged as a hand-maintained duplicate. Lone README.adoc is correct — no more nudge-to-Markdown. - ECOSYSTEM.a2ml.template: documented optional [publishing.readme] stanza. - ADR-004: status -> Accepted; open items resolved at defaults; sketch aligned to the real flat-TOML ECOSYSTEM format. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
hyperpolymath
enabled auto-merge (squash)
July 7, 2026 19:29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Implements the accepted ADR-004 (README single-source derivation). Phase B: the machinery, no repo flips yet.
readme-derive-reusable.yml—workflow_callreusable. Reads a[publishing.readme]table from descriptilesECOSYSTEM.a2ml(6a2 fallback during migration). For opted-in repos only:asciidoctor-reducer→ docbook →pandocgfm → GENERATED+SPDX stamp → vocab gate → fail-and-tell freshness check. Undeclared repos are skipped entirely — the anti-runaway guard..github/scripts/readme-vocab-gate.sh— fail-closed ≥98% vocabulary-preservation gate. Tested locally: 100% on a faithful conversion, hard-fails on real content loss.doc-format.yml— reverses the June-runaway-era rule.README.adocis canonical estate-wide; aREADME.mdbeside it is valid only as a GENERATED-stamped derived artefact, else flagged as a hand-maintained duplicate. A loneREADME.adocis correct (no more nudge-to-Markdown).ECOSYSTEM.a2ml.template— documented optional[publishing.readme]stanza.Accepted defaults (no owner veto on §Open items)
ECOSYSTEM.a2ml[publishing.readme](not standalone PUBLISHING.a2ml)Next (Phase C)
Pilot flips of boj-server (consumer=glama) and hyperpolymath/hyperpolymath (consumer=github-profile) to authored
.adoc+ derived.md— those PRs will be left un-armed pending visual verification on Glama / the profile page, per the ADR Phase C gate.🤖 Generated with Claude Code