README.md in gitlab-triage-1.16.0 vs README.md in gitlab-triage-1.17.0
- old
+ new
@@ -36,22 +36,42 @@
> **Note:** You can use the [`--init`](#usage) option to add an example
[`.triage-policies.yml` file](support/.triage-policies.example.yml) to your
project.
Select which resource to add the policy to:
+- `epics`
- `issues`
- `merge_requests`
And create an array of `rules` to define your policies:
For example:
```yml
resource_rules:
+ epics:
+ rules:
+ - name: My epic policy
+ conditions:
+ date:
+ attribute: updated_at
+ condition: older_than
+ interval_type: days
+ interval: 5
+ state: opened
+ labels:
+ - None
+ actions:
+ labels:
+ - needs attention
+ mention:
+ - markglenfletcher
+ comment: |
+ {{author}} This epic is unlabelled after 5 days. It needs attention. Please take care of this before the end of #{2.days.from_now.strftime('%Y-%m-%d')}
issues:
rules:
- - name: My policy
+ - name: My issue policy
conditions:
date:
attribute: updated_at
condition: older_than
interval_type: days
@@ -84,11 +104,11 @@
Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
/label ~"needs attention"
merge_requests:
rules:
- - name: My policy
+ - name: My merge request policy
conditions:
state: opened
labels:
- None
limits:
@@ -795,12 +815,12 @@
Accepts a hash of fields.
| Field | Type | Description | Required | Placeholders | Ruby expression | Default |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
-| `title` | string | The title of the generated issue | yes | yes | no | |
-| `destination` | integer or string | The project ID or path to create the generated issue in | no | no | no | source project |
+| `title` | string | The title of the generated issue | yes | yes | yes | |
+| `destination` | integer or string | The project ID or path to create the generated issue in | no | no | no | source project |
| `item` | string | Template representing each triaged resource | no | yes | yes | |
| `summary` | string | The description of the generated issue | no | Only `{{title}}`, `{{items}}`, `{{type}}` | yes | |
| `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
The following placeholders are supported for `summary`:
@@ -899,10 +919,10 @@
most_recent: 15
actions:
comment_type: thread
comment_on_summary: |
# {{title}}
-
+
author: {{author}}
summarize:
title: |
#{resource[:type].capitalize} require labels
item: |