Skip to content

Commit a91f314

Browse files
committed
Add documentation for triagebot check-commits = "uncanonicalized"
1 parent 05d4cde commit a91f314

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/triagebot/issue-links.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,23 @@ This feature is enabled on a repository by having a `[issue-links]` table in `tr
2121

2222
### Without commits checking
2323

24+
Some repositories may not need, or may prefer not, to warn about issue links in commit messages. This behavior can be disabled with the `check-commits` configuration option:
25+
2426
```toml
2527
[issue-links]
2628
check-commits = false # defaults to true
2729
```
2830

31+
#### Only check uncanonicalized issue links
32+
33+
For subtrees (or embedded repositories), it is recommended to still check for *uncanonicalized* issue links (e.g. `#132` instead of `rust-lang/cargo#123`).
34+
This prevents links from resolving to the wrong repository when the subtree is merged upstream while still allowing issue links in commits.
35+
36+
```toml
37+
[issue-links]
38+
check-commits = "uncanonicalized" # for subtrees
39+
```
40+
2941
## Implementation
3042

3143
See [`src/handlers/issue_links.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/issue_links.rs) and [`src/handlers/check_commits/issue_links.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/check_commits/issue_links.rs).

0 commit comments

Comments
 (0)