Skip to content

Commit d11e463

Browse files
committed
📝 Update README
1 parent 09642ce commit d11e463

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,19 @@ In this case, the GitHub action will only close the issue if:
159159
* it was written by a user in the `users` list in the `config` (or the owner of the repo)
160160
* the time delay since the last comment is enough
161161

162-
### Remove label
162+
### Remove label on comment
163163

164-
You can also pass a config `remove_label` per keyword. By default it's `true`.
164+
You can also pass a config `remove_label_on_comment` per keyword. By default it's `true`.
165165

166166
When someone adds a comment _after_ the label was added, then this GitHub action won't close the issue.
167167

168-
On top of not closing the issue, by default, it will remove the label. You can disable removing the label by setting `remove_label` to `false`.
168+
On top of not closing the issue, by default, it will remove the label. You can disable removing the label by setting `remove_label_on_comment` to `false`.
169+
170+
### Remove label on close
171+
172+
After this GitHub action closes an issue it can also automatically remove the label from the issue when you pass the config `remove_label_on_close` set to `true`.
173+
174+
By default it is false, and doesn't remove the label from the issue.
169175

170176
### Defaults
171177

@@ -179,7 +185,8 @@ By default, any config has:
179185
Assuming the original issue was solved, it will be automatically closed now.
180186
```
181187

182-
* `remove_label`: True. If someone adds a comment after you added the label, it will remove the label from the issue.
188+
* `remove_label_on_comment`: True. If someone adds a comment after you added the label, it will remove the label from the issue.
189+
* `remove_label_on_close`: False. After this GitHub action closes the issue it would also remove the label from the issue.
183190

184191
### Config in the action
185192

@@ -284,7 +291,8 @@ jobs:
284291
],
285292
"delay": "P3DT12H30M5S",
286293
"message": "It seems the issue was answered, closing this now.",
287-
"remove_label": false
294+
"remove_label_on_comment": false,
295+
"remove_label_on_close": false
288296
},
289297
"validated": {
290298
"users": [
@@ -293,7 +301,8 @@ jobs:
293301
],
294302
"delay": 300,
295303
"message": "The issue could not be validated after 5 minutes. Closing now.",
296-
"remove_label": true
304+
"remove_label_on_comment": true,
305+
"remove_label_on_close": false
297306
},
298307
"waiting": {
299308
"users": [
@@ -302,7 +311,8 @@ jobs:
302311
],
303312
"delay": 691200,
304313
"message": "Closing after 8 days of waiting for the additional info requested.",
305-
"remove_label": true
314+
"remove_label_on_comment": true,
315+
"remove_label_on_close": true
306316
}
307317
}
308318
```

0 commit comments

Comments
 (0)