GitHub App の使用について

GitHub Apps について

GitHub Apps は、GitHub の機能を拡張するツールです。 GitHub Apps を使うと、GitHub で、issue を開く、pull request にコメントする、プロジェクトを管理する、といったことを行うことができます。 また、GitHub で発生するイベントに基づいて、GitHub の外部で何かを行うこともできます。 たとえば、GitHub で issue が開かれたときに、GitHub App で Slack に投稿できます。

GitHub Apps の検索

GitHub Apps は、GitHub Marketplace で見つけることができます。

独自の GitHub App を作成することもできます。 詳しくは、「GitHub App の作成について」を参照してください。

GitHub Apps を使用する

GitHub App を使うには、ユーザーまたは Organization のアカウントにアプリをインストールする必要があります。 アプリをインストールするときに、リポジトリと Organization のデータの読み取りまたは変更を行うためのアクセス許可を、アプリに付与します。 具体的なアクセス許可はアプリによって異なり、アプリで要求されているアクセス許可は、アプリをインストールする前に GitHub によって示されます。 アプリをインストールするときに、アプリがアクセスできるリポジトリも指定します。 アプリで追加の構成が必要な場合は、その構成を行うようアプリで指示されます。 詳しくは、「個人向けアカウント用に GitHub Marketplace から GitHub アプリをインストールする」、「Organization の GitHub Marketplace から GitHub アプリをインストールする」、「サード パーティからの GitHub App のインストール」および「独自の GitHub App のインストール」を参照してください。

また、ID の検証、アクセスできるリソースの把握、ユーザーの代理でのアクションの実行を、GitHub App に承認することが必要な場合もあります。 アプリを承認する必要がある場合は、それを求めるメッセージがアプリで表示されます。 詳しくは、「GitHub App の承認」を参照してください。

場合によっては、更新されたアクセス許可を GitHub App が要求することがあります。 これが発生すると、GitHub によって通知されます。 アプリを引き続き機能させるには、更新されたアクセス許可を確認して承認する必要があります。 詳しくは、「GitHub アプリの更新されたアクセス許可の承認」を参照してください。

GitHub App をインストールまたは承認する前に、アプリの開発者を信頼できることを確認する必要があります。 アプリを使わなくなった場合は、アプリの一時停止またはアンインストールと、アプリの承認の取り消しの両方または一方を、行う必要があります。 詳細については、「インストールした GitHub App の確認と変更」および「GitHub Apps の承認の確認と取り消し」を参照してください。

GitHub Apps と OAuth apps

GitHub は、OAuth apps もサポートします。 GitHub Apps とは異なり、ユーザーが OAuth app をインストールしたり、アクセスできるリポジトリを制御したりすることはありません。

OAuth apps と GitHub Apps はどちらも OAuth 2.0 を使います。

OAuth apps はユーザーに代わってのみ動作できるのに対し、GitHub Apps はユーザーの代わりに、またはユーザーと関係なく動作できます。

詳細については、「GitHub Apps と OAuth アプリの違い」および「OAuth アプリの承認」を参照してください。