Skip to content

Commit ef73e19

Browse files
authored
add a note on codeowners (#2020)
1 parent 09444ac commit ef73e19

File tree

4 files changed

+23
-0
lines changed

4 files changed

+23
-0
lines changed

docs/ce/howto/codeowners.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Codeowners integration"
3+
---
4+
5+
With Github's CODEOWNERS integration, you can configure pull requests to be reviewed by specific team members, depending on the files changed.
6+
7+
Since digger automatically queries github's API for mergability status of the pull request before apply, no additional changes are needed to make
8+
digger integration with CODEOWNERS. Here is an example CODEOWNERS file:
9+
10+
```
11+
prod @ZIJ # ensure ZIJ is reviewer for any prod changes
12+
```
13+
14+
And to enforce it at the PR level we need to add a branch protection rule to the default branch, ensuring to check CODEOWNERS reviewers
15+
settings > branches > "Require review from Code Owners"
16+
17+
![](/images/howto/codeowners.png)
18+
19+
Once this is in place any PR will not be mergable unless the CODEOWNERS reviewers approve it. As a consequence, digger will block any apply for such a PR:
20+
21+
![](/images/howto/codeowners-2.png)
22+

docs/images/howto/codeowners-2.png

224 KB
Loading

docs/images/howto/codeowners.png

143 KB
Loading

docs/mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
"ce/howto/custom-commands",
8989
"ce/howto/destroy-manual",
9090
"ce/howto/draft-prs",
91+
"ce/howto/codeowners",
9192
"ce/howto/disable-auto-checkout",
9293
"ce/howto/disable-telemetry",
9394
"ce/howto/generate-projects",

0 commit comments

Comments
 (0)