Configure reviews
Publishing results
Choose where HeyDeer delivers a review: a GitHub check, comments on the pull request, both, or neither. Find these options under Publish results in Organization settings → Review rules, or per repository; see How settings work.
Publishing options
| Option | Default | What it does |
|---|---|---|
| Publish GitHub check | On | Shows review progress and the full report in a check named HeyDeer Review on the pull request’s latest commit. |
| Fail the check when issues are found | Off | Fails the check for reported issues, unresolved earlier findings, failed repository checks, or an incomplete review. Appears only while the check is published. |
| Post review comments on the pull request | On | Posts one GitHub review per run, with inline comments on changed lines and other findings in the review body. Skips reviews with nothing to post. |
| Resolve addressed HeyDeer threads | On | Resolves HeyDeer’s own threads whose concern is fixed, or that someone with write access decided not to act on. |
Turning options off
With comments off, the HeyDeer Review check carries the whole review, and HeyDeer doesn’t approve pull requests or resolve its earlier threads. It still counts unresolved earlier findings in the check.
With both off, reviews still run and use credits, and results appear only on the Reviews page in HeyDeer. This suits trying HeyDeer before your team sees it; see Rolling out to your team.