Skip to content

Commit 3f82aef

Browse files
authored
Apply readme suggestion
1 parent 47e6882 commit 3f82aef

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.github/workflows/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,17 @@ Please make sure to include the @dotnet/runtime-infrastructure group as a review
66

77
For workflows that are triggered by pull requests, refer to GitHub's documentation for the `pull_request` and `pull_request_target` events. The `pull_request_target` event is the more common use case in this repository as it runs the workflow in the context of the target branch instead of in the context of the pull request's fork or branch. However, workflows that need to consume the contents of the pull request need to use the `pull_request` event. There are security considerations with each of the events though.
88

9+
Most workflows are intended to run only in the `dotnet/runtime` repository and not in forks. To force workflow jobs to be skipped in forks, each job should apply an `if` statement that checks the repository name or owner. Either approach works, but checking only the repository owner allows the workflow to run in copies or forks withing the dotnet org.
10+
11+
```yaml
12+
jobs:
13+
job-1:
14+
# Do not run this job in forks
15+
if: github.repository == 'dotnet/runtime'
16+
17+
job-2:
18+
# Do not run this job in forks outside the dotnet org
19+
if: github.repository_owner == 'dotnet'
20+
```
21+
922
Refer to GitHub's [Workflows in forked repositories](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflows-in-forked-repositories) and [pull_request_target](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#pull_request_target) documentation for more information.

0 commit comments

Comments
 (0)