Skip to content

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

GitHub 連携

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

Cloudflare Pages の各プロジェクトを GitHub リポジトリに接続できます。ブランチへ変更をプッシュするたびに、Cloudflare がコードを自動デプロイします。

機能

自動デプロイに加えて、Cloudflare の GitHub 連携では、GitHub 上でデプロイの監視、管理、プレビューができます。いつものワークフローから離れずに状況を把握できます。

カスタムブランチ

Pages は、最初にプッシュしたブランチを 本番環境 に設定します。デフォルトブランチ(例: main)以外が本番ブランチの場合は、Settings > Builds > Branch control を開き、Production branch のドロップダウンから別のブランチを選びます。

プレビューデプロイ を使うと、本番ブランチへマージして本番デプロイする前に、プロジェクトの版を確認できます。どのプレビューブランチを自動デプロイするかは、ブランチビルド制御 で設定できます。設定するには、Settings > Builds > Branch control を開き、Preview branch のオプションを選びます。Custom branches では、自動プレビューデプロイに含める、または除外するブランチを指定できます。

プレビュー URL

GitHub リポジトリで新しい pull request を開くたびに、Cloudflare Pages は固有のプレビュー URL を作成します。ブランチへ新しいコミットをプッシュすると、この URL も更新されます。リポジトリのフォークから作成した pull request には、プレビュー URL は作成されません。詳細は プレビューデプロイ を参照してください。

GitHub のプレビュー URL

コミットメッセージでビルドをスキップする

設定なしで、必要に応じてデプロイをスキップできます。コミットメッセージの先頭に [CI Skip][CI-Skip][Skip CI][Skip-CI][CF-Pages-Skip] のいずれかを付けると、Pages はそのデプロイを省略します。プレフィックスの大文字・小文字は区別しません。

Check run

1 つのリポジトリに複数のプロジェクトを接続している場合(モノレポ など)、各ビルドの状態は GitHub check run で GitHub 上から確認できます。

GitHub リポジトリのコミット横にあるステータスアイコンを選ぶと、チェックを確認できます。次の例では、緑のチェックマークを選ぶと check run の結果を表示できます。

GitHub のステータス

リポジトリ上の check run は、次のように表示されます。

GitHub の check run

何らかの理由でビルドがスキップされた場合(CI Skip、ビルドのウォッチパス、ブランチデプロイ制御など)、check run / コミットステータスは表示されません。

アクセスを管理する

GitHub 上の会社プロジェクトや個人プロジェクトから Cloudflare Workers へデプロイするには、Cloudflare Workers & Pages GitHub App を使います。

組織へのアクセス

会社プロジェクトや個人プロジェクトを、GitHub と GitLab のどちらからでも Cloudflare Pages へデプロイできます。

Cloudflare Pages に GitHub アカウントへのアクセスを許可するとき、個人アカウントか、所属する組織かを指定できます。組織へ Cloudflare Pages のインストールを追加するには、ユーザーアカウントがその組織のオーナーであるか、適切なロール(GitHub Apps Manager ロール)を持っている必要があります。ロールの詳細は GitHub のドキュメント を参照してください。

アクセスを削除する

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

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

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

GitHub の Repository Access

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

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

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

Cloudflare GitHub アプリを再インストールする

Cloudflare Pages が git リポジトリにアクセスできないエラーが出る場合は、Cloudflare Pages のインストールに紐づく GitHub アプリケーションをアンインストールしてから再インストールしてください。

  1. GitHub のインストール設定ページを開きます。
    • 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. 以前壊れていたプロジェクトで、新しいデプロイを試します。

役に立ちましたか?