@@ -13,44 +13,24 @@ Release Tracking Issue and automated workflows triggered by comments or issue ed
1313
1414### Steps
1515
16- 1 . ** Prepare the Release** : Manually run the ** Release: Prepare** workflow from
17- the GitHub Actions UI (or via ` gh workflow run ` ), leaving the ` issue ` input
18- empty. This workflow will:
19- * Automatically determine the next version based on news entries.
20- * Create a new ** Release Tracking Issue** (which serves as the central
21- hub and checklist for the release).
22- * Create a ` prepare-X.Y.Z ` branch.
23- * Update ` CHANGELOG.md ` and version placeholders.
24- * Create a Pull Request with these changes.
25-
26- 2 . ** Review and Merge** : Review, approve, and merge the generated Pull Request.
27- Once merged:
28- * The ** Release: Complete Prepare** workflow will automatically mark the
29- "Prepare Release" task as complete on the tracking issue checklist.
30- * The ** Release: Create Release Branch** workflow will then automatically
31- run (triggered by the issue edit) to cut the ` release/X.Y ` branch and
32- mark the "Create Release branch" task as complete.
33-
34- 3 . ** Tag Release Candidate (RC)** : Comment ` /create-rc ` on the tracking issue.
35- This triggers the ** Release: Create RC** workflow, which:
36- * Tags the release branch with ` X.Y.Z-rcN ` .
37- * Triggers the ** Release: Publish** workflow to publish the release.
38-
39- 4 . ** Announce and Wait** : Announce the RC release (see [ Announcing
40- releases] ( #announcing-releases ) ) and wait for feedback.
41-
42- 5 . ** Handle Backports (if needed)** : If bugs need to be fixed in the release:
43- * Cherry-pick the fixes into the release branch (see [ Patch release with
44- cherry picks] ).
45- * Add the backported PRs to the ` ## Backports ` section of the tracking
46- issue.
47- * Comment ` /process-backports ` on the tracking issue to update the checklist.
48- * Comment ` /create-rc ` again to tag a new RC (e.g. ` rc1 ` ).
49-
50- 6 . ** Final Release** : Once the RC is stable, promote it to final release by
51- manually triggering the ** Release: Promote RC** workflow from the GitHub
52- Actions UI (or using ` gh workflow run ` ), specifying the final version
53- (e.g., ` 0.38.0 ` ).
16+ 1 . ** Prepare the Release** : Run the ** Release: Prepare** workflow manually. It
17+ will automatically determine the next version, create a release tracking
18+ issue, and send a preparation PR.
19+
20+ 2 . ** Approve and Merge** : Approve and merge the PR. Once merged, a release
21+ branch will be created automatically.
22+
23+ 3 . ** Add Backports (if needed)** : If there are backports, add them following
24+ the "How to add backports" steps.
25+
26+ 4 . ** Create an RC** : Comment ` /create-rc ` on the tracking issue. All pending
27+ backports must be successfully processed before creating the RC.
28+
29+ 5 . ** Iterate** : Repeat steps 3 and 4 until backports and RCs are no longer
30+ needed.
31+
32+ 6 . ** Finalize the Release** : Comment ` /promote ` or ` /finalize ` on the
33+ tracking issue to finalize the release.
5434
5535
5636### Manually triggering the release workflow
0 commit comments