docs(release): make the 0.74.0 notes describe what an operator gets - #1511
Conversation
Four entries described this project's own CI rather than the product: three about pull request preview stacks, which only exist for previewing changes to Hephaestus itself, and one fixing a stream-limit message that never reached a release — the bounds it mis-reported on ship in this same version, so no operator ever saw it. They keep their bodies as empty changesets, where the reasoning stays readable without becoming a release note. The timeout that fix introduces is real and operator-facing, so it moves into the stream-bounds entry that owns that story. Preview seeding also carried a genuine capability under an infrastructure heading; owner impersonation now leads its own entry. MIGRATION.md gains the v0.74.0 heading — nothing renames "Next release" at release time — and drops two references to application-local.yaml, a file that has always been application-local.yml. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LK2yxSEfNL5Q5xwbAqAMWr
|
Warning Review limit reached
Next review available in: 15 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (7)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
maintenance
📚 Documentation Preview
|
1 participant
Description
0.74.0 is the first release since v0.73.2 in July — 191 changesets, and the notes go out to operators
verbatim. This is an editorial pass over them before that happens.
Four entries described this project rather than the product.
Three were about pull request preview stacks. Those exist only for previewing changes to Hephaestus
itself: Coolify deploys one per PR, from a copy of the staging database, on staging's NATS. An
operator running Hephaestus for their team has none, so "a pull request preview now refuses to
start…" is a note about someone else's CI. The fourth was mine, from #1509: it fixes a stream-limit
message that never reached a release, because the bounds it mis-reported on ship in this version —
there is no symptom an upgrading operator would recognise.
All four keep their bodies as empty changesets, so the reasoning stays readable to contributors
without becoming a release note.
One entry buried a real capability under infrastructure.
quiet-real-data-previewsled withpreview seeding and mentioned, in passing, that instance administrators can enter a workspace through
audited owner impersonation. That is a genuine user-facing capability and now leads its own entry.
The timeout #1509 introduces is real, so it moves into the stream-bounds entry that already owns
that story, rather than being lost with the fix narrative.
MIGRATION.md gains its
### v0.74.0heading. Nothing renames### Next releaseat releasetime — no workflow or script touches it — so without this, the next cycle's entries pile into the
same section and no one can tell which release required what. Two references to
application-local.yamlalso becomeapplication-local.yml, the file that actually ships and thespelling every other doc uses.
How to test
Regenerated the changelog in a throwaway worktree and diffed the outcome:
The four removed entries are absent from the regenerated changelog;
LIMIT_UPDATE_TIMEOUTand theimpersonation entry are present.
I also cross-checked the notes against the code rather than trusting them:
${VAR:default}placeholders in
application.yml— all correct, no mismatches.application.yml/.env.example/ compose are exactly the removed and renamed ones those entriesexist to warn about.
read the notes and miss an action they must take.
Checklist
.changeset/README.md**Operators:** …) andMIGRATION.mdis updatedNo changeset of its own:
verify-changesetsscopesSHIPPED_PATHStoserver,webappanddocker, and this edits only.changeset/andMIGRATION.md. Nothing about the shipped artefactchanges — this only alters how it is described.
Notes for reviewers
The judgement worth checking is the preview call.
docker/preview/ships insidedocker/, so it istechnically part of the artefact, and a self-hoster could in principle borrow the tooling to rehearse
an upgrade against a copy of their data. I read the README — Coolify, one stack per pull request,
seeded from
app-postgres-1, sharing staging's NATS — as decisively this repository's own CI, andcut on that basis. If you read it as operator-facing tooling, those three should go back.
The other one to weigh: line 691 sits in the already-released v0.69.0 section. I corrected the
filename there too, on the grounds that it is a typo for a file that has always been
.ymlandleaving it wrong helps nobody — but it is an edit to a shipped section, so it is a deliberate choice
rather than an oversight.