リファレンス
設定リファレンス
すべてのレビュー設定と、その値およびデフォルト値の一覧です。組織のデフォルトは「組織設定」→「レビュールール」で設定し、リポジトリでは「リポジトリ」→(リポジトリ)→「レビュールール」でどの設定でも上書きできます。設定の仕組みを参照してください。
レビューのタイミング
| 設定 | 値 | デフォルト |
|---|---|---|
| レビューのタイミング | PRごとに1回、プッシュごと、手動のみ | 新しいワークスペースでは「手動のみ」 |
| PR ごとの自動レビュー上限 | 1、2、3、5、10、20、無制限。「プッシュごと」の場合のみ適用されます。 | 5 |
| PR がクローズされたら自動レビューを停止 | オン、オフ | オン |
| 自動レビューのフィルター | PR ラベル、作成者、作成者のチーム、作成者と組織の関係、作成者のアカウント、PR の状態、PR のソースに関する条件。プルリクエストはすべての条件に一致する必要があります。 | PR の状態がドラフトではなく、PR のソースが同じリポジトリ |
レビュー方法
| 設定 | 値 | デフォルト |
|---|---|---|
| デフォルトのレビューの深さ | 標準、詳細 | 標準 |
| 新しい変更のみレビュー | オン、オフ | オン |
| フィードバックの範囲 | 簡潔、バランス、詳細 | バランス |
| レビューの言語 | English, 简体中文, 日本語, Español, 한국어, Português (Brasil), Deutsch | English |
| 関連する Issue を読む | オン、オフ | オン |
結果の公開
| 設定 | 値 | デフォルト |
|---|---|---|
| 自動承認 | 自動承認しない、単純な変更のみ、問題が見つからなかった場合 | 自動承認しない |
| GitHub チェックを公開 | オン、オフ | オン |
| 問題が見つかった場合はチェックを失敗にする | オン、オフ。「GitHub チェックを公開」がオンの場合のみ適用されます。 | オフ |
| PR にレビューコメントを投稿 | オン、オフ。オフにすると、自動承認とスレッドの解決もオフになります。 | オン |
| 対応済みの HeyDeer スレッドを解決済みにする | オン、オフ | オン |
手動レビューの権限
| 設定 | 値 | デフォルト |
|---|---|---|
| 手動レビューを実行できるユーザー | 「リポジトリへの書き込み権限を持つ全員」または「書き込み権限を持つ指定ユーザーまたはチーム」。後者では最大 100 件の GitHub ユーザー名と、組織の場合は最大 30 件のチームスラッグを指定できます。 | リポジトリへの書き込み権限を持つ全員 |
変更は、保存後に依頼されたレビューに適用されます。待機中および実行中のレビューは、それぞれの設定のまま実行されます。
リポジトリのファイル
HeyDeer は、レビュー対象のリポジトリにある次のファイルも読み込みます。
| ファイル | 読み込み元 | ルールと制限 |
|---|---|---|
AGENTS.md, CLAUDE.md | プルリクエスト自身のバージョン | 任意のディレクトリ。そのディレクトリ以下に適用され、より深い階層のファイルが優先されます。AGENTS.md がないディレクトリでは CLAUDE.md が使われます。 |
.agents/checks/*.md | ベースブランチ | チェックごとに 1 つの Markdown ファイルを .agents/checks 直下に置き、名前には英字、数字、ドット、アンダースコア、ハイフンを使用します。各ファイルは最大 16,000 バイトで、1 回のレビューで適用される該当チェックはファイル名順に最大 10 個までです。 |
.agents/skills/ | プルリクエスト自身のバージョン | チェックで指定された場合に使用されます。フォルダー名がスキル名になります。小文字、数字、単一のハイフンを使い、最大 64 文字です。 |
.gitattributes | ベースブランチ | linguist-generated が指定されたファイルは、レビューから除外されます。 |
チェックのフロントマター
チェックの先頭に記述できる、任意の YAML フロントマターのキー:
| キー | 値 | 効果 |
|---|---|---|
files, globs, paths | glob パターン、またはそのリスト | チェックを適用する変更ファイル。パターンの先頭に ! を付けるとファイルを除外します。パターンがない場合、チェックは変更されたすべてのファイルに適用されます。 |
skills, skill | スキル名、またはそのリスト | チェックで使用するスキル。プルリクエストから読み込まれます。スキルが見つからなくてもレビューは停止しません。 |
skip_extra_reviewers | true または false | 詳細レビューでは、該当する各チェックに追加の労力をかけます。単純なチェックを標準と同じようにレビューするには true に設定します。 |
HeyDeer で設定する項目
| 構成 | 場所 | ルールと制限 |
|---|---|---|
| レビューへの指示 | 「組織設定」→「レビューへの指示」、または「リポジトリ」→(リポジトリ)→「レビューへの指示」 | プレーンテキストまたは Markdown で、範囲ごとに最大 12,000 文字。矛盾する場合はリポジトリの指示が優先されます。ワークスペース管理者が管理します。 |
| MCPサーバー | 「組織設定」→「MCPサーバー」、または「リポジトリ」→(リポジトリ)→「MCPサーバー」 | 範囲ごとに最大 20 台。各サーバーは、ポート 443 の公開 HTTPS エンドポイントで動作する Streamable HTTP サーバーである必要があります。名前には小文字、数字、ハイフン、アンダースコアを使い、最大 64 文字です。GitHub 組織またはアカウントのオーナーでもあるワークスペース管理者が管理します。 |