Skip to main content

GitHub Apps の使用について

GitHub App とは何か、そして GitHub App を使う理由について説明します。

GitHub Apps について

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

GitHub Apps の検索

エンタープライズにサード パーティのアプリケーションをインストールすることはできません。 サード パーティのアプリの機能を使いたい場合は、マニフェストまたは URL パラメーターからアプリを作成する方法について、アプリ開発者に問い合わせてください。 詳細については、「マニフェストからのGitHub アプリの登録」と「URL パラメーターを使用したGitHub アプリの登録」を参照してください。

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

GitHub Apps を使用する

GitHub App を使用するには、ユーザーまたは組織アカウントにアプリをインストールする必要があります。 アプリをインストールすると、アカウントのデータの読み取りまたは変更のアクセス許可がアプリに付与されます。 具体的なアクセス許可はアプリによって異なり、アプリで要求されているアクセス許可は、アプリをインストールする前に GitHub によって示されます。 Organization またはユーザー アカウントにアプリをインストールするときに、アプリがアクセスできるリポジトリも指定します。

アプリで追加の構成が必要な場合は、その構成を行うようアプリで指示されます。 詳細については、「サードパーティ製 GitHub App のインストール」、「独自のGitHub アプリのインストール」を参照してください。

また、ID の検証、アクセスできるリソースの把握、ユーザーの代理でのアクションの実行を、GitHub App に承認することが必要な場合もあります。 アプリを承認する必要がある場合は、それを求めるメッセージがアプリで表示されます。 アプリがユーザーに代わって操作する場合、リソースを所有するアカウントにそのアプリがインストールされ、適切なアクセス許可が付与されている限り、そのアプリはユーザーと同じリソースにアクセスできます。 詳しくは、「GitHub アプリの承認」をご覧ください。

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

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

GitHub Apps と OAuth apps

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

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

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

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