Use the pull request base ref for public symbols checks - #5502
Open
saisharan0103 wants to merge 1 commit into
Open
Conversation
|
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
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.
The public symbols checker currently diffs against
main: the workflow prepares a localmainbranch before checking out the PR head, andscripts/public_symbols_checker.pycallsrepo.commit("main")directly.For release-branch pull requests, especially patch release PRs, that compares API changes against the default branch instead of the release branch base. This can produce false public API failures that require the approval-label workaround.
This updates
scripts/public_symbols_checker.pyto resolve the comparison ref fromGITHUB_BASE_REFwhen running in pull request CI. It prefersorigin/<base>when available, falls back to the local branch name, and keepsmainas the fallback for local or non-PR runs. The existing diff logic now uses that resolved commit instead ofrepo.commit("main").Generated workflow files are unchanged. The contrib reusable workflow branch pin remains a separate documented limitation because GitHub Actions
uses:cannot be parameterized.Fixes #5139.
ruff check scripts/public_symbols_checker.pyreports no new findings on the changed files.