前提条件
GitHub App のコードを記述する前に、GitHub App を登録する必要があります。 GitHub App を登録する際に、アプリのアクセス許可を選択します。 これらのアクセス許可によって、GitHub App が実行できる内容が決まります。 アプリを登録するときに、GitHub App が受け取る Webhook イベントなど、他の設定も指定します。 GitHub App 登録の設定はいつでも変更できます。 詳細については、「GitHub App の登録」および「GitHub App 登録の変更」を参照してください。
GitHub App でリポジトリや組織のデータにアクセスする場合は、GitHub App をインストールする必要があります。 詳しくは、「独自の GitHub App のインストール」を参照してください。
GitHub App のコードの記述
GitHub App で何かを行うには、コードを記述して GitHub App に機能を追加する必要があります。
GitHub App のコードを記述する方法に関するチュートリアルについては、次を参照してください。
- GitHub Apps を構築するためのクイック スタート
- Webhook イベントに応答する GitHub App の構築
- GitHub App を使って [Login with GitHub] ボタンを作成する
- GitHub アプリを使用して CLI を構築する
GitHub App 登録の資格情報を使って、GitHub の API に対して認証された要求を行うことができます。 詳しくは、「GitHub アプリでの認証について」を参照してください。
開発中は、おそらくご自分のパーソナル コンピューターや codespace を使って GitHub App を実行します。 開発中に、GitHub App 登録にいくつかの変更を加える必要がある場合があります。
-
アプリが Webhook を受け取る場合は、Webhook プロキシ URL を使って、GitHub からコンピューターまたは codespace に Webhook を転送することができます。 Webhook プロキシ URL を使用するには、GitHub App 登録の "Webhook URL" 設定を更新する必要があります。 例については、「Webhook イベントに応答する GitHub App の構築」をご覧ください。
-
アプリで Web アプリケーション フローを使ってユーザーを承認する場合は、GitHub App 登録の "コールバック URL" 設定を更新して、ローカル コールバック URL を使うことができます。 例については、「GitHub App を使って [Login with GitHub] ボタンを作成する」をご覧ください。
次のステップ
GitHub App のコードを記述したら、ベスト プラクティスに従っていることを確認する必要があります。 必要な場合は、忘れずに GitHub App 登録を更新してください。 GitHub App をユーザーのデバイスではなくサーバー上で実行する必要がある場合は、サーバーにアプリをデプロイします。 最後に、GitHub App を他のユーザーや組織と共有できます。
ベスト プラクティスに従う
GitHub App をデプロイする前に、ベスト プラクティスに従っていることを確認してください。 たとえば、GitHub App の資格情報がセキュリティで保護されていることを確認します。 詳しくは、「GitHub App を作成するためのベスト プラクティス」を参照してください。
GitHub App 登録を更新する
開発用に GitHub App 登録を変更した場合は、運用環境に対応した値を使うように必ず登録を更新してください。 たとえば、開発用の Webhook プロキシ URL を使った場合は、運用環境で GitHub App が Webhook を受信する URL を使うように "Webhook URL" フィールドを更新する必要があります。
GitHub App をデプロイする
GitHub App のコードを記述したら、どこかでコードを実行する必要があります。 アプリが Web サイトまたは Web アプリの場合は、Azure App Service などのサーバー上でアプリをホストできます。 アプリがクライアント側アプリの場合は、ユーザーのデバイス上で実行できます。
GitHub App を共有する
GitHub App を他のユーザーや組織と共有する場合は、GitHub App をパブリックにする必要があります。 詳しくは、「GitHub App の共有」をご覧ください。