Skip to content

Rework triagebot custom messages when assigning a reviewer section #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2025
Merged

Rework triagebot custom messages when assigning a reviewer section #920

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edd47a9
Rework triagebot custom messages when assigning a reviewer section
Urgau Jul 17, 2025
3738d10
Apply suggestions from code review
Urgau Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/triagebot/pr-assignment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,17 +125,21 @@ title = "[beta" # title contains "[beta" in it
branch = "beta"
```

#### Custom welcome messages
#### Custom messages

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.
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.

```toml
[assign.custom_welcome_messages]
welcome-message = "Welcome message, assigning {assignee}!"
welcome-message-no-reviewer = "Welcome message for when no auto-reviewer could be selected!"
[assign.custom_messages]
auto-assign-someone = "Thanks for the contribution, assigning {assignee}!" # only required if auto-assign (`[assign.owners]` is configured
auto-assign-no-one = """
Thanks for the contribution!

Unfortunatly no reviewer could be found.
"""
```

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

## Implementation

Expand Down