chore(readme): flip to single-source .adoc + derived .md (ADR-004 pilot)#281
Merged
Merged
Conversation
boj-server is one of two estate repos with a genuine Markdown-only consumer (Glama, which renders README.adoc as raw markup). Per ADR-004, flip it from a hand-authored README.md to authored README.adoc + CI-derived README.md: - README.adoc: new canonical source (bootstrapped from the prior README.md via the ADR-004 recipe; sets :idprefix:/:idseparator: - so the TOC anchors resolve on GitHub and re-derive cleanly). - README.md: now a GENERATED artefact (banner stamped; do not hand-edit). Verified faithful: 11/11 TOC anchors resolve, 12/12 badges intact (incl. Glama), blockquote + inline code round-trip clean. - ECOSYSTEM.a2ml: [publishing.readme] declaration (consumer=glama) — the machine-readable opt-in the derive workflow reads. - .github/workflows/readme-derive.yml: caller for the standards reusable; regenerates + freshness-checks README.md on changes. Local verification (pandoc 3.10 + asciidoctor 2.0.26): vocab gate 98.7%, normalised freshness byte-identical, anchor guard satisfied. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🔍 Hypatia Security ScanFindings: 215 issues detected
View findings[
{
"reason": "Action actions/checkout@v4 needs attention",
"type": "unpinned_action",
"file": "pages-deploy.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in build.yml",
"type": "missing_timeout_minutes",
"file": "build.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in pages-deploy.yml",
"type": "missing_timeout_minutes",
"file": "pages-deploy.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in push-email-notify.yml",
"type": "missing_timeout_minutes",
"file": "push-email-notify.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in scorecard-enforcer.yml",
"type": "missing_timeout_minutes",
"file": "scorecard-enforcer.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in scorecard-enforcer.yml",
"type": "scorecard_publish_with_run_step",
"file": "scorecard-enforcer.yml",
"action": "split_scorecard_publish_job",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Issue in instant-sync.yml",
"type": "secret_action_without_presence_gate",
"file": "instant-sync.yml",
"action": "peter-evans/repository-dispatch",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Issue in codeql.yml",
"type": "codeql_missing_actions_language",
"file": "codeql.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/boj-server/boj-server/cartridges/academic-workflow-mcp/adapter/mod.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/boj-server/boj-server/cartridges/ephapax-mcp/adapter/mod.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
}
]Powered by Hypatia Neurosymbolic CI/CD Intelligence |
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
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.
Phase C of ADR-004 (README single-source derivation). boj-server is one of two estate repos with a real Markdown-only consumer (Glama, which renders
README.adocas raw markup — see awesome-mcp-servers#9563).The ADR Phase C gate is explicit: verify the derived README renders correctly on Glama before the hand-authored README.md is replaced. Hence draft + un-armed.
What changed
README.adoc:idprefix:/:idseparator: -so the 15-entry TOC resolves.README.md.machine_readable/6a2/ECOSYSTEM.a2ml[publishing.readme]declaration,consumer = glama.github/workflows/readme-derive.ymlFidelity — verified end-to-end (pandoc 3.10 + asciidoctor 2.0.26)
boj_*,{error, hint}) round-trip cleanOwner action
README.adocon GitHub (TOC links should work).db12a6a; repin to include standards#476 (anchor guard) once it lands — this repo's .adoc already satisfies it.Depends on: standards#475 (merged), standards#476 (armed).
🤖 Generated with Claude Code