build(release): separate sync changelog into standalone workflow and CLI tool - #4067
Merged
rickeylev merged 5 commits intoAug 17, 2026
Merged
Conversation
…CLI tool Currently, when a backport is made to a release branch by the release tool and workflow, the same job and logic tries to create the corresponding sync PR to main. This couples backport processing with changelog synchronization, preventing the changelog sync from being triggered or retried independently. Separate changelog synchronization into a dedicated `release sync-changelog` CLI command and a standalone GitHub Actions workflow that can run automatically or be manually dispatched. Update the backport processing logic and workflow to record the sync changelog task without executing it directly.
…t input handling Refactor sync changelog processing into dedicated workflows and streamline event input resolution. Why: - Isolate sync changelog and completion jobs into separate reusable workflows for clarity and maintainability. - Avoid passing manual CLI arguments in GitHub Actions by reading event context directly from GITHUB_EVENT_PATH. - Improve logging visibility with workflow command annotations and clean issue comments. How: - Extract complete sync changelog logic into release_sync_changelog_complete.yaml workflow. - Update release_sync_changelog.yaml and release_sync_changelog_complete.yaml to run without CLI flag passing. - Add GitHubEventDict and GITHUB_EVENT_PATH parser helpers to gh.py. - Configure GitHubActionsLogHandler in release.py for GHA notices, warnings, and errors. - Simplify tracking issue comment messages and link to workflow runs.
…er and add gha test fixture Refactor PR closed event handling to use a dedicated Python parsing script and introduce a reusable GitHub Actions test fixture. Why: - Align on_pr_closed workflow structure with on_comment.yaml using a separate parser step that reads GITHUB_EVENT_PATH. - Remove redundant sync-changelog trigger on PR close since sync PRs are created during backport handling. - Simplify GHA environment setup in release tool unit tests with a shared fixture. How: - Add .github/workflows/on_pr_closed.py and update on_pr_closed.yaml to dispatch to process_backports or release_sync_changelog_complete.yaml. - Remove CLI --issue argument from release_sync_changelog.yaml and rename step to "Create Sync PR to Main". - Introduce gha test fixture in release_test_helper.py and add on_pr_closed_test.py.
Add repo attribute annotation on GitHubInterface to resolve pyrefly type checking in release_lib. Why: - Pyrefly strict type checking in CI caught missing repo attribute on GitHubInterface in sync_changelog.py. How: - Annotate repo: str on GitHubInterface in gh.py. - Provide default empty string fallback for repo argument in _get_workflow_action_url_text.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport processing previously combined applying backports to a
release branch with synchronizing the changelog back to main. This
tight coupling prevented changelog synchronization from being
triggered, dispatched, or retried independently of the backport
process.
Separate changelog synchronization into a dedicated sync-changelog
CLI command and standalone GitHub Actions workflows. Update backport
processing to record changelog sync tasks rather than executing them
directly. Add event parsing helpers to inspect GITHUB_EVENT_PATH in
workflows, integrate GitHub Actions workflow command annotations
into release logging, and expand documentation and test coverage.