GitHub 上のレビュー
PRコメントのコマンド
プルリクエストにコメントして、HeyDeer のレビューを依頼したり、自動レビューを一時停止したりできます。コマンドは、レビューのタイミングの設定にかかわらず、接続されたすべてのリポジトリで使えます。
コマンド
| コマンド | 動作 |
|---|---|
@heydeer review | リポジトリのデフォルトのレビューの深さとフィードバックの範囲で、現在のコミットをレビューします。「新しい変更のみレビュー」がオンの場合は、前回のレビュー以降の変更を対象にします。フォローアップレビューを参照してください。 |
@heydeer full review | プルリクエスト全体をもう一度レビューします。 |
@heydeer pause | このプルリクエストの自動レビューを停止します。待機中のレビューは続行され、レビューの依頼も引き続きできます。 |
@heydeer resume | 一時停止を解除します。レビューは開始しません。 |
依頼したレビューは「PR ごとの自動レビュー上限」に数えられません。すでに待機中または実行中のレビューと一致する依頼は、そのレビューに統合されます。
HeyDeer は返信でコマンドを確認するか、実行できなかった理由を説明します。
HeyDeer によるコメントの読み取り方
- コマンドは、プルリクエストの会話に新しいコメントとして単独で投稿してください。インラインのレビューコメント、編集したコメント、引用したコマンド、コードブロックではコマンドは実行されません。
- コマンドにオプションはありません。レビューの深さやフィードバックの範囲を選ぶには、HeyDeer からレビューを開始してください。
@heydeer で始まるその他のコメントには、プルリクエストごとに 1 時間に最大 1 回、コマンドの一覧が返信されます。HeyDeer は質問には回答しません。
コマンドを実行できるユーザー
コマンドを実行できるユーザーは、「手動レビューを実行できるユーザー」で決まります。「組織設定」→「レビュールール」の「手動レビューの権限」、またはリポジトリの「レビュールール」で設定します。
| オプション | レビューを依頼できるユーザー |
|---|---|
| リポジトリへの書き込み権限を持つ全員 | デフォルト。write、maintain、admin のいずれかの権限を持つ全員。 |
| 書き込み権限を持つ指定ユーザーまたはチーム | 「手動実行を許可するユーザー名」または「手動実行を許可するチームのスラッグ」に含まれ、かつ書き込み権限を持つユーザー。最大 100 ユーザー名、30 チームまで指定できます。 |
HeyDeer から開始するレビューやチェックのボタンから開始するレビューにも、同じルールが適用されます。自動レビューのフィルターは、依頼されたレビューを制限しません。レビューのフィルターを参照してください。
HeyDeer からレビューを開始する
- HeyDeer で「レビュー」を開き、「新しいレビュー」をクリックします。
- 「リポジトリ」と「プルリクエスト」を選択します。選択できるのは、書き込み権限を持つリポジトリだけです。
- レビューの深さとフィードバックの範囲を選択します。どちらもリポジトリのデフォルト値が初期設定されています。
- 「レビューをプレビュー」をクリックしてサイズとクレジットを確認し、「レビューを実行する」をクリックします。