HeyDeer Review チェック

チェックに表示される内容

チェックは HeyDeer がレビューしたコミットに付きます。レビューの進捗を表示し、完了すると下記のいずれかの結論になります。Details リンクから HeyDeer でレビューを開けます。

Autopilot が PR に対応している間、チェックは Autopilot が停止して HeyDeer がレビューを公開するまで進行中のままです。

デフォルトでは、指摘事項があってもチェックは失敗しません。指摘事項が修正されるか見送られるまでマージをブロックするには、問題が見つかった場合はチェックを失敗にするをオンにし、チェックを必須にします。

要約の冒頭には、指摘事項、未解決の以前の問題、失敗したリポジトリのチェックの数が示されます。フォローアップレビューの場合は、HeyDeer が前回のレビュー以降の変更だけをレビューしたかどうかも記載されます。

その下には、レビューの全内容が表示されます。レビューの注意事項、すべての指摘事項、議論で見送られた懸念、そして自動承認がオンの場合は承認の判断です。レビューの読み方を参照してください。

マージ前にチェックを必須にする

1. チェックが存在するように、リポジトリで少なくとも 1 件のプルリクエストを HeyDeer にレビューさせます。
2. GitHub でベースブランチのブランチ保護ルールまたはルールセットを開き、必須ステータスチェックをオンにします。
3. HeyDeer Review を追加し、ソースとして HeyDeer を選択します。
4. HeyDeer で、ワークスペース設定 → レビュールール → 結果の公開、またはリポジトリのレビュールールにある問題が見つかった場合はチェックを失敗にするをオンにします。

GitHub は Success、Neutral、Skipped を合格として扱い、Failure、Action required、Timed out、Cancelled をブロックとして扱います。

HeyDeer がリポジトリでチェックを公開するようになると、プルリクエストが更新されるたびにチェック結果が作成されるため、必須チェックがいつまでも待機し続けることはありません。

手動のみのリポジトリでは、そこで最初のレビューが行われるまで HeyDeer はチェックを公開しません。自動レビューを参照してください。

チェックが表示されない場合は、トラブルシューティングを参照してください。

問題が見つかった場合はチェックを失敗にする

この設定はデフォルトでオフのため、完了したレビューは指摘事項を報告した場合でも成功になります。

オンにすると、フィードバックの範囲内の指摘事項（既存の会話に紐づくものを含む）や、未解決または未確認の以前の問題がある場合にチェックが失敗します。書き込み権限を持つ人が見送った問題は数えません。以前の問題を参照してください。

レビューの注意事項があるレビューも失敗します。自動でレビューされなかった一部のコミットでは、Skipped ではなく Action required が表示されます。結論を参照してください。

結論

HeyDeer がコミットを自動でレビューしなかった場合は、タイトルに理由が表示されます。たとえば、PR がPR ごとの自動レビュー上限に達した場合です。

コミットがレビューされなかった場合やレビューが完了しなかった場合は、次に何をすべきかが要約に記載されます。通常は @heydeer review とコメントするよう案内されます。トラブルシューティングも参照してください。

チェックからレビューを依頼する

Re-run、Re-run all、このリビジョンをレビューボタンは、いずれも @heydeer review とコメントした場合と同じように、そのチェックのコミットのレビューを依頼します。このリビジョンをレビューは、次のステップがレビューである場合に表示されます。PR コメントのコマンドを参照してください。

HeyDeer が依頼を受け付けられない場合、チェックはそのまま変わりません。理由を確認するには、@heydeer review とコメントします。

マージキュー

マージキューでは、キュー内の各プルリクエストがレビュー要件を満たしていることをチェックが確認します。結合後のコードはレビューせず、クレジットも消費しません。マージグループのチェックは引き続き CI で行ってください。