From 255d24b0b139368f6aceed0d16ae8b099f114dff Mon Sep 17 00:00:00 2001
From: Urgau <urgau@numericable.fr>
Date: Mon, 7 Apr 2025 18:46:55 +0200
Subject: [PATCH] Add documentation for triagebot `[canonicalize-issue-links]`
 handler

---
 src/SUMMARY.md                            |  1 +
 src/triagebot/canonicalize-issue-links.md | 17 +++++++++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 src/triagebot/canonicalize-issue-links.md

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
index 88493689..13c26d85 100644
--- a/src/SUMMARY.md
+++ b/src/SUMMARY.md
@@ -16,6 +16,7 @@
     - [PR Assignment](./triagebot/pr-assignment.md)
     - [Tracking PR assignment](./triagebot/pr-assignment-tracking.md)
     - [Autolabels](./triagebot/autolabels.md)
+    - [Canonicalize Issue Links](./triagebot/canonicalize-issue-links.md)
     - [Close](./triagebot/close.md)
     - [Documentation Updates](./triagebot/doc-updates.md)
     - [GitHub Releases](./triagebot/github-releases.md)
diff --git a/src/triagebot/canonicalize-issue-links.md b/src/triagebot/canonicalize-issue-links.md
new file mode 100644
index 00000000..13fb182b
--- /dev/null
+++ b/src/triagebot/canonicalize-issue-links.md
@@ -0,0 +1,17 @@
+# Canonicalize Issue Links
+
+GitHub permits having automatic action like `Fixes #123` which closes the issue number `123`, this handler updates the pull-request description with the canonicalized version, `Fixes org/repo#123`.
+
+This is useful when updating subtrees into the upstream repository as it avoids referencing and closing the issue from the upstream repository instead of the one from the subtree.
+
+## Configuration
+
+This feature is enabled on a repository by having a `[canonicalize-issue-links]` table in `triagebot.toml`:
+
+```toml
+[canonicalize-issue-links]
+```
+
+## Implementation
+
+See [`src/handlers/canonicalize_issue_links.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/canonicalize_issue_links.rs).