README.md

Cloudflare Workers PR Preview

A GitHub action that previews cloudflare workers in workers.dev for your pull requests.

Pros

Compare to Netlify/Vercel?

• It is free.
• It supports multiple preview jobs.

Usage

Add a workflow (.github/workflows/preview.yml):

name: Workers PR Preview

on: [pull_request]

jobs:
  preview_app1:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shidil/cloudflare-workers-preview@v1
        id: preview_step
        with:
          cf_token: ${{ secrets.CF_API_TOKEN }}
          cf_account: ${{ secrets.CF_ACCOUNT_ID }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          domain: shidil.workers.dev
          project_path: apps/app1
          build: |
            npm install
            npm run build
      - name: Get the preview_url
        run: echo "url => ${{ steps.preview_step.outputs.preview_url }}"

The preview website url will be https://{{job.name}}-pr-{{pr.number}}.{{domain}}.

Multiple Jobs

name: Workers PR Preview

on: [pull_request]

jobs:
  preview-job-1:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shidil/cloudflare-workers-preview@v1
        with:
          cf_token: ${{ secrets.CF_API_TOKEN }}
          cf_account: ${{ secrets.CF_ACCOUNT_ID }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          domain: shidil.workers.dev
          project_path: apps/app1
          build: |
            npm install
            npm run build
  preview-job-2:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shidil/cloudflare-workers-preview@v1
        with:
          cf_token: ${{ secrets.CF_API_TOKEN }}
          cf_account: ${{ secrets.CF_ACCOUNT_ID }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          domain: shidil.workers.dev
          project_path: apps/app1
          build: |
            npm install
            npm run build

The preview website urls will be:

• https://preview-job-1-pr-{{pr.number}}.shidil.workers.dev
• https://preview-job-2-pr-{{pr.number}}.shidil.workers.dev

Teardown

When a pull request is closed and teardown is set to 'true', then the workers script will be destroyed.

name: Workers PR Preview

on:
  pull_request:
    # when using teardown: 'true', add default event types + closed event type
    types: [opened, synchronize, reopened, closed]
  push:

jobs:
  preview:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shidil/cloudflare-workers-preview@v1
        with:
          cf_token: ${{ secrets.CF_API_TOKEN }}
          cf_account: ${{ secrets.CF_ACCOUNT_ID }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          domain: shidil.workers.dev
          teardown: 'true'
          build: |
            npm install
            npm run build

Inputs

• cf_token: Getting your token.
• cf_account: Your Cloudflare account Id.
• github_token: secrets.GITHUB_TOKEN.
• domain: domain name configured for your Workers account.
• build: build scripts to run before deploy.
• project_path: wrangler project path.
• failOnError: Set failed if a deployment throws error, defaults to false.
• teardown: Determines if the preview instance will be torn down on PR close, defaults to false.

Outputs

• preview_url: The url for the related PR preview

Thanks to

• afc163/surge-preview

License