Repository navigation
docs: record the two release chores nothing checks for you - #16
Merged
Merged
Conversation
The spec support window is computed, so a spec release needs one edit in app.js — but the README badge that states the range is prose, and `npm run check` reads the npm registry and the published schema, never the README. It would have gone stale silently on 0.7. The widget is the other one: `<ote-events>` is pinned by URL and is a separate version line from the spec (its own `oteSpecVersion` says which spec release it targets, and it lags — v0.8.2 targets OTE 0.4.0). The reader renders nothing itself, so a widget regression is invisible to every check this repo has and only shows up in a browser. Also adds the badges to the README, and states the supported minors in prose above the fold so the answer to "can it open my feed?" does not require reading to the middle of the page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Docs only. No behaviour change, so no version bump.
Why
Two recurring chores in this repo have no automated guard, and both were
found the hard way this week.
The spec badge. The support window is computed from
PUBLISHED_SPEC_VERSIONS, so a spec release is one edit inapp.js— andnpm run checkfails if that list drifts from the npm registry. But theREADME states the range in prose, and the check never reads the README. It
would have gone stale silently at 0.7.
The widget pin.
<ote-events>is pinned by URL inindex.htmland is aseparate version line from the OTE spec — the widget's own
oteSpecVersionsays which spec release it targets, and it lags: v0.8.2 targets OTE 0.4.0.
Confusing the two is why the reader sat two widget releases behind while
looking current. And since the reader renders nothing itself, a widget
regression is invisible to every check here and only shows up in a browser.
CLAUDE.mdnow carries both as checklists, plus a pointer to the README forthe "no dependency on
@opentechevents/validate" reasoning so it is notre-litigated from scratch.
Also
The README badges, and the supported minors stated in prose above the fold —
"can it open my feed?" should not require reading to the middle of the page.
Verified: every badge claim matches the repo (
CNAMEisreader.opentechevents.org,licenseis MIT, the workflow ispages.yml, nobuild step), and the OTE spec badge's
#ote-spec-version-supportanchorresolves to the section added in #12.
🤖 Generated with Claude Code