diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c99c8f6e988a5f..d7ecccb46ca92b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -101,4 +101,4 @@ /docs/area-owners.* @jeffhandley /docs/issue*.md @jeffhandley /.github/fabricbot.json @jeffhandley -/.github/workflows/ @dotnet/runtime-infrastructure +/.github/workflows/ @jeffhandley @dotnet/runtime-infrastructure diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 308cb2d1a85b6b..f5e7799b30e2a2 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -2,5 +2,21 @@ General guidance: -- Please make sure to include the @dotnet/runtime-infrastructure group as a reviewer of your PRs. -- Do not use the `pull_request` event. Use `pull_request_target` instead, as documented in [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). +Please make sure to include the @dotnet/runtime-infrastructure group as a reviewer of your PRs. + +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. + +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. + +```yaml +jobs: + job-1: + # Do not run this job in forks + if: github.repository == 'dotnet/runtime' + + job-2: + # Do not run this job in forks outside the dotnet org + if: github.repository_owner == 'dotnet' +``` + +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. diff --git a/.github/workflows/check-no-merge-label.yml b/.github/workflows/check-no-merge-label.yml index 37cc7adf20596b..55154410c2c09d 100644 --- a/.github/workflows/check-no-merge-label.yml +++ b/.github/workflows/check-no-merge-label.yml @@ -12,6 +12,7 @@ on: jobs: check-labels: + if: github.repository == 'dotnet/runtime' runs-on: ubuntu-latest steps: - name: Check 'NO-MERGE' label diff --git a/.github/workflows/check-service-labels.yml b/.github/workflows/check-service-labels.yml index b0061cbdca21c0..9507f999c8e788 100644 --- a/.github/workflows/check-service-labels.yml +++ b/.github/workflows/check-service-labels.yml @@ -11,6 +11,7 @@ on: jobs: check-labels: + if: github.repository == 'dotnet/runtime' runs-on: ubuntu-latest steps: - name: Check 'Servicing-approved' label