swaits/meshcore-spec
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

spec: link corpus references to GitHub, version-aware

Browse Source 
Every "Test vectors: \`corpus/...\`" mention in the spec is now a
markdown link pointing at the corresponding file or directory on
GitHub. Each version build resolves its links to the correct git
ref:

  - /latest/ -> https://github.com/swaits/meshcore-spec/tree/main/corpus/...
  - /v0.1.0/ -> https://github.com/swaits/meshcore-spec/tree/v0.1.0/corpus/...
  - future /vX.Y.Z/ -> /tree/vX.Y.Z/corpus/...

Two changes:

1. src/*.md (18 files): the inline-code corpus paths in each
   "Cross-References" section are now markdown links. Directories
   point at /tree/main/corpus/..., individual .json files point at
   /blob/main/corpus/.... CHANGELOG and other non-corpus main links
   are intentionally left pointing at main — the canonical history
   lives there regardless of which version you're reading.

2. justfile: `cut-version` now also runs a sed over the snapshot's
   *.md files replacing /tree/main/corpus -> /tree/<VERSION>/corpus
   and /blob/main/corpus -> /blob/<VERSION>/corpus. So a freshly-cut
   version is self-consistent.

versions/v0.1.0/* regenerated by re-running
`just cut-version v0.1.0` after the new src/ links + recipe sed
landed.

Tagging the release commit (`git tag v0.1.0`) is now REQUIRED — not
"optional" — because the rendered /v0.1.0/ pages reference
/tree/v0.1.0/corpus/... on GitHub. Without the tag the links 404.
cut-version's output now says so.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
swaitsandClaude Opus 4.7 committed 2026-05-12 10:35:09 -06:00
1 parent b6c91505e1
commit f83d4088e3
38 files changed
+46 -38
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

justfile
+9 -1
View File
@@ -74,8 +74,16 @@ cut-version VERSION:
echo "snapshot still says 'latest (main)'. Check that src/00-overview.md" >&2
echo "contains the marker line ('**Spec version:** \`latest (main)\`')." >&2
fi
# Repoint corpus links to this version's GitHub tree. The spec keeps
# CHANGELOG links pointing at main (more useful — full history) by
# only matching .../tree/main/corpus and .../blob/main/corpus.
find "versions/{{VERSION}}" -name '*.md' -exec sed -i \
-e 's|/tree/main/corpus|/tree/{{VERSION}}/corpus|g' \
-e 's|/blob/main/corpus|/blob/{{VERSION}}/corpus|g' \
{} +
echo "Snapshotted src/ -> versions/{{VERSION}}"
echo
echo "Next steps:"
echo " - git add versions/{{VERSION}} && commit (e.g. \"release {{VERSION}}\")"
echo " - optionally tag the commit: git tag {{VERSION}}"
echo " - git tag {{VERSION}} # REQUIRED so the corpus links in /{{VERSION}}/"
echo " # resolve on GitHub (they point at tree/{{VERSION}}/...)"