From 1fa65ae0070160ed164678df3a7b65840a19ca71 Mon Sep 17 00:00:00 2001 From: Urgau Date: Fri, 15 Aug 2025 18:44:13 +0200 Subject: [PATCH] Add documentation for triagebot new `[range-diff]` handler --- src/SUMMARY.md | 1 + src/triagebot/range-diff.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 src/triagebot/range-diff.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 0fe46e49..522ec391 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -25,6 +25,7 @@ - [Concern](./triagebot/concern.md) - [Documentation Updates](./triagebot/doc-updates.md) - [GitHub Releases](./triagebot/github-releases.md) + - [Git rebase (range) diff](./triagebot/range-diff.md) - [Issue Links](./triagebot/issue-links.md) - [Issue Transfer](./triagebot/transfer.md) - [Labeling](./triagebot/labeling.md) diff --git a/src/triagebot/range-diff.md b/src/triagebot/range-diff.md new file mode 100644 index 00000000..8fa23d94 --- /dev/null +++ b/src/triagebot/range-diff.md @@ -0,0 +1,15 @@ +# Git rebase (range) diff + +GitHub native compare feature shows lots of unrelated changes when a force push changes the base commit of a PR. This handler post a comment after such scenario which links to triagebot `range-diff` feature. + +## Configuration + +This feature is enabled on a repository by having a empty `[range-diff]` table in `triagebot.toml`: + +```toml +[range-diff] +``` + +## Implementation + +See [`src/handlers/check_commits/range_diff.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/check_commits/force_push_range_diff.rs).