Cloudflare Pages Deploy Action

Deploys your Cloudflare Pages project, enabling you to integrate Pages into your existing CI pipeline using the following features:

• Deploy your production branch or any other branch
• Deploy preview environments for every pull request
• Defer deployment until other stages/steps have passed (e.g. tests)
• Perform actions after successful deployment (e.g. purge cache)
• Track deployment status from within GitHub Actions
• Create GitHub deployments for your Pages deployments

Inputs

Be sure to use a secure method such as Encrypted Secrets for storing/accessing Cloudflare API Key:

Name		Description
account-id	Required	Your Cloudflare account id. This is the id in the URL of Cloudflare's dashboard. You can also run the command wrangler whoami .
api-key	yes	Your Cloudflare Global API Key (Pages does not accept API tokens).
email	yes	The email associated with your Cloudflare account.
project-name	yes	The name of your Pages project.
branch	no	Triggers a Pages deployment for the provided branch. Cannot be set if production or preview are set. If neither branch, production, nor preview are set, the deployment branch will be determined from the workflow github context (raising an error if not triggered by a pull request).
production	no	If true, triggers a production Pages deployment. Cannot be set if preview or branch are set.
preview	no	If true, triggers a Pages deployment for the branch of the current pull request. Cannot be set if production or branch are set. Deployment branch will be derived from the workflow github context (raising an error if not triggered by a pull request).
github-token	no	GitHub access token. If provided, triggers a GitHub deployment with the status of the Pages deployment. If using the Actions provided GITHUB_TOKEN, deployments will only work if the current repo is associated with the target Pages project.

Outputs

Name	Description
deployment-id	Unique identifier of the deployment created by the action.
deployment-url	Even though this action deploys the production branch, this will be the the build-specific pages URL (e.g. https://a6975138.example-site.pages.dev).

Example

Deploy your production environment:

name: Deploy to production

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          production: true
        env:
          CF_ACCOUNT_ID: 752b6dba29604163bde5b5b90f042f62
          PAGES_PROJECT_NAME: my-pages-project

Deploy preview environments for all pull requests:

name: Deploy preview

on:
  pull_request:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          preview: true
          github-token: ${{ secrets.GITHUB_TOKEN }}
        env:
          CF_ACCOUNT_ID: 752b6dba29604163bde5b5b90f042f62
          PAGES_PROJECT_NAME: my-pages-project

Deploy any branch

name: Deploy to environments

on:
  push:
    branches:
      - qa
      - staging

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          branch: ${{ github.ref_name }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
        env:
          CF_ACCOUNT_ID: 752b6dba29604163bde5b5b90f042f62
          PAGES_PROJECT_NAME: my-pages-project

Or combine all deploys in a single job:

name: CI

on:
  push:
    branches:
      - main
      - staging
      - qa
  pull_request:

  env:
    CF_ACCOUNT_ID: 752b6dba29604163bde5b5b90f042f62
    PAGES_PROJECT_NAME: my-pages-project

  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Deploy preview
        if: ${{ github.event_name == 'pull_request' }}
        uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          preview: true
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Deploy qa/staging
        if: ${{ contains(fromJson('["refs/heads/qa", "refs/heads/staging"]'), github.ref) && github.event_name == 'push' }}
        uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          branch: ${{ github.ref_name }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Deploy production
        if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' }}
        uses: tomjschuster/cloudflare-pages-deploy-action@v0
        with:
          account-id: '${{ env.CF_ACCOUNT_ID }}'
          project-name: '${{ env.PAGES_PROJECT_NAME }}'
          api-key: '${{ secrets.CF_GLOBAL_APIKEY }}'
          email: '${{ secrets.CF_EMAIL }}'
          production: true
          github-token: ${{ secrets.GITHUB_TOKEN }}

License

The scripts and documentation in this project are released under the MIT License.