Skip to content

Commit 2e844b1

Browse files
authored
Rename triagebot canonicalize-issue-links to issue-links (#833)
1 parent 08a7fe8 commit 2e844b1

File tree

3 files changed

+26
-16
lines changed

3 files changed

+26
-16
lines changed

src/SUMMARY.md

+1
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)
+1-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
11
# Canonicalize Issue Links
22

3-
GitHub permits having automatic action like `Fixes #123`, which closes the issue number `123`.
4-
This handler updates the pull-request description with the canonicalized version, `Fixes org/repo#123`.
5-
6-
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.
7-
8-
## Configuration
9-
10-
This feature is enabled on a repository by having a `[canonicalize-issue-links]` table in `triagebot.toml`:
11-
12-
```toml
13-
[canonicalize-issue-links]
14-
```
15-
16-
## Implementation
17-
18-
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

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Issue Links
2+
3+
## Canonicalise Issue Links
4+
5+
GitHub permits having automatic action like `Fixes #123`, which closes the issue number `123`.
6+
This handler updates the pull-request description with the canonicalized version, `Fixes org/repo#123`.
7+
8+
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.
9+
10+
## Issue Links in Commits
11+
12+
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.
13+
14+
## Configuration
15+
16+
This feature is enabled on a repository by having a `[issue-links]` table in `triagebot.toml`:
17+
18+
```toml
19+
[issue-links]
20+
```
21+
22+
## Implementation
23+
24+
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)