Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

GitHub App を作成する

個人アカウントの下で、あるいは管理アクセス権を持っているOrganizationの下で、GitHub Appを作成し、登録できます。

構成済みの GitHub App を作成できる GitHub App Manifest の使い方については、「マニフェストから GitHub App を作成する」を参照してください。

ノート: ユーザもしくはOrganizationは、最大で100個のGitHub Appsを所有できます。

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

    • For a GitHub App owned by a personal account, in the upper-right corner of any page, click your profile photo, then click Settings. ユーザバーの [Settings(設定)] アイコン
    • Organizationが所有するGitHub Appの場合、任意のページの右上でプロフィール写真をクリックしてから、Your organizations(自分のOrganization)をクリックしてください。 そして、Organizationの右のSettings(設定)をクリックしてください。 プロフィールメニューのあなたのOrganization 設定ボタン
  2. In the left sidebar, click Developer settings.

  3. 左のサイドバーでGitHub Appsをクリックしてください。 GitHub Apps セクション

  4. [New GitHub App] をクリックします。 新しい GitHub App を作成するボタン

  5. [GitHub App name] に、アプリケーションの名前を入力します。 GitHub App の名前フィールド

    アプリケーションには簡潔で明快な名前を付けましょう。 アプリケーションの名前は、既存の GitHub アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名や Organization 名である場合は例外です。 インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。

  6. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Description] に入力します。 GitHub App の説明フィールド

  7. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 GitHub App のホームページ URL フィールド

  8. [Callback URL] に、ユーザがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。

    [Add callback URL] を使用して、コールバック URL を最大 10 個追加できます。

    [Add callback URL] のボタンと コールバック URL のフィールド

  9. デフォルトでは、アプリケーションのセキュリティを高めるため、アプリケーションは期限付きのユーザ認可トークンを使用します。 期限付きのユーザトークンの使用をオプトアウトするには、[Expire user authorization tokens] の選択を解除する必要があります。 リフレッシュトークンフローの設定と、期限付きユーザトークンの利点に関する詳細については、「ユーザからサーバーに対するアクセストークンをリフレッシュする」を参照してください。 GitHub App のセットアップ中に期限付きユーザトークンをオプトインするオプション

  10. アプリケーションが OAuth フローを使用してユーザを認可する場合、[Request user authorization (OAuth) during installation] を選択して、ユーザーかアプリをインストール時に認可するようにできます。 このオプションを選択した場合、[Setup URL] が利用できなくなり、アプリケーションのインストール後にユーザはあなたが設定した [User authorization callback URL] にリダイレクトされます。 詳しい情報については「インストール中にユーザを認可する」を参照してください。 Request user authorization during installation

  11. If your GitHub App will use the device flow to identify and authorize users, click Enable Device Flow. For more information about the device flow, see "Authorizing OAuth Apps." Screenshot showing field for enabling device flow

  12. インストール後に追加の設定が必要な場合、[Setup URL] を追加して、アプリケーションをインストールした後にユーザをリダイレクトします。 GitHub App のセットアップ URL フィールド

    注釈: 前のステップで [Request user authorization (OAuth) during installation] を選択した場合、このフィールドは利用できなくなり、アプリケーションのインストール後にユーザは [User authorization callback URL] にリダイレクトされます。

  13. [Webhook URL] に、イベントが POST する URL を入力します。 各アプリケーションは、アプリケーションがインストールまたは変更されたり、アプリケーションがサブスクライブしているその他のイベントが発生したりするたびに、アプリケーションで設定した webhook を受信します。 GitHub App の webhook URL フィールド

  14. 必要に応じて、webhook を保護するための、オプションのシークレットトークンを [Webhook Secret] に入力します。 webhook にシークレットトークンを追加するフィールド

    注釈: シークレットトークンは、設定することを強くお勧めします。 詳しい情報については「webhookをセキュアにする」を参照してください。

  15. [Permissions] で、アプリケーションが要求する権限を選択します。 権限の各タイプで、ドロップダウンメニューを使用して [Read-only]、[Read & write]、または[No access] をクリックします。 GitHub App のさまざまな権限

  16. [Subscribe to events] で、アプリケーションが受け取るイベントを選択します。

  17. アプリケーションをインストールする場所を、[Only on this account] (このアカウントのみ) と [Any account] (すべてのアカウント) から選びます。 これらのオプションに関する詳しい情報については、「GitHub App をパブリックまたはプライベートにする」を参照してください。 GitHub App のインストールオプション

  18. [Create GitHub App] をクリックします。 GitHub App を作成するボタン