リファレンス

GitHub App と権限

HeyDeer は、個人アカウントまたは組織にインストールされた GitHub App を通じて動作します。HeyDeer が読み込んでレビューできるリポジトリは、自分で選択します。

HeyDeer をインストールする

各ワークスペースは、1 つの GitHub アカウント（個人アカウントまたは組織）に属します。

GitHub でインストールまたは別のアカウントにインストールを選択します。初回のセットアップでは、リポジトリを接続の下にあります。後から別のアカウントを接続するには、まずワークスペースメニューでワークスペースを追加を選択します。
GitHub でアカウントを選び、次に HeyDeer がレビューできるリポジトリを選びます。
GitHub で確定します。その後、HeyDeer がそのアカウントのワークスペースを開きます。

組織では、GitHub App をインストールできるのはオーナーだけです。オーナー以外の場合は、GitHub からオーナーにリクエストが送信されます。承認待ちの間、HeyDeer にはGitHub オーナーの承認を待っていますと表示されますが、ワークスペース管理者はその間も設定を変更できます。

オーナーが承認すると、ワークスペースは自動的に接続され、HeyDeer からワークスペースの通知先アドレスにメールが送信されます。

リポジトリを追加

GitHub で Only select repositories を選び、レビューするリポジトリを指定します。All repositories を選ぶと、後から作成されたリポジトリも含まれます。

後からリポジトリを追加するには、リポジトリページでリポジトリを追加を選択するか、ワークスペース設定 → GitHub 接続でGitHub のアクセス権を管理を選択します。GitHub で変更を保存できるのは、その GitHub アカウントのオーナーだけです。それ以外の人にはチームに依頼が表示され、コピーしてオーナーに送れる依頼文が用意されます。

追加されたリポジトリには、レビュールールのワークスペースのデフォルトが適用されます。HeyDeer でリポジトリとそのレビューが表示されるのは、本人と HeyDeer の両方が GitHub でそのリポジトリにアクセスできる場合です。レビューを依頼するには書き込み権限が必要です。PR コメントのコマンドを参照してください。

権限

権限	アクセス	HeyDeer での用途
Contents	読み取り・書き込み	コードと履歴の読み取り、HeyDeer 自身のレビュー会話の解決、修正と @heydeer への依頼のためのブランチとコミットのプッシュ。
Pull requests	読み取り・書き込み	プルリクエストの読み取り、レビュー・コメント・返信の投稿、依頼されたプルリクエストの作成・更新・マージ。
Workflows	読み取り・書き込み	修正や依頼で必要な場合に GitHub Actions ワークフローファイルを更新します。
Checks	読み取り・書き込み	HeyDeer Review チェックを表示し、そのボタンからのリクエストを受け取ります。
Actions	読み取り	失敗した GitHub Actions ジョブのログを読み取り、Autopilot が修正できるようにします。
Issues	読み取り・書き込み	@heydeer へのメンションとコマンドを受信し、リアクションで受け付けを知らせ、関連する Issue を読み取り、依頼された Issue を作成・更新します。
Metadata	読み取り	リポジトリの基本情報と、書き込み権限を持つユーザーを読み取ります。
Members（組織）	読み取り	ワークスペースのメンバーを一覧表示し、自動レビューのフィルターと手動レビューの権限にあるメンバーやチームの条件を確認します。
Email addresses（アカウント）	読み取り	確認済みのメールアドレスを通知先アドレスとして提案します。

HeyDeer に必要な権限が GitHub で許可されていない場合、ワークスペース設定 → GitHub 接続にGitHub の権限が必要ですまたは追加の GitHub 権限を付与できますと表示されます。GitHub アカウントのオーナーが権限リクエストを確認を選択し、GitHub で承認します。

HeyDeer によるコードとデータの取り扱いについては、セキュリティとデータの処理を参照してください。

アカウントやリポジトリが表示されない場合

接続時に表示されるのは、HeyDeer をインストールした組織だけです。組織を追加するには、GitHub でインストールまたは別のアカウントにインストールを選び、GitHub でその組織を選択します。オーナーでない場合は、GitHub がオーナーに依頼を送ります。HeyDeer をインストール済みの組織が表示されない場合は、GitHub でその組織に SSO でサインインし、アカウントが見つかりませんか？を開いてGitHub に再度サインインを選んでください。

オーナーがリクエストを承認した時点で組織にワークスペースがなかった場合、HeyDeer はあなたを管理者としてワークスペースを作成します。

HeyDeer にリポジトリへのアクセスを復元と表示される場合、HeyDeer に許可されたリポジトリにあなたの GitHub アカウントからアクセスできません。GitHub の認証を更新を選択してください。その他のケースについてはトラブルシューティングを参照してください。

HeyDeer の GitHub へのアクセスが一時停止または削除された場合

GitHub で HeyDeer が一時停止されている場合、ワークスペース設定 → GitHub 接続にGitHub へのアクセスは一時停止中ですと表示され、レビューを実行できません。GitHub アカウントのオーナーがGitHub へのアクセスを再開を選択します。

HeyDeer がアンインストールされた場合は、HeyDeer が GitHub からアンインストールされましたと表示されます。オーナーがHeyDeer を再インストールを選択します。ワークスペースの設定とレビュー履歴は保持されます。