GitHub App のコードの記述について

前提条件

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 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 のコードの記述について

この記事の内容

前提条件