PR comment commands
Comment on a pull request to request a HeyDeer review or pause automatic reviews. Commands work in every connected repository, whatever its review schedule.
Commands
| Command | What it does |
|---|---|
@heydeer review | Reviews the current commit with the repository’s default depth and feedback scope. With Review only new changes on, it covers what changed since the last review. See Follow-up reviews. |
@heydeer full review | Reviews the whole pull request again. |
@heydeer pause | Stops automatic reviews on this pull request. Queued reviews continue, and you can still request one. |
@heydeer resume | Clears the pause. It doesn’t start a review. |
Requested reviews don’t count toward Maximum automatic reviews per PR. A request matching a review that is already queued or running joins it.
HeyDeer replies to confirm the command, or explains why it couldn’t run.
How HeyDeer reads a comment
- Post the command alone in a new comment in the pull request’s conversation. Inline review comments, edited comments, quoted commands and code blocks don’t run commands.
- Commands take no options. To choose the depth or feedback scope, start the review from HeyDeer.
Other comments that start with @heydeer get a list of commands, at most once an hour per pull request. HeyDeer doesn’t answer questions.
Who can run commands
Who can manually trigger reviews decides who can run commands. Set it in Organization settings → Review rules, under Manual review access, or in a repository’s Review rules.
| Option | Who can request reviews |
|---|---|
| Anyone with repository write access | Default. Anyone with write, maintain or admin access. |
| Selected users or teams with write access | People in Manual trigger usernames or Manual trigger team slugs who also have write access, up to 100 usernames and 30 teams. |
The same rule applies to reviews started from HeyDeer and from the check’s buttons. Automatic review filters don’t limit requested reviews. See Review filters.
Start a review from HeyDeer
- In HeyDeer, open Reviews and click New review.
- Choose the Repository and Pull request. You can pick only repositories where you have write access.
- Choose the Review depth and Feedback scope. Both start at the repository’s defaults.
- Click Preview review to check the size and your credits, then click Run review.