Skip to content

Commit 41237d7

Browse files
committed
Document autolabel and notify_zulip triagebot commmands
1 parent b113605 commit 41237d7

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

src/platforms/zulip/triagebot.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ To enable triagebot on a particular repository (currently only in the rust-lang
99
- [Ping a team](#ping-a-team)
1010
- [Glacier](#glacier)
1111
- [Triage](#triage)
12-
- [Applying labels to issues](#applying-labels-to-issues)
13-
- [Requesting prioritization](#requesting-prioritization)
12+
- [Apply labels to issues](#apply-labels-to-issues)
13+
- [Request prioritization](#request-prioritization)
14+
- [Autolabel an issue](#autolabel-an-issue)
15+
- [Notify Zulip](#notify-zulip)
1416
- [Major Changes](#major-changes)
1517

1618
## Issue assignment
@@ -137,7 +139,7 @@ medium = "P-medium"
137139
low = "P-low"
138140
```
139141

140-
## Applying labels to issues
142+
## Apply labels to issues
141143

142144
This command lets anyone apply labels to issues. This is most useful when opening an issue. In general, labels get applied to issues by the Triage WG. If you are interested in helping triaging issues, see the [Triage WG procedure](../../release/triage-procedure.md).
143145

@@ -175,7 +177,7 @@ allow-unauthenticated = [
175177
]
176178
```
177179

178-
## Requesting prioritization
180+
## Request prioritization
179181

180182
Users can request an issue to be prioritized by the Prioritization WG.
181183

@@ -196,6 +198,38 @@ The command fails if the issue has already been requested for prioritization (i.
196198
label = "I-prioritize"
197199
```
198200

201+
## Autolabel an issue
202+
203+
When certain labels are added to an issue, this command will trigger adding a set of additional prioritization labels to the issue. In the following example adding the "I-prioritize" label will automatically add the labels in `trigger_labels` but only if the issue is not already labeled with those in `exclude_labels` (this is to avoid applying unrelated labels to issues).
204+
205+
```toml
206+
[autolabel."I-prioritize"]
207+
trigger_labels = [
208+
"regression-from-stable-to-stable",
209+
"regression-from-stable-to-beta",
210+
"regression-from-stable-to-nightly"
211+
]
212+
exclude_labels = [
213+
"P-*",
214+
"T-infra",
215+
"T-release"
216+
]
217+
```
218+
219+
## Notify Zulip
220+
221+
When a prioritization label is added to an issue, this command will create a new topic on Zulip, in the designated stream:
222+
223+
```toml
224+
[notify-zulip."I-prioritize"]
225+
zulip_stream = 245100 # t-compiler/wg-prioritization/alerts
226+
topic = "I-prioritize #{number} {title}"
227+
message_on_add = "@**WG-prioritization** issue #{number} has been requested for prioritization."
228+
message_on_remove = "Issue #{number}'s prioritization request has been removed."
229+
```
230+
231+
The subscribers of that Zulip stream will receive a notification and can discuss the prioritization of the issue.
232+
199233
## Major Changes
200234

201235
A major change is an issue that will have a big impact on users. See [this page on the MCP process](../../compiler/mcp.md) for detailed explanations.

0 commit comments

Comments
 (0)