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
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
1
# Auto Assign Action
2
+
2
3
An action which adds reviewers to the pull request when the pull request is opened.
3
4
4
5
## :arrow_forward: Usage
6
+
5
7
Create a workflow (e.g. `.github/workflows/action.yml` For more detail, refer to [Configuring a workflow](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) for running the auto-assign action.
6
8
7
9
```yml
@@ -14,14 +16,15 @@ jobs:
14
16
add-reviews:
15
17
runs-on: ubuntu-latest
16
18
steps:
17
-
- uses: kentaro-m/auto-assign-action@v1.2.0
19
+
- uses: kentaro-m/auto-assign-action@v1.2.1
18
20
with:
19
-
configuration-path: ".github/some_name_for_configs.yml"# Only needed if you use something other than .github/auto_assign.yml
21
+
configuration-path: '.github/some_name_for_configs.yml'# Only needed if you use something other than .github/auto_assign.yml
20
22
```
21
23
22
24
Create a separate configuration file for the auto-assign action (e.g. `.github/auto_assign.yml`).
23
25
24
26
### Single Reviewers List
27
+
25
28
Add reviewers/assignees to the pull request based on single reviewers list.
26
29
27
30
```yaml
@@ -40,7 +43,6 @@ reviewers:
40
43
# A number of reviewers added to the pull request
41
44
# Set 0 to add all the reviewers (default: 0)
42
45
numberOfReviewers: 0
43
-
44
46
# A list of assignees, overrides reviewers if set
45
47
# assignees:
46
48
# - assigneeA
@@ -56,6 +58,7 @@ numberOfReviewers: 0
56
58
```
57
59
58
60
### Multiple Reviewers List
61
+
59
62
Add reviewers/assignees to the pull request based on multiple reviewers list.
60
63
61
64
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.
@@ -92,7 +95,6 @@ reviewGroups:
92
95
93
96
# Set to true to add assignees from different groups to pull requests
94
97
useAssigneeGroups: false
95
-
96
98
# A list of assignees, split into different froups, to be added to pull requests (GitHub user name)
97
99
# assigneeGroups:
98
100
# groupA:
@@ -110,6 +112,7 @@ useAssigneeGroups: false
110
112
```
111
113
112
114
### Assign Author as Assignee
115
+
113
116
Add the PR creator as the assignee of the pull request.
114
117
115
118
```yaml
@@ -118,6 +121,7 @@ addAssignees: author
118
121
```
119
122
120
123
### Filter by label
124
+
121
125
The action will only run if the PR meets the specified filters
0 commit comments