Skip to content

Commit 8cd82d2

Browse files
committed
docs: update RELEASING.md to clarify automated steps
Clarifies that the tracking issue is created automatically by the Prepare workflow, and that the release branch is cut automatically after the prepare PR is merged.
1 parent 7fb99b5 commit 8cd82d2

1 file changed

Lines changed: 22 additions & 23 deletions

File tree

RELEASING.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,42 +13,41 @@ Release Tracking Issue and automated workflows triggered by comments or issue ed
1313

1414
### Steps
1515

16-
1. **Create a Release Tracking Issue**: Go to the GitHub Issues page and create
17-
a new issue using the **Release Tracking Issue** template. This issue serves
18-
as the central hub and checklist for the release.
19-
20-
2. **Prepare the Release**: Comment `/prepare` on the tracking issue. This
21-
triggers the **Release: Prepare** workflow which:
22-
* Automatically determines the next version based on news entries.
23-
* Creates a `prepare-X.Y.Z` branch.
24-
* Updates `CHANGELOG.md` and version placeholders.
25-
* Creates a Pull Request with these changes.
26-
27-
3. **Review and Merge**: Review, approve, and merge the generated Pull Request.
28-
Once merged, the **Release: Complete Prepare** workflow will automatically
29-
mark the "Prepare Release" task as complete on the tracking issue checklist.
30-
31-
4. **Create Release Branch**: Manually check the **Create Release branch** box
32-
on the tracking issue checklist. This triggers the **Release: Create Release
33-
Branch** workflow, which cuts the `release/X.Y` branch.
34-
35-
5. **Tag Release Candidate (RC)**: Comment `/create-rc` on the tracking issue.
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.
3635
This triggers the **Release: Create RC** workflow, which:
3736
* Tags the release branch with `X.Y.Z-rcN`.
3837
* Triggers the **Release: Publish** workflow to publish the release.
3938

40-
6. **Announce and Wait**: Announce the RC release (see [Announcing
39+
4. **Announce and Wait**: Announce the RC release (see [Announcing
4140
releases](#announcing-releases)) and wait for feedback.
4241

43-
7. **Handle Backports (if needed)**: If bugs need to be fixed in the release:
42+
5. **Handle Backports (if needed)**: If bugs need to be fixed in the release:
4443
* Cherry-pick the fixes into the release branch (see [Patch release with
4544
cherry picks]).
4645
* Add the backported PRs to the `## Backports` section of the tracking
4746
issue.
4847
* Comment `/process-backports` on the tracking issue to update the checklist.
4948
* Comment `/create-rc` again to tag a new RC (e.g. `rc1`).
5049

51-
8. **Final Release**: Once the RC is stable, promote it to final release by
50+
6. **Final Release**: Once the RC is stable, promote it to final release by
5251
manually triggering the **Release: Promote RC** workflow from the GitHub
5352
Actions UI (or using `gh workflow run`), specifying the final version
5453
(e.g., `0.38.0`).

0 commit comments

Comments
 (0)