GitHub アプリの登録

登録について GitHub Apps

GitHub Appは、いくつかの方法で登録できます。

個人用アカウントの下で
自分が所有する組織の下
あなたが全アプリを管理する権限を得ている組織の配下で。「AUTOTITLE」を参照してください。

ユーザーまたは organization は、最大 100 個の GitHub Apps を登録できますが、1 つのアカウントにインストールできる GitHub Apps の数に制限はありません。

GitHub App を登録する

GitHub の任意のページの右上隅にある、自分のプロフィール写真をクリックします。
アカウント設定にアクセスしてください。
- 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
- 組織が所有するアプリの場合:
  1. [自分の組織] をクリックします。
  2. 組織の右側にある [設定] をクリックします。
左側のサイドバーの [Developer settings] をクリックします。
左側のサイドバーで、 [GitHub Apps] をクリックします。
新規 GitHub App をクリックします。
[GitHub App 名] に、アプリの名前を入力します。わかりやすく短い名前を選ぶ必要があります。名前は 34 文字より長くすることはできません。アプリでアクションが実行されると、アプリの名前 (小文字に変換され、スペースが - に置き換えられ、特殊文字が置き換えられる) がユーザーインターフェイスに表示されます。たとえば、My APp Näme は my-app-name として表示されます。

名前は GitHub全体で一意である必要があります。既存の GitHub アカウントと同じ名前は、自分のユーザー名または組織名でない限り使用できません。
必要に応じて、[説明] にアプリの説明を入力します。アプリのインストール時に、この説明がユーザーに表示されます。
[ホームページの URL] に、アプリのウェブサイトの完全な URL を入力します。専用 URL がなく、アプリのコードがパブリックリポジトリに格納されている場合は、そのリポジトリ URL を使用できます。または、アプリを所有するアカウントの URL を使うこともできます。
必要に応じて、[コールバック URL] に、ユーザーがインストールを承認した後にリダイレクトされる URL を完全な形で入力します。

コールバック URL は最大 10 個入力できます。さらにコールバック URL を追加するには、 [コールバック URL の追加] をクリックします。

アプリがユーザーの代わりに動作する必要がない (ユーザーアクセストークンを生成する必要がない) 場合、このフィールドは無視されます。アプリで Web アプリケーションフローではなくデバイスフローを使用してユーザーアクセストークンを生成する場合、このフィールドは無視されます。

コールバック URL の詳細については、「ユーザー承認コールバック URL について」を参照してください。ユーザーの代わりに動作するユーザーアクセストークンの生成の詳細については、「ユーザーに代わってGitHub アプリで認証する」と「GitHub アプリのユーザーアクセストークンの生成」を参照してください。
必要に応じて、ユーザーアクセストークンの有効期限が切れないようにするには、 [ユーザー承認トークンの期限切れ] の選択を解除します。 GitHub このオプションは選択したままにすることを強くお勧めします。期限切れトークンの更新と、有効期限が切れるユーザーアクセストークンの利点の詳細については、「ユーザーアクセストークンを更新する」を参照してください。アプリでユーザーアクセストークンを生成する必要がない場合、このフィールドは無視されます。
必要に応じて、アプリのインストール時にユーザーに承認を求めるメッセージを表示するには、 [インストール中にユーザー承認 (OAuth) を要求する] を選びます。ユーザーがアプリを認可した場合、アプリでそのユーザーに代わって API 要求を行い、アプリアクティビティをユーザーに属性付けるために、ユーザーアクセストークンを生成できます。詳細については、「ユーザーに代わってGitHub アプリで認証する」および「GitHub アプリのユーザーアクセストークンの生成」を参照してください。
必要に応じて、デバイスフローを使用してユーザーアクセストークンを生成する場合は、 [デバイスフローを有効にする] を選択します。詳しくは、「GitHub アプリのユーザーアクセストークンの生成」をご覧ください。
必要に応じて、[セットアップ URL] に、アプリのインストール後にユーザーをリダイレクトする URL を入力します。インストール後に追加のセットアップが必要な場合は、この URL を使用して、インストール後に行う手順をユーザーに伝えることができます。詳しくは、「セットアップ URL について」をご覧ください。

前の手順で [インストール中にユーザー承認 (OAuth) を要求する] を選んだ場合、ここに URL を入力することはできません。代わりに、ユーザーは承認フローの一部としてコールバック URL にリダイレクトされます。ここで、追加のセットアップを説明できます。
必要に応じて、インストールの更新後にユーザーをセットアップ URL にリダイレクトする場合は、 [更新時にリダイレクト] を選択します。更新には、インストール用のリポジトリの追加または削除が含まれます。 [セットアップ URL] が空白の場合、これは無視されます。
必要に応じて、アプリで Webhook イベントを受信しないようにする場合は、 [アクティブ] の選択を解除します。たとえば、アプリが認証にのみ使用されるか、Webhook に応答する必要がない場合は、このオプションの選択を解除します。詳しくは、「GitHub Apps での Webhook の使用」をご覧ください。
前の手順で [アクティブ] を選択した場合は、[Webhook URL] に、webhook イベントの送信先 GitHub URL を入力します。詳しくは、「GitHub Apps での Webhook の使用」をご覧ください。
必要に応じて、前の手順で [アクティブ] を 選択した場合は、[Webhook シークレット] に、Webhook をセキュリティで保護するためのシークレットトークンを入力します。 GitHub Webhook シークレットを設定することを強く推奨しています。詳しくは、「GitHub Apps での Webhook の使用」をご覧ください。
Webhook URL を入力した場合は、[SSL 検証] で、SSL 検証を有効にするかどうかを選びます。 GitHub SSL 検証を有効にすることを強くお勧めします。
[アクセス許可] で、アプリに必要なアクセス許可を選びます。アクセス許可ごとに、ドロップダウンメニューを選び、 [読み取り専用] 、 [読み取りおよび書き込み] 、または [アクセス権なし] をクリックします。アプリに必要な最小限のアクセス許可を選ぶ必要があります。詳しくは、「GitHub アプリのアクセス許可の選択」をご覧ください。
前の手順で [アクティブ] を選び、アプリで Webhook イベントを受信する必要があることを示した場合は、[イベントのサブスクライブ] で、アプリで受信する Webhook イベントを選びます。前の手順で選んだアクセス許可によって、使用できる Webhook イベントが決まります。各 Webhook イベントの詳細については、「Webhook のイベントとペイロード」を参照してください。
[この GitHub App をインストールできる場所] で、[ このアカウントのみ ] または [ 任意のアカウント] を選択します。インストールオプションの詳細については、 AUTOTITLE を参照してください。
[GitHub Appの作成] をクリックします。

次のステップ

GitHub Appを登録したら、GitHub Appに何かを行うコードを記述します。コードを書く方法の例については、次を参照してください。

ベストプラクティスに従うようにする必要があります。詳しくは、「GitHub アプリを作成するためのベストプラクティス」をご覧ください。

GitHub Appが完全に構築されたら、GitHub Appをインストールし、GitHub Appを他のユーザーと共有できます。詳細については、「独自のGitHub アプリのインストール」および「GitHub App の共有」を参照してください。

GitHub Appの設定はいつでも変更できます。詳しくは、「GitHub アプリの登録の変更」をご覧ください。

この記事で

登録について GitHub Apps

GitHub App を登録する

次のステップ