Repository navigation
Commit 717c886
committed
docs(release): make the release playbook coherent with the promote flow
Final coherence pass over docs/release.md (and the releasing.md
pointer) after several incremental patches to the release-cycle
rework left the whole-document narrative uneven.
- Rewrite the regular and patch release sequences so a maintainer
reading top-to-bottom performs the actual flow: cut rc -> watch
mandatory rc E2E -> [optional Generate RC Changelog button] ->
promote dispatch (E2E gate; changelog generated or picked up;
website docs PR opened and parked) -> review the promote PR (no
E2E by default; E2E/changelog/website-docs lines) -> merge ->
finalize -> merge the parked website PR, then announce.
- Purge the last old-model sentence: "vX.Y.0 is tagged from the
last RC or a later commit in main" -> promoted from the rc by
digest, tag cut write-once at the promote PR merge commit.
- State the alpha/beta contract where prereleases are discussed:
built and published, button-only E2E (no mandatory rc-e2e), and
no promotion path (promote-rc accepts vX.Y.Z-rc.N alone).
- Fix the Phase 4 heading (was "chore(release): cut vX.Y.Z"; the
PR is "chore(release): promote ... -> ...") and add the missing
website-docs line to the reviewer checklist; add a
keep-parked-until-publish item to the pre-release checklist.
- Add cut-prerelease.yaml, changelog-rc.yaml, and
changelog-generate.yaml to "See also" so the workflow inventory
is complete and consistent with the "seven workflows + reusable
changelog-generate" count.
- releasing.md: replace the stale "typically involves ... creating
git tags / building artifacts" list (invalidated by the
promote-not-rebuild model) with the real high-level sequence.
Every workflow/job/step name cited was verified against the YAML on
this branch. hack/release-changelog-contract.bats stays green (24/24);
no test pins docs/release.md strings, so no test change was needed.
Assisted-By: Claude <[email protected]>
Signed-off-by: Myasnikov Daniil <[email protected]>1 parent 01e1e71 commit 717c886
2 files changed
Lines changed: 28 additions & 25 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
29 | 29 | | |
0 commit comments