Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(README): note pull_request_target for fork-based flow #24

Merged
merged 3 commits into from
Aug 23, 2020
Merged

docs(README): note pull_request_target for fork-based flow #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce95833
docs(README): note pull_request_target for fork-based flow
mikehardy Aug 21, 2020
c144416
docs(README): incorporate PR feedback
mikehardy Aug 23, 2020
1aa1123
docs(README): remove unintended whitespace
mikehardy Aug 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is helpful when you're using [semantic-release](https://github.com/semantic
```yml
name: "Lint PR"
on:
pull_request:
pull_request_target:
types:
- opened
- edited
Expand All @@ -34,3 +34,5 @@ Note that since PR titles only have a single line, you have to use the `!` synta
See [Conventional Commits](https://www.conventionalcommits.org/) for more examples.

Additionally, the special `[WIP] ` prefix is supported, to indicate that a pull request is work in progress and isn't ready to be merged. In this case the PR title isn't validated and the pull request checks remain pending.

Note the usage of [`pull_request_target`](https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/) in place of `pull_request` as the event trigger is necessary for a fork-based workflow so the API token is valid for status reporting.