-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #797 from Urgau/rendered_link-add
Add documentation for rendered link triagebot handler
- Loading branch information
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |