サードパーティ製 GitHub App のインストール

GitHub Apps のインストールについて

リソースで GitHub App を使うには、organization、または個人用アカウントにアプリをインストールする必要があります。 同じ GitHub App を複数のアカウントにインストールできます。 たとえば、自分の個人アカウントと、自分が所有するいくつかの組織にアプリをインストールした場合は、個人リポジトリ、アプリをインストールした組織、それらの組織が所有するリポジトリで、そのアプリを使用できます。

アプリをインストールすると、要求された organization およびリポジトリ リソースにアクセスするアクセス許可がアプリに付与されます。 インストール プロセス中、GitHub App によって要求されたアクセス許可が GitHub によって通知されます。 これらのアクセス許可で GitHub App が実行できる REST API 要求の詳細については、「GitHub Appに必要な権限」を参照してください。

リポジトリ アクセス許可を要求するアプリをインストールするときに、GitHub App にアクセス権限を付与するリポジトリも選びます。

GitHub App のインストール前に、GitHub App の所有者を信頼するようにしてください。 また、GitHub App から要求されているアクセス許可を見て、そうした許可を与えることに問題がないことを確認してください。 これらのアクセス許可で GitHub App が実行できる REST API 要求の詳細については、「GitHub Appに必要な権限」を参照してください。

インストールできるアプリの数に上限はありません。

インストールと承認の違い

GitHub App をインストールした後、アプリの承認を求められる場合があります。

アカウントまたは組織に GitHub App をインストールするときに、アプリが要求した組織とリポジトリのリソースにアクセスするためのアクセス許可をアプリに付与します。 また、アプリからアクセスできるリポジトリも指定します。 インストール プロセス中、GitHub App により、付与するリポジトリと組織のアクセス許可が示されます。 さまざまなアクセス許可により GitHub App で実行可能となることの詳細については、「GitHub アプリのアクセス許可を選択する」を参照してください。

たとえば、GitHub App にリポジトリのメタデータの読み取り、イシューを書き込む権限を付与し、GitHub App にすべてのリポジトリへのアクセス権を付与できます。

GitHub App を承認する際に、アプリが要求したアカウントのアクセス許可に基づいて、GitHub アカウントへのアクセス権をそのアプリに付与します。 承認プロセス中に、アプリによりアプリがアカウントでアクセスできるリソースが示されます。 GitHub App を承認したら、ユーザーに代わって動作するアプリのアクセス許可も付与します。

たとえば、GitHub App に、メール アドレスを読み取ったり、gist を書き込んだりするアクセス許可を付与できます。

アプリを承認しなくても、GitHub App をインストールできます。 同様に、アプリをインストールしなくてもアプリを承認できます。

GitHub Apps の承認について詳しくは、「GitHub App の承認」を参照してください。

GitHub App をインストールするための要件

Organization 所有者は、自分の Organization に GitHub Apps をインストールできます。

リポジトリ管理者は、 GitHub Apps を、アプリが組織のアクセス許可や "リポジトリ管理" アクセス許可を要求しない場合に、リポジトリを所有する組織にインストールできます。 その場合、彼らは自分が管理するリポジトリへのアクセス権があるアプリのみをインストールできます。

組織のメンバーと、組織にアプリをインストールできない外部のコラボレーターは、インストール プロセス中に組織を選択できます。 アプリをインストールする代わりに、GitHub は Organization の所有者に通知を送信し、アプリのインストールを依頼します。 これらの要求を行う機能は、アプリ アクセス要求ポリシーを使用して制御できます。 「OAuth アプリと GitHub アプリのアクセス要求とインストールの制限」を参照してください。

"アプリ マネージャー" ロールでは、Organization に GitHub App をインストールできません。 「GitHub App マネージャーについて」を参照してください。

GitHub App のインストール

アプリ所有者は、インストール プロセス中に GitHub の URL にリダイレクトし、GitHub App をインストールします。 URL は http(s)://HOSTNAME/github-apps/APP-NAME/installations/new のようになります。ここで、APP-NAME は GitHub App の名前です。

1. GitHub App をインストールする場所を選びます。 個人用アカウントまたは所属する organization を選択できます。

   これらのステップを実行してください：

2. アプリにリポジトリ権限が必要な場合は、[すべてのリポジトリ] または [選択したレポジトリのみ] を選びます。 アプリは、GitHub 上のすべてのパブリック リポジトリに対して、常に読み取り専用以上のアクセス権を持ちます。

   アプリでリポジトリのアクセス許可が必要ない場合、これらのオプションは表示されません。

3. 前の手順で [選択したリポジトリのみ] を選んだ場合は、[リポジトリの選択] ドロップダウンで、アプリでアクセスするリポジトリを選択します。

   アプリがリポジトリを作成する場合、そのリポジトリに対するアクセス権も自動的に付与されます。

4. アプリが要求しているアクセス許可を確認します。 これらのアクセス許可で GitHub App が実行できる REST API 要求について詳しくは、「GitHub Appに必要な権限」を参照してください。

5. [インストール]、[インストールして要求]、または [要求] を選択します。 表示されるボタンは、Organization の所有者がアプリに要求されたアクセス許可のうち、承認が不要か、一部のみ必要か、またはすべて必要かによって異なります。 詳細については、「GitHub App をインストールするための要件」を参照してください。