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 | 自動レビューのフィルターによってプルリクエストが除外された場合（デフォルトではドラフト）、または変更されたファイルがすべてレビューの対象外の場合。 |
| スキップまたは要対応（Action required） | Review skipped / Review required | コミットが自動でレビューされなかった場合（「手動のみ」の場合、「PRごとに1回」のレビューをすでに使った場合、クレジットが不足している場合など）。この設定がオンの場合は Action required になります。 |
コミットがレビューされなかった場合やレビューが完了しなかった場合は、次に何をすべきかが要約に記載されます。通常は @heydeer review とコメントするよう案内されます。
問題が見つかった場合はチェックを失敗にする
この設定はデフォルトでオフのため、完了したレビューは問題を報告した場合でも合格になります。「結果の公開」でオンにできます。結果の公開を参照してください。
ここでいう問題とは、レビューのフィードバックの範囲内の指摘事項（議論ですでに挙げられたものを含む）と、まだ未解決の HeyDeer の以前のスレッドです。書き込み権限を持つ人が見送った懸念は数えられません。フォローアップレビューを参照してください。
マージ前にチェックを必須にする
- チェックが存在するように、リポジトリで少なくとも 1 件のプルリクエストを HeyDeer にレビューさせます。
- GitHub で対象ブランチのブランチ保護ルールまたはルールセットを開き、必須ステータスチェックをオンにします。
- 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コメントのコマンドを参照してください。