You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-2
Original file line number
Diff line number
Diff line change
@@ -15,14 +15,17 @@
15
15
16
16
## Usage
17
17
1.[Install the app](https://github.com/apps/auto-assign).
18
-
2. Create `.github/auto_assign.yml` in your repository.
18
+
2. Create `.github/auto_assign.yml` in your repository with the following.
19
+
20
+
### Single Reviewers List
21
+
Add reviewers/assignees to the pull request based on single reviewers list.
19
22
20
23
```yaml
21
24
# Set to true to add reviewers to pull requests
22
25
addReviewers: true
23
26
24
27
# Set to true to add assignees to pull requests
25
-
addAssignees: true
28
+
addAssignees: false
26
29
27
30
# A list of reviewers to be added to pull requests (GitHub user name)
28
31
reviewers:
@@ -43,6 +46,32 @@ numberOfReviewers: 0
43
46
# Uses numberOfReviewers if unset.
44
47
# numberOfAssignees: 2
45
48
49
+
# A list of keywords to be skipped the process that add reviewers if pull requests include it
50
+
# skipKeywords:
51
+
# - wip
52
+
```
53
+
54
+
### Multiple Reviewers List
55
+
Add reviewers/assignees to the pull request based on multiple reviewers list.
56
+
57
+
If you and peers work at the separate office or they work at the separate team by roles like frontend and backend, you might be good to use adding reviewers from each group.
58
+
59
+
```yaml
60
+
# Set to true to add reviewers to pull requests
61
+
addReviewers: true
62
+
63
+
# Set to true to add assignees to pull requests
64
+
addAssignees: false
65
+
66
+
# A number of reviewers added to the pull request
67
+
# Set 0 to add all the reviewers (default: 0)
68
+
numberOfReviewers: 1
69
+
70
+
# A number of assignees to add to the pull request
71
+
# Set to 0 to add all of the assignees.
72
+
# Uses numberOfReviewers if unset.
73
+
# numberOfAssignees: 2
74
+
46
75
# Set to true to add reviewers from different groups to pull requests
47
76
useReviewGroups: true
48
77
@@ -76,6 +105,13 @@ useAssigneeGroups: false
76
105
# - wip
77
106
```
78
107
108
+
## Advantage
109
+
110
+
### Use Auto Assign in combination with code owners
111
+
If you want to add the same reviewers every time the pull request is opened, you can use code owners. Also, if you want to add randomly reviewers, you can use this app together.
0 commit comments