Repository navigation
Bug: CI Workflow 'Bundles - size-limit' runs onmain branch, not PR #6852
Description
When opening a pull request, a job titled 'Bundles - size-limit' will be executed to calculate the size increase of packages added via the package manager. I believe this is too see any changes to the compiled size introduced via a PR, yet due the nature of pull_request_target by default using the context of the base ref of the PR, it compares main with main.
Lexical version: N/A
Steps To Reproduce
- Open a Pull Request from any branch
- Let the 'Bundles - size-limit' workflow run
- View the
actions/checkout@v4step to check therefdebug log to see its set torefs/head/main
Link to code example:
- Action run of a random PR, showing main as the ref
- PR that edits
package.json, yet size-limit comment shows no size increase
The current behavior
'Bundles - size-limit' checkouts the base of the PR (most of the time main) and compares the built size with main
The expected behavior
'Bundles - size-limit' checkouts the head of the PR and compares the built size with main
Impact of fix
This happens on every pull request. Fixing involves 2 possible solutions:
- Add the
github.pull_request.head_refasreffor the checkout action
- NOTE: This solutions means
npm install&npm run buildis executed on untrusted code when a PR is raised.
- Change to
pull_requestevent trigger, but this workflow will now require approval
Activity
etrepum commentedon Nov 22, 2024
Do you have an example where the size is expected to change but did not? The example in 2 is not a good one, cross-spawn is a build time dependency, and would not have any effect whatsoever on bundle size.
bthuilot commentedon Nov 23, 2024
@etrepum I checkout a random commit from a few months (
1f778da76afbd991121712c0f2f9cf6087ecc8d9) and then pushed to a new branchci/test-size-limit. Running the size check on my local i get the following results:[ { "name": "lexical - cjs", "size": 30087, "loading": 0.58763671875 }, { "name": "lexical - esm", "size": 29924, "loading": 0.584453125 }, { "name": "@lexical/rich-text - cjs", "size": 38783, "loading": 0.75748046875 }, { "name": "@lexical/rich-text - esm", "size": 31822, "loading": 0.6215234375 }, { "name": "@lexical/plain-text - cjs", "size": 37325, "loading": 0.72900390625 }, { "name": "@lexical/plain-text - esm", "size": 29125, "loading": 0.56884765625 }, { "name": "@lexical/react - cjs", "size": 40590, "loading": 0.7927734375 }, { "name": "@lexical/react - esm", "size": 33304, "loading": 0.65046875 } ]However, when opening a PR you can see the results are all 0%
#6862 (comment)