HeyDeer Review 검사
HeyDeer는 각 검토 결과를 HeyDeer Review라는 GitHub 검사로 보고합니다. 검사 결과의 의미와 이 검사로 병합을 막는 방법을 알아보세요.
검사에 표시되는 내용
검사는 HeyDeer가 검토한 커밋에 표시됩니다. 검토 진행 상황을 보여 준 뒤, 아래의 결론 중 하나로 완료됩니다. Details 링크를 누르면 HeyDeer에서 검토가 열립니다.
Autopilot이 PR을 처리하는 동안 이 검사는 Autopilot이 멈추고 HeyDeer가 검토를 게시할 때까지 진행 중 상태로 유지됩니다.
기본적으로 발견 사항이 있어도 검사는 실패하지 않습니다. 발견 사항을 수정하거나 처리하지 않기로 결정할 때까지 병합을 막으려면 문제가 발견되면 검사를 실패로 표시를 켜고 검사를 필수로 지정하세요.
요약은 발견 사항, 처리되지 않은 이전 문제, 실패한 저장소 검사의 개수로 시작합니다. 후속 검토라면 HeyDeer가 이전 검토 이후의 변경 사항만 검토했는지도 알려 줍니다.
그 아래에는 검토 안내, 모든 발견 사항, 논의에서 처리하지 않기로 한 우려 사항, 그리고 자동 승인이 켜져 있으면 승인 결정까지 전체 검토 내용이 표시됩니다. 검토 결과 읽기를 참고하세요.
병합 전에 검사를 필수로 지정하기
- 검사가 생성되도록 HeyDeer가 저장소에서 풀 리퀘스트를 한 번 이상 검토하게 하세요.
- GitHub에서 기준 브랜치의 브랜치 보호 규칙 또는 ruleset을 열고 필수 상태 검사(required status checks)를 켜세요.
- HeyDeer Review를 추가하고 소스로 HeyDeer를 선택하세요.
- HeyDeer의 워크스페이스 설정 → 검토 규칙 → 결과 게시 또는 저장소의 검토 규칙에서 문제가 발견되면 검사를 실패로 표시를 켜세요.
GitHub는 Success, Neutral, Skipped를 통과로, Failure, Action required, Timed out, Cancelled를 병합 차단으로 처리합니다.
HeyDeer가 저장소에 검사를 게시하기 시작하면 풀 리퀘스트가 업데이트될 때마다 검사 결과가 생기므로, 필수 검사가 끝없이 대기하는 일은 없습니다.
수동 검토만으로 설정된 저장소에서는 그 저장소의 첫 검토 전까지 HeyDeer가 검사를 게시하지 않습니다. 자동 검토를 참고하세요.
검사가 표시되지 않으면 문제 해결을 참고하세요.
문제가 발견되면 검사를 실패로 표시
이 설정은 기본적으로 꺼져 있으므로, 완료된 검토는 발견 사항을 보고하더라도 통과합니다.
이 설정을 켜면 피드백 범위 안의 발견 사항(기존 대화와 연결된 발견 사항 포함)이나, 처리되지 않았거나 확인되지 않은 이전 문제가 있을 때 검사가 실패합니다. 쓰기 권한이 있는 사람이 처리하지 않기로 한 우려 사항은 포함되지 않습니다. 이전 문제를 참고하세요.
검토 안내가 있는 검토도 실패합니다. 자동으로 검토되지 않은 일부 커밋은 Skipped 대신 Action required로 표시됩니다. 결론을 참고하세요.
결론
| 결론 | 제목 | 조건 |
|---|---|---|
| Success | 검토 완료 — 문제가 발견되지 않음 / 검토 완료, 발견 사항 있음 / 이전 문제 확인 필요 / 검토 완료, 안내 사항 있음 | 검토가 완료되었고 추가 설명이 필요한 사항이 없는 경우. 문제가 발견되면 검사를 실패로 표시가 꺼져 있으면 발견 사항이나 이전 문제가 있는 검토도 포함됩니다. |
| Neutral | 검토 미완료 / 검토 완료, 발견 사항 있음 / 검토에 추가 설명 필요 | 설정과 관계없이 추가 설명이 필요한 질문이 있는 경우, 또는 검토에 검토 안내가 있고 문제가 발견되면 검사를 실패로 표시가 꺼져 있는 경우. |
| Failure | 검토에서 처리해야 할 문제를 발견함 / 이전 문제 확인 필요 / 검토 미완료 / 검토를 실행할 수 없음 / 검토 실패 | 문제가 발견되면 검사를 실패로 표시가 켜져 있을 때: 발견 사항, 이전 문제 또는 검토 안내가 있는 경우. 설정과 관계없이: 저장소 검사가 실행되지 않았거나, 이전 문제를 다시 확인하지 못했거나, HeyDeer가 검토를 시작하거나 완료하지 못한 경우. |
| Timed out | 검토 시간 초과 | 검토 시간이 초과된 경우. |
| Cancelled | 검토 취소됨 / 검토 결과가 더 이상 유효하지 않음 | 검토가 취소된 경우, 또는 기준 브랜치가 바뀌었거나 이 커밋을 최신 커밋으로 가진 열린 PR이 없어 결과가 더 이상 적용되지 않는 경우. |
| Skipped | 검토 건너뜀 / 검토할 파일 없음 | 자동 검토 필터에서 풀 리퀘스트가 제외된 경우(기본적으로 초안, 포크에서 온 PR, 종속성 업데이트), 또는 변경된 파일이 모두 검토 범위 밖에 있는 경우. PR이 변경되어 HeyDeer가 자동 검토를 중지한 경우에도 검사를 건너뜁니다. |
| Skipped 또는 Action required | 검토 건너뜀 / 검토 필요 | 수동 검토만, PR당 한 번, PR에서의 일시 중지 또는 PR당 최대 자동 검토 횟수 설정으로 인해 자동 검토가 실행되지 않았습니다. 워크스페이스의 크레딧이 부족하거나 사용량 한도에 도달했거나, 저장소가 다른 워크스페이스의 무료 크레딧에 연결된 경우도 해당합니다. 문제가 발견되면 검사를 실패로 표시가 켜져 있으면 Action required로 표시되어 병합이 차단됩니다. |
HeyDeer가 커밋을 자동으로 검토하지 않으면 제목에 이유가 표시됩니다. 예를 들어 PR이 PR당 최대 자동 검토 횟수에 도달한 경우입니다.
커밋이 검토되지 않았거나 검토가 완료되지 않으면, 요약에 다음에 할 일이 표시됩니다. 보통은 @heydeer review 댓글을 남기라는 안내입니다. 문제 해결도 참고하세요.
검사에서 검토 요청하기
Re-run, Re-run all, 이 버전 검토 버튼은 모두 @heydeer review 댓글을 남긴 것처럼 검사의 커밋에 대한 검토를 요청합니다. 이 버전 검토 버튼은 검토가 다음 단계일 때 표시됩니다. PR 댓글 명령을 참고하세요.
HeyDeer가 요청을 받을 수 없으면 검사는 그대로 유지됩니다. 이유를 확인하려면 @heydeer review 댓글을 남기세요.
병합 대기열
병합 대기열에서 이 검사는 결합된 코드를 검토하거나 크레딧을 사용하지 않고, 대기열의 각 풀 리퀘스트가 검토 요건을 충족하는지 확인합니다. 병합 그룹은 여전히 CI로 검사해야 합니다.
여러 열린 PR이 같은 커밋을 공유하는 경우
최신 커밋이 같은 열린 PR들은 하나의 검사를 공유하며, 이 검사는 모든 PR의 검토가 병합을 허용할 때만 통과합니다. 요약에는 각 PR의 전체 보고서 링크가 있습니다.
공유된 검사에는 이 버전 검토 버튼이 없으므로, 해당 PR에서 직접 검토를 요청하세요.