Skip to content

Commit fc4ee15

Browse files
authored
docs(release): document sync-changelog command in template and guide (#4148)
The /sync-changelog command was added to on_comment and the release tool CLI, but was omitted from the release tracking issue template and troubleshooting documentation. Add /sync-changelog to the Available Commands section of the release tracking issue template, and document how to retry changelog syncing in RELEASING.md.
1 parent d42e0dd commit fc4ee15

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/release_tracking_template.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Comment commands:
3636
- `/create-release-branch`: Cuts and pushes the release branch.
3737
- `/create-rc`: Tags and publishes a new release candidate (RC).
3838
- `/process-backports`: Cherry-picks pending backports.
39+
- `/sync-changelog`: Processes sync changelog tasks.
3940
- `/backport <PRs>`: Adds PRs to the backports and processes backports.
4041
- `/promote`: Promotes the latest RC to final release.
4142

‎RELEASING.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,11 @@ If a backport fails to process (e.g., due to cherry-pick conflicts):
193193
cherry-pick the PR, resolve conflicts, push to remote, and manually check
194194
the box on the tracking issue checklist with `status=done` metadata.
195195

196+
If changelog syncing fails (or if you need to retrigger syncing to `main`):
197+
* Comment `/sync-changelog` on the release tracking issue.
198+
* Or trigger the `release_sync_changelog.yaml` workflow manually with the
199+
issue number.
200+
196201
## Automated patch releases to multiple versions
197202

198203
If you need to backport a PR to multiple older active release branches (e.g.,
@@ -316,6 +321,8 @@ The checklist items use metadata suffix: `| key=value key2=value2`.
316321
issue (or on the preparation PR) to mark the preparation task as done.
317322
* **Create Release Branch**: Comment `/create-release-branch` on the tracking
318323
issue to cut and push the release branch.
324+
* **Retry Changelog Sync**: Comment `/sync-changelog` on the tracking issue to
325+
retrigger creating the sync PR to `main` for backports.
319326
* **Force Task Done**: Check the box `- [x]` and add appropriate metadata (e.g. `status=done`).
320327

321328
## Secrets

0 commit comments

Comments
 (0)