Skip to content

Commit 98d6415

Browse files
[8.0] Backport labeling workflow changes (#112241)
* Change some workflows using `pull_request` to use `pull_request_target` instead (#112161) * Change workflows to use pull_request_target instead of pull_request event * Add CODEOWNERS entry * Add initial readme * Add repo-specific condition to labeling workflows (#112169) * Condition labeling workflows to only run on dotnet/runtime. * Improve readme * Add jeffhandley as explicit workflow owner Co-authored-by: Jeff Handley <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Jeff Handley <[email protected]>
1 parent 4e2e722 commit 98d6415

File tree

4 files changed

+29
-4
lines changed

4 files changed

+29
-4
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,4 @@
101101
/docs/area-owners.* @jeffhandley
102102
/docs/issue*.md @jeffhandley
103103
/.github/fabricbot.json @jeffhandley
104+
/.github/workflows/ @jeffhandley @dotnet/runtime-infrastructure

.github/workflows/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Workflows
2+
3+
General guidance:
4+
5+
Please make sure to include the @dotnet/runtime-infrastructure group as a reviewer of your PRs.
6+
7+
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.
8+
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+
22+
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.

.github/workflows/check-no-merge-label.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ permissions:
44
pull-requests: read
55

66
on:
7-
pull_request:
8-
types: [opened, edited, reopened, labeled, unlabeled, synchronize]
7+
pull_request_target:
8+
types: [opened, reopened, labeled, unlabeled]
99
branches:
1010
- 'main'
1111
- 'release/**'
1212

1313
jobs:
1414
check-labels:
15+
if: github.repository == 'dotnet/runtime'
1516
runs-on: ubuntu-latest
1617
steps:
1718
- name: Check 'NO-MERGE' label

.github/workflows/check-service-labels.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ permissions:
44
pull-requests: read
55

66
on:
7-
pull_request:
8-
types: [opened, edited, reopened, labeled, unlabeled, synchronize]
7+
pull_request_target:
8+
types: [opened, reopened, labeled, unlabeled]
99
branches:
1010
- 'release/**'
1111

1212
jobs:
1313
check-labels:
14+
if: github.repository == 'dotnet/runtime'
1415
runs-on: ubuntu-latest
1516
steps:
1617
- name: Check 'Servicing-approved' label

0 commit comments

Comments
 (0)