thundermiracle/Get-Vercel-preview-url

Github Action used to get the preview url of a vercel deployment by commit SHA

Get Vercel Preview Url

Github Action used to get the preview url of a vercel deployment for your continuous integration pipeline. Supports the pull_request and push workflow triggers.

Basic usage

Inside your .github/workflows/{your-workflow}.yml file:

- name: Get Vercel Preview URL
  id: get-vercel-preview-url
  uses: ViktorJT/Get-vercel-preview-url@1.2.2
  with:
    vercel_access_token: ${{ secrets.VERCEL_ACCESS_TOKEN }}
    vercel_team_id: ${{ secrets.VERCEL_TEAM_ID }}
    gh_token: ${{ secrets.GITHUB_TOKEN }}

- name: Echo preview
  run: echo "Preview url is ready ${{ steps.get-vercel-preview-url.outputs.preview_url }}"

Inputs

All inputs are added to the action's with property, see the basic example above for reference.

Key	Description	Required
vercel_access_token	Used to authenticate with Vercel Read more	true
vercel_team_id	Used to identify the correct team in Vercel Read more	true
gh_token	Default Github Action environment variable used to authenticate with Github Read more	true
prefix_url	Optional string to prefix the preview URL, defaults to https://	false
prefix_path	Optional string to prefix the path of the preview URL	false
timeout	Time in milliseconds spent waiting between requests to the Vercel REST Api, defaults to 3000ms	false
limit	Pagination limit of the initial request to the Vercel deployments endpoint, defaults to 20 with a max of 100	false

Outputs

the preview url is accessed using the workflow stepId, like so:

steps.{stepId}.outputs.preview_url

Example

This is an example using this action together with Lighthouse Check Action to run analytics on web vitals whenever a pull request triggers a Vercel deployment, and upload a full report as an artifact to the workflow:

name: Performance Audit

on: [pull_request]

jobs:
  audit:
    name: Performance Audit
    runs-on: ubuntu-latest
    steps:
      - name: Create report directory
        run: mkdir -p ${{ github.workspace }}/tmp/artifacts

      - name: Get Vercel Preview URL
        id: vercel-deployment
        uses: ViktorJT/Get-Vercel-preview-url@main
        with:
          vercel_access_token: ${{ secrets.VERCEL_TOKEN }}
          vercel_team_id: ${{ secrets.VERCEL_TEAM_ID }}
          gh_token: ${{ secrets.GITHUB_TOKEN }}

      - name: Run Lighthouse audit on preview urls
        uses: foo-software/lighthouse-check-action@master
        with:
          device: 'all'
          gitHubAccessToken: ${{ secrets.GITHUB_TOKEN }}
          outputDirectory: ${{ github.workspace }}/tmp/artifacts
          urls: '${{ steps.vercel-deployment.outputs.preview_url }}'

      - name: Upload reports
        uses: actions/upload-artifact@master
        with:
          name: Lighthouse reports
          path: ${{ github.workspace }}/tmp/artifacts