From 42fd6a151cc57ff187697cb95b92dbabfd4d777a Mon Sep 17 00:00:00 2001 From: Urgau Date: Fri, 12 Dec 2025 22:17:37 +0100 Subject: [PATCH] Remove documentation for triagebot `[no-mentions]` handler --- src/SUMMARY.md | 1 - src/triagebot/no-mentions.md | 25 ------------------------- 2 files changed, 26 deletions(-) delete mode 100644 src/triagebot/no-mentions.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 2778dd29..714d1312 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -33,7 +33,6 @@ - [Mentions](./triagebot/mentions.md) - [Merge Conflicts](./triagebot/merge-conflicts.md) - [No Merge Policy](./triagebot/no-merge.md) - - [No Mentions](./triagebot/no-mentions.md) - [Nominate](./triagebot/nominate.md) - [Note](./triagebot/note.md) - [Notifications](./triagebot/notifications.md) diff --git a/src/triagebot/no-mentions.md b/src/triagebot/no-mentions.md deleted file mode 100644 index adbafc3e..00000000 --- a/src/triagebot/no-mentions.md +++ /dev/null @@ -1,25 +0,0 @@ -# No Mentions (in commits) - -GitHub permits having mentions (eg. `@user`) in commits, and while it's sometimes useful it almost always ends-up spamming the mentioned users, in particular as the commits are being rebased, cherry-picked or pushed. - -This handler tries to prevent those mentions by adding a comment warning in the PR against them. - -## Configuration - -This feature is enabled on a repository by having a `[no-mentions]` table in `triagebot.toml`: - -```toml -[no-mentions] -``` - -Additionally, one can avoid checking certain pull requests with the `exclude-titles` configuration option. - -```toml -[no-mentions] -# It doesn't make sense checking subtree updates, ignore those by matching case-insensitively on the title -exclude-titles = ["subtree update"] -``` - -## Implementation - -See [`src/handlers/check_commits/no_mentions.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/check_commits/no_mentions.rs).