Skip to content

Commit 68b4190

Browse files
feat: add docs for ignoreUsers & ignoreCollaborators
1 parent 862e9ea commit 68b4190

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ With this GitHub workflow, you can automate tasks whenever an author creates mul
77
### Use cases
88

99
- The workflow can comment the issues that are already created by the author which are currently in the open state.
10-
- You can also filter the issues that are assigned to you
10+
- You can also filter the issues that are assigned to the author of the issue
1111
- You can add your own comment message (even multiline) in the issue.
1212
- You can add label or labels based on your preferences.
1313
- Optionally, you can also close the issue (previous issues won't be affected), and only the current issue will be closed.
14+
- You can ignore this workflow for specific users by using `ignoreUsers`
15+
- You can directly pass `ignoreCollaborators`
1416

1517
---
1618

@@ -53,6 +55,8 @@ Various inputs are defined to let you configure the action:
5355
| `close` | This will close the issue if set to true | `'false'` |
5456
| `issueNumber` | This will comment all the previous issues that are created by the author | `'true'` |
5557
| `assign` | This will filter the issues that are assigned to the author (works only if `issueNumber` is `true`) | `'false'` |
58+
| `ignoreUsers` | Specify usernames that should be ignored while running this workflow. Use commas to separate if there are multiple users. | `''` |
59+
| `ignoreCollaborators` | This will ignore all the collaborators in the repository while running this workflow | `'false'` |
5660

5761
<br>
5862

@@ -180,6 +184,50 @@ with:
180184

181185
</details>
182186

187+
<br>
188+
189+
<details>
190+
<summary>To ignore specified users while running this workflow</summary>
191+
192+
<br>
193+
194+
- Suppose, we have to ignore this workflow for users with username: `Anmol-Baranwal`, `AnmolB2`.
195+
196+
```yml
197+
uses: Anmol-Baranwal/handle-multiple-issues@v1
198+
with:
199+
issueNumber: true # default is true
200+
ignoreUsers: 'Anmol-Baranwal, AnmolB2'
201+
202+
# Suppose Anmol-Baranwal created an issue. You will receive a log message during the workflow execution.
203+
# Log Message
204+
# User: Anmol-Baranwal is on the ignore list. Ignoring the workflow for this user.
205+
```
206+
207+
</details>
208+
209+
<br>
210+
211+
<details>
212+
<summary>To ignore collaborators of the repository while running this workflow</summary>
213+
214+
<br>
215+
216+
- Suppose, we have to ignore this workflow for users with username: `Anmol-Baranwal`, `AnmolB2`.
217+
218+
```yml
219+
uses: Anmol-Baranwal/handle-multiple-issues@v1
220+
with:
221+
issueNumber: true # default is true
222+
ignoreCollaborators: true
223+
224+
# Suppose Anmol-Baranwal created an issue and is a collaborator. You will receive a log message during the workflow execution.
225+
# Log Message
226+
# User: Anmol-Baranwal is a collaborator. Ignoring the issue for collaborators.
227+
```
228+
229+
</details>
230+
183231
---
184232

185233
### 🤝 How to Contribute?

0 commit comments

Comments
 (0)