HeyDeer Review 검사
HeyDeer는 각 검토를 검토한 커밋에 HeyDeer Review라는 이름의 GitHub 검사로 보고합니다. 이 검사에는 요약과 전체 검토 내용이 담기며, 병합 전에 이 검사를 필수로 지정할 수 있습니다.
검사에 표시되는 내용
검사는 검토 진행 상황을 표시한 뒤 아래 결론 중 하나로 완료됩니다. Details 링크를 누르면 HeyDeer에서 검토가 열립니다.
요약은 발견 사항 수, 해결되지 않은 이전 스레드 수, 실패한 저장소 검사 수로 시작하며, 후속 검토가 HeyDeer의 이전 검토 이후 변경 사항만 다뤘는지도 알려 줍니다. 이어서 검사 페이지에 전체 검토가 표시됩니다. 경고, 모든 문제, 논의에서 거절된 우려 사항, 그리고 “자동 승인”이 켜져 있을 때의 승인 결정이 포함됩니다. 검토 결과 읽기를 참고하세요.
결론
| 결론 | 제목 | 조건 |
|---|---|---|
| Success | Review completed — no issues found / Review completed with findings | 문제가 없거나, “문제가 발견되면 검사를 실패로 표시”가 꺼진 상태에서 문제가 있는 경우. |
| Neutral | Review completed with warnings / Review completed with findings | 검토에 경고가 있고 이 설정이 꺼져 있는 경우. |
| Failure | Review found issues that need attention / Review incomplete | 이 설정이 켜진 상태에서 문제나 경고가 있는 경우. 저장소 검사나 이전 발견 사항이 평가되지 않았을 때는 설정과 관계없이 Review incomplete도 표시됩니다. |
| Failure | Review could not run / Review failed | HeyDeer가 검토를 시작하거나 완료하지 못한 경우. 요약에 그 이유가 표시됩니다. |
| Timed out | Review timed out | 검토 시간이 초과된 경우. |
| Cancelled | Review cancelled / Review superseded | 검토가 취소되었거나, 결과가 이전 커밋 또는 이전 대상 브랜치에 대한 것인 경우. |
| 건너뜀 | Review skipped / No reviewable files | 자동 검토 필터가 풀 리퀘스트를 제외하거나(기본적으로 초안), 변경된 모든 파일이 검토 범위 밖인 경우. |
| Skipped 또는 Action required | Review skipped / Review required | “수동만”으로 설정되어 있거나, “PR당 한 번”의 검토를 이미 사용했거나, 크레딧이 부족한 경우처럼 커밋이 자동으로 검토되지 않은 경우. 이 설정이 켜져 있으면 Action required가 됩니다. |
커밋이 검토되지 않았거나 검토가 완료되지 않았으면 요약에 다음에 할 일이 표시됩니다. 대개 @heydeer review라고 댓글을 남기라는 안내입니다.
문제가 발견되면 검사를 실패로 표시
이 설정은 기본적으로 꺼져 있으므로, 완료된 검토는 문제를 보고하더라도 통과합니다. “결과 게시” 아래에서 켤 수 있습니다. 결과 게시를 참고하세요.
문제란 검토의 피드백 범위 안에 있는 발견 사항(논의에서 이미 제기된 것 포함)과, 아직 열려 있는 HeyDeer의 이전 스레드를 말합니다. 쓰기 권한이 있는 사람이 거절한 우려 사항은 포함되지 않습니다. 후속 검토를 참고하세요.
병합 전에 검사를 필수로 지정하기
- 검사가 생성되도록 HeyDeer가 저장소에서 풀 리퀘스트를 한 번 이상 검토하게 하세요.
- GitHub에서 대상 브랜치의 브랜치 보호 규칙 또는 ruleset을 열고 필수 상태 검사(required status checks)를 켜세요.
- HeyDeer Review를 추가하고 소스로 HeyDeer를 선택하세요.
- “문제가 발견되면 검사를 실패로 표시”를 켜세요. 켜지 않으면 검토에서 문제를 보고해도 검사가 통과합니다.
GitHub는 Success, Neutral, Skipped를 통과로, Failure, Action required, Timed out, Cancelled를 차단으로 처리합니다. HeyDeer가 저장소에 검사를 게시하기 시작하면 풀 리퀘스트가 업데이트될 때마다 검사 결과가 생기므로, 필수 검사가 끝없이 대기하는 일은 없습니다. 병합 큐에서는 큐에 있는 각 풀 리퀘스트가 검토 요건을 충족하는지 검사가 확인하며, 합쳐진 코드를 검토하거나 크레딧을 사용하지는 않습니다. 병합 그룹은 계속 CI로 확인해야 합니다.
“수동만” 저장소에서는 HeyDeer가 그 저장소에서 첫 검토를 하기 전까지 검사를 게시하지 않습니다. 자동 리뷰를 참고하세요.
검사에서 검토 요청하기
Re-run, Re-run all, Review this revision 버튼은 모두 해당 검사의 커밋에 대해, 클릭한 사람이 @heydeer review라고 댓글을 남긴 것처럼 동작합니다. Review this revision은 검토가 다음 단계일 때 표시됩니다. PR 댓글 명령을 참고하세요.