mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Fix JS API change false positives for out-of-sync branches (#56871)
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/56871 `diff-js-api-changes` was posting false positive "JavaScript API change detected" warnings on PRs that never modified `ReactNativeApi.d.ts`. This happened because the action ran `git merge-base` against limited local history (`git fetch --depth=500`), which couldn't find the common ancestor for branches that were far behind main — including (often) pick requests to release branches. The fallback wrote an empty "before" snapshot, causing the entire API surface to appear newly added. {F1989977284} #### Changes - Query the GitHub API first — if the PR doesn't touch `ReactNativeApi.d.ts`, skip the diff entirely. - When the snapshot is touched, use the GitHub compare API to resolve the merge base instead of relying on local git history. - Limit the check to PRs targeting `main` or `*-stable` branches. Changelog: [Internal] Reviewed By: christophpurrer Differential Revision: D105572432 fbshipit-source-id: 20e5db01c9e6b51acb55548746c8fd512a363274
This commit is contained in:
1 parent
948835d944
commit
88a6ace533
1 file changed
+35
-14
@@ -7,30 +7,51 @@ outputs:
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Fetch PR and main, compute merge base
|
||||
id: merge_base
|
||||
shell: bash
|
||||
env:
|
||||
PR_SHA: ${{ github.event.pull_request.head.sha }}
|
||||
run: |
|
||||
git fetch origin main
|
||||
git fetch origin "$PR_SHA" --depth=500
|
||||
echo "merge_base=$(git merge-base "$PR_SHA" origin/main)" >> $GITHUB_OUTPUT
|
||||
- name: Resolve API diff inputs
|
||||
id: api_diff
|
||||
uses: actions/github-script@v8
|
||||
with:
|
||||
script: |
|
||||
// Check if we are targeting main or a stable branch
|
||||
const baseRef = context.payload.pull_request.base.ref;
|
||||
if (baseRef !== 'main' && !baseRef.endsWith('-stable')) {
|
||||
core.setOutput('changed', false);
|
||||
return;
|
||||
}
|
||||
|
||||
- name: Extract before and after API snapshots
|
||||
// Check if the diff touches ReactNativeApi.d.ts
|
||||
const files = await github.paginate(github.rest.pulls.listFiles, {
|
||||
...context.repo,
|
||||
pull_number: context.payload.pull_request.number,
|
||||
});
|
||||
const changed = files.some(f => f.filename === 'packages/react-native/ReactNativeApi.d.ts');
|
||||
core.setOutput('changed', changed);
|
||||
if (!changed) return;
|
||||
|
||||
// Calculate merge base
|
||||
const {data} = await github.rest.repos.compareCommits({
|
||||
...context.repo,
|
||||
base: context.payload.pull_request.base.ref,
|
||||
head: context.payload.pull_request.head.sha,
|
||||
});
|
||||
core.setOutput('merge_base', data.merge_base_commit.sha);
|
||||
|
||||
- name: Fetch commits and extract API snapshots
|
||||
if: steps.api_diff.outputs.changed == 'true'
|
||||
shell: bash
|
||||
env:
|
||||
SCRATCH_DIR: ${{ runner.temp }}/diff-js-api-changes
|
||||
MERGE_BASE: ${{ steps.merge_base.outputs.merge_base }}
|
||||
PR_SHA: ${{ github.event.pull_request.head.sha }}
|
||||
run: |
|
||||
mkdir -p $SCRATCH_DIR
|
||||
git show "$MERGE_BASE":packages/react-native/ReactNativeApi.d.ts > $SCRATCH_DIR/ReactNativeApi-before.d.ts \
|
||||
git fetch origin "${{ steps.api_diff.outputs.merge_base }}" --depth=1
|
||||
git fetch origin "${{ github.event.pull_request.head.sha }}" --depth=1
|
||||
git show "${{ steps.api_diff.outputs.merge_base }}":packages/react-native/ReactNativeApi.d.ts > $SCRATCH_DIR/ReactNativeApi-before.d.ts \
|
||||
|| echo "" > $SCRATCH_DIR/ReactNativeApi-before.d.ts
|
||||
git show "$PR_SHA":packages/react-native/ReactNativeApi.d.ts > $SCRATCH_DIR/ReactNativeApi-after.d.ts \
|
||||
git show "${{ github.event.pull_request.head.sha }}":packages/react-native/ReactNativeApi.d.ts > $SCRATCH_DIR/ReactNativeApi-after.d.ts \
|
||||
|| echo "" > $SCRATCH_DIR/ReactNativeApi-after.d.ts
|
||||
|
||||
- name: Run breaking change detection
|
||||
if: steps.api_diff.outputs.changed == 'true'
|
||||
shell: bash
|
||||
env:
|
||||
SCRATCH_DIR: ${{ runner.temp }}/diff-js-api-changes
|
||||
|
||||
Reference in new issue
Block a user