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 (pull_request)
        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

- uses: tj-actions/vercel-wait@v1
  id: vercel-wait
  with:
    # Delay in seconds
    # Type: string
    # Default: "5"
    delay: ''

    # Vercel project id can be 
    # obtained from `https://vercel.com/<team>/<project>/settings` 
    # Type: string
    project-id: ''

    # The commit sha to wait 
    # for 
    # Type: string
    sha: ''

    # Vercel team id can be 
    # obtained from `https://vercel.com/teams/<team>/settings` 
    # Type: string
    team-id: ''

    # Timeout in seconds
    # Type: string
    # Default: "600"
    timeout: ''

    # Vercel token can be obtained 
    # from https://vercel.com/account/tokens 
    # Type: string
    token: ''

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

• Free software: MIT license

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

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.