README.md in gitlab-triage-1.40.0 vs README.md in gitlab-triage-1.41.0
- old
+ new
@@ -629,11 +629,11 @@
threshold: 15
```
##### Protected condition
-** This condition is only applicable for branches**
+**This condition is only applicable for branches**
Accept a boolean.
If not specified, default to `false` to filter out protected branches.
##### Ruby condition
@@ -690,11 +690,11 @@
can be useful when combined with conditions that return a large number of
resources. For example, if the conditions are satisfied by thousands of issues a
limit can be configured to process only fifty of them to avoid making an
overwhelming number of changes at once.
-Accepts a key and value pair where the key is `most_recent` or `oldest`and the
+Accepts a key and value pair where the key is `most_recent` or `oldest` and the
value is the number of resources to act on. The following table outlines how
each key affects the sorting and order of resources that it limits.
| Name / Key | Sorted by | Order |
| --------- | ---- | ------ |
@@ -838,11 +838,12 @@
- `merged_at`: the resource's merged date (if applicable)
- `state`: the resources's current state: `opened`, `closed`, `merged`
- `author`: the username of the resource's author as `@user1`
- `assignee`: the username of the resource's assignee as `@user1`
- `assignees`: the usernames of the resource's assignees as `@user1, @user2`
-- `closed_by`: the user that closed the resource as `@user1` (if applicable)
+- `reviewers`: the usernames ot the resource's reviewers as `@user1, @user2` (if applicable)
+- `closed_by`: the user that closed the resource as `@user1` (if applicable)
- `merged_by`: the user that merged the resource as `@user1` (if applicable)
- `milestone`: the resource's current milestone
- `labels`: the resource's labels as `~label1, ~label2`
- `upvotes`: the resources's upvotes count
- `downvotes`: the resources's downvotes count
@@ -904,10 +905,26 @@
comment_type: thread
comment: |
{{author}} Are you still interested in finishing this merge request?
```
+###### Comment internal action option
+
+Determines whether the note is added as an internal comment to the resource.
+
+If the option is set to `false` or not set, the comment will not be internal. \
+When it is set to `true`, the comment will be internal.
+
+Example:
+
+```yml
+actions:
+ comment_internal: true
+ comment: |
+ This issue has breached SLA, please take a look @team!
+```
+
###### Harnessing Quick Actions
[GitLab's quick actions feature](https://docs.gitlab.com/ce/user/project/quick_actions.html) is available in Core.
All of the operations supported by executing a quick action can be carried out via the comment action.
@@ -1017,26 +1034,29 @@
/label ~"needs attention"
```
Which could generate an issue like:
-* Title:
- ```
- Issues require labels
- ```
-* Description:
- ``` markdown
- The following issues require labels:
+Title:
- - [ ] [An example issue](http://example.com/group/project/issues/1) ~"label A", ~"label B"
- - [ ] [Another issue](http://example.com/group/project/issues/2) ~"label B", ~"label C"
+```
+Issues require labels
+```
- Please take care of them before the end of 2000-01-01
+Description:
- /label ~"needs attention"
- ```
+```markdown
+The following issues require labels:
+- [ ] [An example issue](http://example.com/group/project/issues/1) ~"label A", ~"label B"
+- [ ] [Another issue](http://example.com/group/project/issues/2) ~"label B", ~"label C"
+
+Please take care of them before the end of 2000-01-01
+
+/label ~"needs attention"
+```
+
##### Comment on summary action
Generates one comment for each resource, attaching these comments to the summary
created by the [`summarize` action](#summarize-action).
@@ -1206,33 +1226,36 @@
/label ~"needs attention"
```
Which could generate an issue like:
-* Title:
- ```
- Newest and oldest issues summary
- ```
-* Description:
- ``` markdown
- Please triage the following issues:
+Title:
- Please triage the following new issues:
+```
+Newest and oldest issues summary
+```
- - [ ] [A new issue](http://example.com/group/project/issues/4)
- - [ ] [Another new issue](http://example.com/group/project/issues/3) ~"label B", ~"label C"
+Description:
- Please triage the following old issues:
+```markdown
+Please triage the following issues:
- - [ ] [An old issue](http://example.com/group/project/issues/1) ~"label A", ~"label B"
- - [ ] [Another old issue](http://example.com/group/project/issues/2) ~"label C"
+Please triage the following new issues:
- Please take care of them before the end of 2000-01-01
+- [ ] [A new issue](http://example.com/group/project/issues/4)
+- [ ] [Another new issue](http://example.com/group/project/issues/3) ~"label B", ~"label C"
- /label ~"needs attention"
- ```
+Please triage the following old issues:
+- [ ] [An old issue](http://example.com/group/project/issues/1) ~"label A", ~"label B"
+- [ ] [Another old issue](http://example.com/group/project/issues/2) ~"label C"
+
+Please take care of them before the end of 2000-01-01
+
+/label ~"needs attention"
+```
+
> **Note:** If a specific policy doesn't yield any resources, it will not
> generate the corresponding description. If all policies yield no resources,
> then no issues will be created.
### Ruby expression API
@@ -1274,9 +1297,10 @@
##### Methods for `MergeRequest` (merge request context)
| Method | Return type | Description |
| ---- | ---- | ---- |
| first_contribution? | Boolean | `true` if it's the author's first contribution to the project; `false` otherwise. This API requires an additional API request for the merge request, thus would be slower. |
+| closes_issues | [Issue] | The list of issues that would be closed by merging the provided merge request |
##### Methods for `Milestone`
| Method | Return type | Description |
| ---- | ---- | ---- |