Skip to content

Commit 76c7ad9

Browse files
committed
Update section how to use
1 parent 13949b7 commit 76c7ad9

File tree

3 files changed

+57
-21
lines changed

3 files changed

+57
-21
lines changed

.github/auto_assign.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ reviewers:
1010

1111
# A number of reviewers added to the pull request
1212
# Set 0 to add all the reviewers (default: 0)
13-
numberOfReviewers: 3
13+
numberOfReviewers: 0
1414

1515
# A list of assignees, overrides reviewers if set
1616
# assignees:
1717
# - assigneeA
1818

1919
# Set to true to add reviewers from different groups to pull requests
20-
useReviewGroups: true
20+
# useReviewGroups: true
2121

2222
# A list of reviewers, split into different groups, to be added to pull requests (GitHub user name)
23-
reviewGroups:
24-
groupA:
25-
- user1
26-
groupB:
27-
- user2
23+
# reviewGroups:
24+
# groupA:
25+
# - user1
26+
# groupB:
27+
# - user2

.github/auto_assign_example.yml

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
addReviewers: true
33

44
# Set to true to add assignees to pull requests
5-
addAssignees: true
5+
addAssignees: false
66

77
# A list of reviewers to be added to pull requests (GitHub user name) (required)
88
reviewers:
@@ -24,21 +24,21 @@ numberOfReviewers: 0
2424
# numberOfAssignees: 2
2525

2626
# Set to true to add reviewers from different groups to pull requests
27-
useReviewGroups: true
27+
# useReviewGroups: true
2828

2929
# A list of reviewers, split into different groups, to be added to pull requests (GitHub user name)
30-
reviewGroups:
31-
groupA:
32-
- reviewerA
33-
- reviewerB
34-
- reviewerC
35-
groupB:
36-
- reviewerD
37-
- reviewerE
38-
- reviewerF
30+
# reviewGroups:
31+
# groupA:
32+
# - reviewerA
33+
# - reviewerB
34+
# - reviewerC
35+
# groupB:
36+
# - reviewerD
37+
# - reviewerE
38+
# - reviewerF
3939

4040
# Set to true to add assignees from different groups to pull requests
41-
useAssigneeGroups: false
41+
# useAssigneeGroups: false
4242

4343
# A list of assignees, split into different froups, to be added to pull requests (GitHub user name)
4444
# assigneeGroups:

README.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@
1515

1616
## Usage
1717
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.
1922

2023
```yaml
2124
# Set to true to add reviewers to pull requests
2225
addReviewers: true
2326

2427
# Set to true to add assignees to pull requests
25-
addAssignees: true
28+
addAssignees: false
2629

2730
# A list of reviewers to be added to pull requests (GitHub user name)
2831
reviewers:
@@ -43,6 +46,32 @@ numberOfReviewers: 0
4346
# Uses numberOfReviewers if unset.
4447
# numberOfAssignees: 2
4548

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+
4675
# Set to true to add reviewers from different groups to pull requests
4776
useReviewGroups: true
4877

@@ -76,6 +105,13 @@ useAssigneeGroups: false
76105
# - wip
77106
```
78107

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.
112+
113+
[About code owners - GitHub Help](https://help.github.com/en/articles/about-code-owners)
114+
79115
## Development
80116

81117
```sh

0 commit comments

Comments
 (0)