Skip to content

Commit

Permalink
Update preview example of the action
Browse files Browse the repository at this point in the history
- Use `branches` on `pull_request_target`
- Mention limitations of the preview action

See: https://progress.opensuse.org/issues/158236
  • Loading branch information
Liv Dywan authored and Liv Dywan committed Apr 30, 2024
1 parent 27fcb74 commit d7fa406
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ jobs:
```yaml
concurrency: preview-${{ github.ref }}
on:
pull_request:
pull_request_target:
types:
- opened
- reopened
- synchronize
- closed
branches:
- "**"
permissions:
contents: write
pull-requests: write
Expand All @@ -74,6 +76,12 @@ jobs:
- uses: rossjrw/pr-preview-action@v1
```
> [!NOTE]
> [rossjrw/pr-preview-action](https://github.com/rossjrw/pr-preview-action)
> doesn't support forked repositories.
> Note the use of `pull_request_target` and `branches` as a
> work-around with the caveat that previews only show HTML changes.

## License

This project is licensed under the MIT license, see LICENSE file for details.

0 comments on commit d7fa406

Please sign in to comment.