Skip to content

Commit 8880cff

Browse files
committed
Rename triagebot canonicalize-issue-links to issue-links
1 parent 3397285 commit 8880cff

File tree

3 files changed

+25
-15
lines changed

3 files changed

+25
-15
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [Documentation Updates](./triagebot/doc-updates.md)
2222
- [GitHub Releases](./triagebot/github-releases.md)
2323
- [Glacier](./triagebot/glacier.md)
24+
- [Issue Links](./triagebot/issue-links.md)
2425
- [Issue Transfer](./triagebot/transfer.md)
2526
- [Labeling](./triagebot/labeling.md)
2627
- [Major Changes](./triagebot/major-changes.md)
Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
# Canonicalize Issue Links
22

3-
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`.
4-
5-
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.
6-
7-
## Configuration
8-
9-
This feature is enabled on a repository by having a `[canonicalize-issue-links]` table in `triagebot.toml`:
10-
11-
```toml
12-
[canonicalize-issue-links]
13-
```
14-
15-
## Implementation
16-
17-
See [`src/handlers/canonicalize_issue_links.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/canonicalize_issue_links.rs).
3+
This handler was renamed to `[issue-links]` see [Issue Links](issue-links.md).

src/triagebot/issue-links.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Issue Links
2+
3+
## Canonicalise Issue Links
4+
5+
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`.
6+
7+
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.
8+
9+
## Issue Links in Commits
10+
11+
GitHub also permits having having issue links in commits which are then referenced in the issue. While useful, they often more than anything else spam the referenced issue. This handler puts a warning against them.
12+
13+
## Configuration
14+
15+
This feature is enabled on a repository by having a `[issue-links]` table in `triagebot.toml`:
16+
17+
```toml
18+
[issue-links]
19+
```
20+
21+
## Implementation
22+
23+
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)