Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

GitHub 連携

最終更新 Markdown で表示Agent セットアップ

Cloudflare は GitHub リポジトリを Cloudflare Worker に接続できます。変更をプッシュするたびに、コードを自動でデプロイします。

機能

自動ビルドとデプロイに加えて、Cloudflare の GitHub 連携では GitHub 上でビルドを直接監視できます。ワークフローを離れずに状況を把握できます。

プルリクエストへのコメント

コミットがプルリクエスト上にある場合、Cloudflare はビルドのステータスをプルリクエストに自動でコメントします。

GitHub のプルリクエストコメント

wrangler versions upload を実行するビルドには、プレビュー URL が付きます。プルリクエストのレビュー時に、コードの差分と更新後の Worker を並べて確認できて便利です。

コメント履歴では、PR が開いている間に完了した以前のビルドを確認できます。

GitHub のプルリクエストコメント履歴

チェック実行

1 つまたは複数の Worker をリポジトリに接続している場合(モノレポ など)、GitHub のチェック実行 で各ビルドの状態を GitHub 上で確認できます。

GitHub リポジトリ内のコミット横のステータスアイコンを選ぶと、チェックを確認できます。次の例では、緑のチェックマークを選ぶとチェック実行の結果を見られます。

GitHub のステータス

リポジトリでは、チェック実行は次のように表示されます。Details を選ぶと、各チェックに紐づくビルド(Build ID)とプロジェクト(Script)を確認できます。

GitHub のチェック実行

ビルドウォッチパス を使う場合、ビルドがトリガーされたプロジェクトだけがチェック実行を生成します。

アクセスの管理

Cloudflare Workers & Pages GitHub App を使うと、GitHub 上の会社プロジェクトや個人プロジェクトから Cloudflare Workers にデプロイできます。

組織へのアクセス

GitHub アカウントへのアクセスを Cloudflare Workers に許可するとき、個人アカウントか、所属する GitHub の組織かを指定できます。

組織に Cloudflare Workers のインストールを追加するには、ユーザーアカウントがその組織のオーナーであるか、適切なロール(GitHub Apps Manager ロールなど)を持っている必要があります。これらのロールの詳細は GitHub のドキュメント を参照してください。

アクセスの削除

GitHub の Applications ページ で、Cloudflare Workers の GitHub リポジトリまたはアカウントへのアクセスを削除できます(組織の場合は Switch settings context を選んで GitHub の組織設定に切り替えます)。GitHub App の名前は Cloudflare Workers and Pages で、Workers と Pages のプロジェクトで共有されています。

GitHub リポジトリへの Cloudflare のアクセスを削除する

個別の GitHub リポジトリへのアクセスを削除するには、Repository access に移動します。Only select repositories を選び、Cloudflare にアクセスを許可するリポジトリを設定します。

GitHub の Repository Access

GitHub アカウント全体への Cloudflare のアクセスを削除する

GitHub アカウント全体から Cloudflare Workers and Pages のアクセスを削除するには、Uninstall "Cloudflare Workers and Pages" に移動し、Uninstall を選びます。Cloudflare Workers and Pages アプリへのアクセスを削除すると、その GitHub アカウントの すべてのリポジトリ への Cloudflare のアクセスが取り消されます。自動ビルドとデプロイだけを無効にする場合は、ビルドを無効にする の手順に従ってください。

GitHub へのアクセスを削除すると、それらのリポジトリに接続していた Workers と Pages プロジェクトの新規ビルドは無効になります。既存のデプロイは、引き続き Cloudflare Workers でホストされます。

Cloudflare GitHub App の再インストール

Git 連携に関する問題が起きたときは、Cloudflare Pages のインストールに紐づく GitHub または GitLab アプリをアンインストールして再インストールすると、トラブルシューティングになることがあります。各 Git プロバイダーの手順は次のとおりです。

  1. GitHub のインストール設定ページを開きます。
    • Workers または Pages プロジェクトの Settings > Builds に移動し、Git Repository の Manage を選びます。
    • または、次のリンクから Cloudflare Workers and Pages のインストールを探し、Configure を選びます。
個人 https://github.com/settings/installations
組織 https://github.com/organizations/<YOUR_ORGANIZATION_NAME>/settings/installations
  1. Cloudflare Workers and Pages GitHub App の設定ページで、Uninstall "Cloudflare Workers and Pages" に移動し、Uninstall を選びます。
  2. Workers & Pages の概要 に戻ります。Create application > Pages > Connect to Git を選択します。
  3. + Add account を選び、追加する GitHub アカウントを選んでから Install & Authorize を選択します。
  4. プロジェクト作成ページにリダイレクトされ、アカウント一覧に GitHub アカウントまたは組織が表示されます。
  5. 以前壊れていたプロジェクトで、新しいデプロイを試します。

役に立ちましたか?