Skip to content

Commit 5e44ac3

Browse files
authored
Merge pull request #920 from Urgau/assign-custom-messages
Rework triagebot custom messages when assigning a reviewer section
2 parents 26500b6 + 3738d10 commit 5e44ac3

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/triagebot/pr-assignment.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,21 @@ title = "[beta" # title contains "[beta" in it
125125
branch = "beta"
126126
```
127127

128-
#### Custom welcome messages
128+
#### Custom messages
129129

130-
Some repositories may want to use custom welcome messages instead of the preconfigured ones. It is possible to customize the welcome message shown when an "auto reviewer" is found by triagebot and the one shown when no reviewer is found. If provided, the `contributing_url` will still be used.
130+
Some repositories may want to use custom messages instead of the preconfigured ones. It is possible to customize the message shown when auto-assigning (or not) a reviewer. If provided, the `contributing_url` will still be used.
131131

132132
```toml
133-
[assign.custom_welcome_messages]
134-
welcome-message = "Welcome message, assigning {assignee}!"
135-
welcome-message-no-reviewer = "Welcome message for when no auto-reviewer could be selected!"
133+
[assign.custom_messages]
134+
auto-assign-someone = "Thanks for the contribution, assigning {assignee}!" # only required if auto-assign (`[assign.owners]` is configured
135+
auto-assign-no-one = """
136+
Thanks for the contribution!
137+
138+
Unfortunately, no reviewer could be found at the moment.
139+
"""
136140
```
137141

138-
If `[assign.custom_welcome_messages]` is present, both custom messages must be provided.
142+
The messages content are given as-is to GitHub (modulo `{assignee}`), the content can therefore use whatever GitHub supports.
139143

140144
## Implementation
141145

0 commit comments

Comments
 (0)