Skip to content

docs(release): document sync-changelog command in template and guide #4148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickeylev merged 1 commit into from
Sep 4, 2026
+8 −0
Merged

docs(release): document sync-changelog command in template and guide #4148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/release_tracking_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Comment commands:
- `/create-release-branch`: Cuts and pushes the release branch.
- `/create-rc`: Tags and publishes a new release candidate (RC).
- `/process-backports`: Cherry-picks pending backports.
- `/sync-changelog`: Processes sync changelog tasks.
- `/backport <PRs>`: Adds PRs to the backports and processes backports.
- `/promote`: Promotes the latest RC to final release.

Expand Down
7 changes: 7 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,11 @@ If a backport fails to process (e.g., due to cherry-pick conflicts):
cherry-pick the PR, resolve conflicts, push to remote, and manually check
the box on the tracking issue checklist with `status=done` metadata.

If changelog syncing fails (or if you need to retrigger syncing to `main`):
* Comment `/sync-changelog` on the release tracking issue.
* Or trigger the `release_sync_changelog.yaml` workflow manually with the
issue number.

## Automated patch releases to multiple versions

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

## Secrets
Expand Down