Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Documentation Updates](./triagebot/doc-updates.md)
- [GitHub Releases](./triagebot/github-releases.md)
- [Glacier](./triagebot/glacier.md)
- [Issue Links](./triagebot/issue-links.md)
- [Issue Transfer](./triagebot/transfer.md)
- [Labeling](./triagebot/labeling.md)
- [Major Changes](./triagebot/major-changes.md)
Expand Down
17 changes: 1 addition & 16 deletions src/triagebot/canonicalize-issue-links.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# 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).
This handler was renamed to `[issue-links]` see [Issue Links](issue-links.md).
24 changes: 24 additions & 0 deletions src/triagebot/issue-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Issue Links

## Canonicalise 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.

## Issue Links in Commits

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.

## Configuration

This feature is enabled on a repository by having a `[issue-links]` table in `triagebot.toml`:

```toml
[issue-links]
```

## Implementation

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).