Skip to content

Commit 998e2ac

Browse files
Make it clear that this is not suitable for forked PRs (#140)
* Make it clear that this is not suitable for forked PRs * docs: Revise usage note --------- Co-authored-by: Ryan Christian <rchristian@ryanchristian.dev>
1 parent 2ac9936 commit 998e2ac

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ jobs:
2929
- uses: preactjs/compressed-size-action@v2
3030
```
3131
32+
> **Note:** Due to GitHub's permission model, this action cannot safely create comments when it is triggered by a PR from a fork. It will, however, still generate the size comparison and print the comment it would've posted to the stdout of the action, allowing manual checking and you can copy/paste it into a comment if you wish.
33+
3234
### Customizing the Installation
3335
3436
By default, `compressed-size-action` will install dependencies according to which lockfiles are present, if any. However, if you need to run a different installation command, you can pass a custom script to do so. For example, to use `npm ci` with the `--workspace` option:

0 commit comments

Comments
 (0)