Vercel deployment URLs

This repository contains a GitHub action that uses the Vercel API to find the latest deployment for the current commit. It waits for the deployment to be done and then outputs the URL.

Envs

GITHUB_TOKEN

Required A token to authenticate requests sent to the GitHub API. You can use the one that is automatically added to your workflow run.

VERCEL_TOKEN

Required A token to authenticate requests sent to the Vercel API. You can create one here.

Inputs

project-id

Required The id of your Vercel project. Usually you can find it in the .vercel/project.json file inside your repository.

team-id

If your Vercel project is owned by a team, you have to input the id of the team. It can also be found in the .vercel/project.json file. If you use the action for a personal Vercel project, don't use this input.

search-retries

The number of retries if no deployment can be found for the current commit. There is a 5 second interval between tries. The default is 3.

ready-retries

The number of retries if the latest deployment found is not ready yet. There is a 30 second interval between tries. The default is 10.

Outputs

url

The URL of the Vercel preview deployment in a READY state.

Example usage

- name: Get deployment URL
  id: deployment
  uses: thomasheyenbrock/vercel-deployment-url@v2
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
  with:
    project-id: ${{ secrets.VERCEL_PROjECT_ID }}

Notes

• The action automatically uses the commit SHA that it runs on to find related Vercel deployments (using deployment metadata). If there are multiple deployments for a single SHA the latest one is taken.
• This action will fail if the Vercel deployment fails or takes too long to complete.
• This action will fail if no Vercel deployment can be found for the latest commit.
• If the latest commit is a merge commit, deployments for previous commits will also be searched recursively. This avoids not finding any deployment due to Vercels deduplication.