GitHub App の登録

GitHub App は、個人用アカウント 、自分が所有する組織、Enterprise で登録できます。

この記事の内容

GitHub Apps

の登録について

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

  • 個人用アカウント配下

  • 自分が所有する組織配下

  • 全アプリを管理する権限を付与した組織の配下 「Organization の GitHub App マネージャーを追加および削除する」をご覧ください。

  • ただし、Enterprise では Enterprise 内の組織にのみインストールできます。

    Note

    Enterprise が所有する GitHub Apps は パブリック プレビュー 段階であり、変更される可能性があります。

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

GitHub App の登録

  1. GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。

  2. アカウント設定にアクセスしてください。

    • 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
    • 組織が所有するアプリの場合:
      1. [自分の組織] をクリックします。
      2. 組織の右側にある [設定] をクリックします。
    • Enterprise が所有するアプリの場合:
      1. Enterprise Managed Users を使用する場合は、[Enterprise] をクリックして Enterprise アカウントの設定に移動します。
      2. 個人用アカウントを使用する場合は、[Enterprise] をクリックしてから、Enterprise の右側にある [設定] をクリックします。

  3. GitHub App 設定にアクセスしてください。

    • 個人用アカウントまたは組織が所有するアプリの場合:
      1. 左側のサイドバーで、 [開発者向け設定] をクリックし、 [GitHub Apps] をクリックします。
    • Enterprise が所有するアプリの場合:
      1. 左側のサイドバーで、 [設定] から GitHub Apps をクリックします。

  4. [新しい GitHub App] をクリックします。

  5. [GitHub App 名] に、アプリの名前を入力します。 わかりやすく短い名前を選ぶ必要があります。 名前は 34 文字より長くすることはできません。 アプリでアクションが実行されると、アプリの名前 (小文字に変換され、スペースが - に置き換えられ、特殊文字が置き換えられる) がユーザー インターフェイスに表示されます。 たとえば、My APp Näme は my-app-name として表示されます。

    名前は GitHub 全体で一意である必要があります。 既存の GitHub アカウントと同じ名前を使用することはできません。ただし、それがあなた自身のユーザー名や組織名である場合は例外です。

  6. 必要に応じて、[説明] にアプリの説明を入力します。 ユーザーと Organization には、アプリのインストール時にこの説明が表示されます。

  7. [ホームページの URL] に、アプリのウェブサイトの完全な URL を入力します。 専用 URL がなく、アプリのコードがパブリック リポジトリに格納されている場合は、そのリポジトリ URL を使用できます。 または、アプリを所有する Organization またはユーザーの URL を使用できます。

  8. 必要に応じて、[コールバック URL] に、ユーザーがインストールを承認した後にリダイレクトされる URL を完全な形で入力します。

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

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

    コールバック URL について詳しくは、「ユーザー承認コールバック URL について」を参照してください。 ユーザーの代わりに動作するユーザー アクセス トークンの生成について詳しくは、「ユーザーに代わって GitHub アプリで認証する」と「GitHub アプリのユーザー アクセス トークンの生成」を参照してください。

  9. 必要に応じて、ユーザー アクセス トークンの有効期限が切れないようにするには、 [ユーザー承認トークンの期限切れ] の選択を解除します。 GitHub では、このオプションを選択したままにすることを強くお勧めします。 期限切れトークンの更新と、有効期限が切れるユーザー アクセス トークンの利点について詳しくは、「ユーザー アクセス トークンを更新する」を参照してください。 アプリでユーザー アクセス トークンを生成する必要がない場合、このフィールドは無視されます。

  10. 必要に応じて、アプリのインストール時にユーザーに承認を求めるメッセージを表示するには、 [インストール中にユーザー承認 (OAuth) を要求する] を選びます。 ユーザーがアプリを認可した場合、アプリでそのユーザーに代わって API 要求を行い、アプリ アクティビティをユーザーに属性付けるために、ユーザー アクセス トークンを生成できます。 詳細については、「ユーザーに代わって GitHub アプリで認証する」および「GitHub アプリのユーザー アクセス トークンの生成」を参照してください。

  11. 必要に応じて、デバイス フローを使用してユーザー アクセス トークンを生成する場合は、 [デバイス フローを有効にする] を選択します。 詳しくは、「GitHub アプリのユーザー アクセス トークンの生成」を参照してください。

  12. 必要に応じて、[セットアップ URL] に、アプリのインストール後にユーザーをリダイレクトする URL を入力します。 インストール後に追加のセットアップが必要な場合は、この URL を使用して、インストール後に行う手順をユーザーに伝えることができます。 詳しくは、「セットアップ URL について」を参照してください。

    前の手順で [インストール中にユーザー承認 (OAuth) を要求する] を選んだ場合、ここに URL を入力することはできません。 代わりに、ユーザーは承認フローの一部としてコールバック URL にリダイレクトされます。ここで、追加のセットアップを説明できます。

  13. 必要に応じて、インストールの更新後にユーザーをセットアップ URL にリダイレクトする場合は、 [更新時にリダイレクト] を選択します。 更新には、インストール用のリポジトリの追加または削除が含まれます。 [セットアップ URL] が空白の場合、これは無視されます。

  14. 必要に応じて、アプリで Webhook イベントを受信しないようにする場合は、 [アクティブ] の選択を解除します。 たとえば、アプリが認証にのみ使用されるか、Webhook に応答する必要がない場合は、このオプションの選択を解除します。 詳しくは、「GitHub Apps での Webhook の使用」を参照してください。

  15. 前の手順で [アクティブ] を選択した場合は、[Webhook URL] に、GitHub が Webhook イベントを送信する必要がある URL を入力します。 詳しくは、「GitHub Apps での Webhook の使用」を参照してください。

  16. 必要に応じて、前の手順で [アクティブ] を 選択した場合は、[Webhook シークレット] に、Webhook をセキュリティで保護するためのシークレット トークンを入力します。 GitHub では、Webhook シークレットを設定することを強くお勧めします。 詳しくは、「GitHub Apps での Webhook の使用」を参照してください。

  17. Webhook URL を入力した場合は、[SSL 検証] で、SSL 検証を有効にするかどうかを選びます。 GitHub では、SSL 検証を有効にすることを強くお勧めします。

  18. [アクセス許可] で、アプリに必要なアクセス許可を選びます。 アクセス許可ごとに、ドロップダウン メニューを選び、 [読み取り専用] 、 [読み取りおよび書き込み] 、または [アクセス権なし] をクリックします。 アプリに必要な最小限のアクセス許可を選ぶ必要があります。 詳しくは、「GitHub アプリのアクセス許可を選択する」を参照してください。

  19. 前の手順で [アクティブ] を選び、アプリで Webhook イベントを受信する必要があることを示した場合は、[イベントのサブスクライブ] で、アプリで受信する Webhook イベントを選びます。 前の手順で選んだアクセス許可によって、使用できる Webhook イベントが決まります。 各 Webhook イベントについて詳しくは、「Webhook のイベントとペイロード」を参照してください。

  20. [この GitHub App アプリをインストールできる場所] で、[このアカウントのみ] または [任意のアカウント] を選択します。Enterprise Managed Users を使用する場合、ユーザー アカウントに対して [このアカウントのみ] が無効になります。 [任意のアカウント] の代わりに、[この Enterprise] というオプションが表示されます。インストール オプションの詳細については、「GitHub Appをパブリックまたはプライベートにする」を参照してください。

    Note

    GitHub App が Enterprise に登録されている場合、この手順は適用されません。

  21. [GitHub App を作成する] をクリックします。

次のステップ

GitHub App を登録した後は、GitHub App に何かを実行させるコードを書くことになります。 コードを書く方法の例については、次を参照してください。

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

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

GitHub App の設定はいつでも変更できます。 詳しくは、「GitHub App 登録の変更」を参照してください。