Skip to content

Commit

Permalink
Merge pull request #797 from Urgau/rendered_link-add
Browse files Browse the repository at this point in the history
Add documentation for rendered link triagebot handler
  • Loading branch information
ehuss authored Jan 7, 2025
2 parents a0f7cee + 3b753d9 commit 10d9cd3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
- [Note](./triagebot/note.md)
- [Notifications](./triagebot/notifications.md)
- [Pinging](./triagebot/pinging.md)
- [Rendered link](./triagebot/rendered-link.md)
- [Requesting Prioritization](./triagebot/requesting-prioritization.md)
- [Review Changes Requested](./triagebot/review-submitted.md)
- [Review Requested](./triagebot/review-requested.md)
Expand Down
18 changes: 18 additions & 0 deletions src/triagebot/rendered-link.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Rendered link

Rendered links are simple hyperlinks that are automatically added (and updated) to a PR description by triagebot.

## Configuration

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

```toml
[rendered-link]
trigger-files = ["posts/"]
```

The `trigger-files` key configures which directories are watched for modification, with the "Rendered link" pointing to the first file matching.

## Implementation

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

0 comments on commit 10d9cd3

Please sign in to comment.