Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
clock

GitHub Action

Vercel Wait for Deployment

v1.1.9

Vercel Wait for Deployment

clock

Vercel Wait for Deployment

Wait for a Vercel deployment to finish

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Vercel Wait for Deployment

              
  uses: tj-actions/[email protected]
Learn more about this action in tj-actions/vercel-wait

Choose a version

CI Update release version. Public workflows that use this action.

vercel-wait

Github action to wait for Vercel's GitHub integration automated deploys to be ready which enables triggering any dependent workflows.

Example for push event

on:
  push:
    branches:
      - main

...
    steps:
      - name: Wait for vercel deployment (push)
        uses: tj-actions/vercel-wait@v1
        with:
          project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          token:  ${{ secrets.VERCEL_TOKEN }}
          sha: ${{ github.sha }}

Example for pull request events

on:
  pull_request:
    branches:
      - main

...
    steps:
      - name: Wait for vercel deployment (push)
        uses: tj-actions/vercel-wait@v1
        with:
          project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          token:  ${{ secrets.VERCEL_TOKEN }}
          sha: ${{ github.event.pull_request.head.sha }}

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
delay string false "10" Delay in seconds
project-id string true Vercel project id can be
obtained from https://vercel.com/<team>/<project>/settings
sha string true The commit sha to wait
for
team-id string false Vercel team id can be
obtained from https://vercel.com/teams/<team>/settings
timeout string false "600" Timeout in seconds
token string true Vercel token can be obtained
from https://vercel.com/account/tokens

Outputs

OUTPUT TYPE DESCRIPTION
deployment-alias-error string The deployment alias error
deployment-id string The deployment id
deployment-state string The deployment state
deployment-url string The deployment url

If you feel generous and want to show some extra appreciation:

Buy me a coffee

Credits

This package was created with Cookiecutter using cookiecutter-action

Report Bugs

Report bugs at https://github.com/tj-actions/vercel-wait/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your workflow that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.