GitHub アプリのコードの記述について

GitHub Appに機能を追加するコードを記述する必要があります。

この記事で

前提条件

GitHub Appのコードを記述する前に、GitHub Appを登録する必要があります。 GitHub Appを登録するときに、アプリのアクセス許可を選択します。 これらのアクセス許可によって、 GitHub App が実行できる内容が決まります。 アプリを登録するときに、 GitHub App が受け取る Webhook イベントなど、他の設定も指定します。 GitHub App登録の設定はいつでも変更できます。 詳細については、「GitHub アプリの登録」および「GitHub アプリの登録の変更」を参照してください。

GitHub Appがリポジトリや組織のデータにアクセスできるようにするには、GitHub Appをインストールする必要があります。 詳しくは、「独自のGitHub アプリのインストール」をご覧ください。

GitHub App のコードを記述する

GitHub Appが何かを行うには、GitHub Appに機能を追加するコードを記述する必要があります。

GitHub Appのコードを記述する方法のチュートリアルについては、次を参照してください。

GitHub App登録の資格情報を使用して、GitHubの API に対して認証された要求を行うことができます。 詳しくは、「GitHub アプリでの認証について」をご覧ください。

開発中は、パーソナル コンピューターまたはコードスペースを使用して GitHub Appを実行する可能性があります。 開発中に、 GitHub App の登録にいくつかの変更を加える必要がある場合があります。

  • アプリが webhook を受け取る場合は、webhook プロキシ URL を使用して、webhook をGitHubからコンピューターまたはコードスペースに転送することができます。 GitHub App の登録で "Webhook URL" 設定を Webhook プロキシ URL を使用するように更新する必要があります。 例については、「AUTOTITLE」を参照してください。

  • アプリで Web アプリケーション フローを使用してユーザーを承認する場合は、ローカル コールバック URL を使用するように、 GitHub App 登録の [コールバック URL] 設定を更新できます。 例については、「AUTOTITLE」を参照してください。

次のステップ

GitHub Appのコードを記述したら、ベスト プラクティスに従っていることを確認する必要があります。 必要に応じて、 GitHub App の登録を忘れずに更新してください。 ユーザーのデバイスではなくサーバーで GitHub App を実行する必要がある場合は、アプリをサーバーにデプロイします。 最後に、他のユーザーや組織と GitHub App を共有できます。

ベスト プラクティスに従う

GitHub Appをデプロイする前に、ベスト プラクティスに従っていることを確認してください。 たとえば、 GitHub Appの資格情報がセキュリティで保護されていることを確認します。 詳しくは、「GitHub アプリを作成するためのベスト プラクティス」をご覧ください。

GitHub Appの登録を更新する

開発用の GitHub App 登録を変更した場合は、必ず、実稼働対応の値を使用するように登録を更新してください。 たとえば、開発に Webhook プロキシ URL を使用した場合は、運用環境で GitHub App が Webhook を受信する URL を使用するように "Webhook URL" フィールドを更新する必要があります。

GitHub App をデプロイ

GitHub Appのコードを記述したら、コードをどこかで実行する必要があります。 アプリが Web サイトまたは Web アプリの場合は、Azure App Service</c0 などのサーバーでアプリをホスト>。 アプリがクライアント側アプリの場合は、ユーザーのデバイス上で実行できます。

あなたのGitHub Appを共有する

GitHub Appを他のユーザーや組織と共有する場合は、GitHub Appをパブリックにする必要があります。

GitHub Appを見つけやすくするために、GitHub MarketplaceにGitHub Appを一覧表示できます。 詳細については、 AUTOTITLE を参照してください。