Skip to content

Commit 746a3a5

Browse files
committed
Release v1.2.1
1 parent 0eba530 commit 746a3a5

File tree

6 files changed

+644
-400
lines changed

6 files changed

+644
-400
lines changed

.github/workflows/pull-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ jobs:
55
add-reviews:
66
runs-on: ubuntu-latest
77
steps:
8-
- uses: kentaro-m/auto-assign-action@v1.2.0
8+
- uses: kentaro-m/auto-assign-action@v1.2.1

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Auto Assign Action
2+
23
An action which adds reviewers to the pull request when the pull request is opened.
34

45
## :arrow_forward: Usage
6+
57
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.
68

79
```yml
@@ -14,14 +16,15 @@ jobs:
1416
add-reviews:
1517
runs-on: ubuntu-latest
1618
steps:
17-
- uses: kentaro-m/auto-assign-action@v1.2.0
19+
- uses: kentaro-m/auto-assign-action@v1.2.1
1820
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
2022
```
2123
2224
Create a separate configuration file for the auto-assign action (e.g. `.github/auto_assign.yml`).
2325

2426
### Single Reviewers List
27+
2528
Add reviewers/assignees to the pull request based on single reviewers list.
2629

2730
```yaml
@@ -40,7 +43,6 @@ reviewers:
4043
# A number of reviewers added to the pull request
4144
# Set 0 to add all the reviewers (default: 0)
4245
numberOfReviewers: 0
43-
4446
# A list of assignees, overrides reviewers if set
4547
# assignees:
4648
# - assigneeA
@@ -56,6 +58,7 @@ numberOfReviewers: 0
5658
```
5759

5860
### Multiple Reviewers List
61+
5962
Add reviewers/assignees to the pull request based on multiple reviewers list.
6063

6164
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:
9295
9396
# Set to true to add assignees from different groups to pull requests
9497
useAssigneeGroups: false
95-
9698
# A list of assignees, split into different froups, to be added to pull requests (GitHub user name)
9799
# assigneeGroups:
98100
# groupA:
@@ -110,6 +112,7 @@ useAssigneeGroups: false
110112
```
111113

112114
### Assign Author as Assignee
115+
113116
Add the PR creator as the assignee of the pull request.
114117

115118
```yaml
@@ -118,6 +121,7 @@ addAssignees: author
118121
```
119122

120123
### Filter by label
124+
121125
The action will only run if the PR meets the specified filters
122126

123127
```yaml
@@ -129,8 +133,8 @@ filterLabels:
129133
# Not run
130134
exclude:
131135
- wip
132-
133136
```
134137

135138
## :memo: Licence
139+
136140
MIT

0 commit comments

Comments
 (0)