GitHub App と権限
HeyDeer は、個人アカウントまたは組織にインストールされた GitHub App を通じて動作します。HeyDeer が読み込んでレビューできるリポジトリは、インストールの設定で決まります。
HeyDeer をインストールする
各ワークスペースは 1 つの GitHub アカウントに属します。ワークスペースを設定すると GitHub に移動してアプリをインストールしますが、組織の場合はオーナーだけがインストールできます。
オーナー以外の場合は、GitHub からオーナーにリクエストが送信されます。承認待ちの間、HeyDeer には「GitHub オーナーの承認を待っています」と表示されますが、管理者はその間もワークスペースを設定できます。オーナーが承認すると、ワークスペースは自動的に接続され、HeyDeer から通知先アドレスにメールが送信されます。「GitHub 組織を追加」からリクエストした場合は、HeyDeer がその組織のワークスペースを作成し、あなたを管理者に設定します。
リポジトリを選択
Only select repositories を選んでレビューするリポジトリを指定します。All repositories を選ぶと、後から作成されたリポジトリも追加されます。選択を変更するには、「組織設定」→「GitHub 接続」を開き、「GitHub のアクセス権を管理」を選択します。そこで変更を保存できるのは、そのアカウントの GitHub オーナーだけです。
追加されたリポジトリには、組織のレビュールールが適用されます。HeyDeer でリポジトリとそのレビューが表示されるのは、本人とインストールの両方が GitHub でそのリポジトリにアクセスできる場合です。レビューを依頼するには書き込み権限が必要です。PRコメントのコマンドを参照してください。
組織が表示されない場合は、「GitHub 組織を追加」を選択します。SSO を使用している組織の場合は、まず GitHub で SSO を通じてサインインしてから、「GitHub を再認可」を選択してください。
権限
| 権限 | アクセス | HeyDeer での用途 |
|---|---|---|
| Contents | 読み取りと書き込み | コードと履歴を読み取ります。GitHub ではレビュースレッドを解決するのに書き込み権限が必要ですが、HeyDeer はこれを自身のスレッドにのみ使用します。 |
| Pull requests | 読み取りと書き込み | プルリクエストを読み取り、レビュー、コメント、返信を公開します。 |
| Checks | 読み取りと書き込み | HeyDeer Review チェックを表示し、そのボタンからのリクエストを受け取ります。 |
| Issues | 読み取り | PR コメントのコマンドを受け取り、関連する Issue を読み取ります。 |
| Metadata | 読み取り | リポジトリの基本情報と、書き込み権限を持つユーザーを読み取ります。 |
| Members（組織） | 読み取り | ワークスペースのメンバーを一覧表示し、メンバーやチームのルールと照合します。 |
| Email addresses（アカウント） | 読み取り | 確認済みのメールアドレスを通知先アドレスとして提案します。 |
インストールで許可されていない権限が HeyDeer に必要な場合は、「組織設定」→「GitHub 接続」に「GitHub の権限が必要です」と表示されます。「権限リクエストを確認」を選択すると、オーナーが GitHub でリクエストを承認できます。