Skip to content

docs: add release step checking homepage claims against CHANGELOG #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmealing merged 1 commit into from
Oct 30, 2026
Merged

docs: add release step checking homepage claims against CHANGELOG #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/RELEASING-docs-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ not an edit. Confirm rather than change:
is versioned as the tag — that is what identifies the npm line, since the legacy
JVM-only `v7.x` tags still sort above it. Read the `pinned to metaobjects vX.Y.Z` line
in the deploy log; a wrong pin publishes a stale site with every step green.
- [ ] **Diff the CHANGELOG against the homepage's prose claims.** Version numbers are
injected, but claims are not: the 1.2.0 cut left the homepage saying things the
release had made false. Read this release's user-visible `CHANGELOG.md` entries
against `www/index.html` — "What fails the build", "Who it's for", "Using it with
the ORM you have" — and the help-section gaps list. A stale claim becomes a PR on
the site repo, which merges only on a maintainer's word, because a merge redeploys.
- [ ] Preview exactly what a deploy would render, without touching the site checkout:
`bun run site:preview --site <site-repo>/www --strict`.
- Deploys automatically via `.github/workflows/deploy.yml` on push to the default branch.
Expand Down
4 changes: 4 additions & 0 deletions docs/RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,10 @@ git push origin main # NO tag here — see golden ru
**The `v<version>` tag is cut LAST, by `scripts/finish-release.mjs`** — after PyPI, NuGet
and Maven have been bumped, committed and published. See golden rule 7.

**After the version propagation, check the site's prose.** The site injects version
numbers but not claims; walk the "Diff the CHANGELOG against the homepage's prose claims"
item in [`RELEASING-docs-checklist.md`](RELEASING-docs-checklist.md) §B.

### 4. Cleanup
```bash
# deprecate any broken/superseded RCs
Expand Down
Loading