README.md

CF Pages Await

Wait for a Cloudflare Pages build to finish before sending a Slack notification

Usage

name: Deploy
on: push
jobs:
  build:
    runs-on: ubuntu-latest
    # Allow GITHUB_TOKEN to write deployments for my action (https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
    permissions:
      contents: read
      deployments: write
    steps:
    - name: Await CF Pages
      uses: WalshyDev/cf-pages-await@v1
      with:
        # Uncomment these two lines if you wish to use the Global API Key (Not recommended!)
        # accountEmail: ${{ secrets.CF_ACCOUNT_EMAIL  }}
        # apiKey: ${{ secrets.CF_API_KEY  }}

        # Use an API token (Recommended!)
        apiToken: ${{ secrets.CF_API_TOKEN }}

        accountId: '4e599df4216133509abaac54b109a647'
        project: 'example-pages-project'
        # Add this if you want GitHub Deployments (see below)
        githubToken: ${{ secrets.GITHUB_TOKEN }}
        # Slack webhook
        slackWebHook: 'https://hooks.slack.com/service/...'
        # Add this if you want to wait for a deployment triggered by a specfied commit
        commitHash: ${{ steps.push-changes.outputs.commit-hash }}

Outputs

• id - Deployment ID, example: 50ff553c-da5d-4846-8188-25ae82a3bb7d
• environment - Environment for this deployment, either production or preview
• url - URL for this deployment
• alias - Alias URL (Will be the branch URL such as fix-issue.project.pages.dev or be the deployment URL)
• success - If the deployment was successful

GitHub Deployments

GitHub Deployments will show if the deployment was successful or failed right inside GitHub! You can easily see the status, view the website (exact deployment) and see the logs.

Note: You need to add the githubToken input in order for deployments to work!

Overview

Pull Requests

In Progress

Successful