Skip to content

Commit 069817c

Browse files
docs: Link to GitHub Actions docs (#298)
* docs: link to GitHub Actions docs * fix suggestion * Apply suggestions from code review --------- Co-authored-by: Jan Amann <jan@amann.work>
1 parent e49f57c commit 069817c

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ on:
2929
pull_request_target:
3030
types:
3131
- opened
32-
- edited
3332
- reopened
33+
- edited
34+
# - synchronize (if you use required Actions)
3435

3536
jobs:
3637
main:
@@ -169,6 +170,10 @@ There are two events that can be used as triggers for this action, each with dif
169170
1. [`pull_request_target`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target): This allows the action to be used in a fork-based workflow, where e.g. you want to accept pull requests in a public repository. In this case, the configuration from the main branch of your repository will be used for the check. This means that you need to have this configuration in the main branch for the action to run at all (e.g. it won't run within a PR that adds the action initially). Also if you change the configuration in a PR, the changes will not be reflected for the current PR – only subsequent ones after the changes are in the main branch.
170171
2. [`pull_request`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request): This configuration uses the latest configuration that is available in the current branch. It will only work if the branch is based in the repository itself. If this configuration is used and a pull request from a fork is opened, you'll encounter an error as the GitHub token environment parameter is not available. This option is viable if all contributors have write access to the repository.
171172

173+
> [!TIP]
174+
> If the workflow is required for merging, you need to ensure that the you add a trigger type for [`synchronize`](https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=synchronize#pull_request).
175+
> This will ensure that the check is ran on each new push as required workflows need to run on the lastest change.
176+
172177
## Outputs
173178

174179
- The outputs `type`, `scope` and `subject` are populated, except for if the `wip` option is used.

0 commit comments

Comments
 (0)