@openlyinc/get-vercel-deployment-url NPM

@openlyinc/get-vercel-deployment-url

A straightforward GitLab pipeline utility that is used to return a Vercel Deployment URL in a vercel_deployment_url.txt file after waiting for the triggered Vercel Deployment to finish.

How to set up

Add the following ENV variables to your pipeline: 1. VERCEL_TOKEN 2. VERCEL_TEAM_ID 3. VERCEL_PROJECT_ID

How to use

npx @openlyinc/get-vercel-deployment-url commitSHA pollingInterval

This utility has 2 arguments that must be passed in order: 1. commitSHA (required) - This is the Git commit SHA for the latest commit that triggered a Vercel Deployment. This value will come from the GitLab pipeline ENV variable $CI_COMMIT_SHA. 2. pollingInterval (optional) - This is an integer value in milliseconds that is used to poll Vercel for the Deployment's status. This value is set to 10000ms if a pollingInterval is not supplied.

Example usage

In this example, this utility is being used in a GitLab pipeline to poll Vercel every 5 seconds for the Deployment's status, and once ready, it passes the vercel_deployment_url.txt file as an artifact.

...
get_vercel_deployment_url:
  stage: prepare
  image: node:14.16.1-alpine3.10

  script:
    - npx @openlyinc/get-vercel-deployment-url $CI_COMMIT_SHA 5000

  artifacts:
      when: on_success
      paths:
        - vercel_deployment_url.txt
...

Troubleshooting

If you get the error:

Failed to write Vercel Deployment URL to vercel_deployment_url.txt. 

Check that your pipeline has VERCEL_TOKEN, VERCEL_TEAM_ID, and VERCEL_PROJECT_ID ENV variables configured. 
Check that a Git commit SHA is being passed as an argument.

Your pipeline ENV variables aren't configured or you aren't passing the required commitSHA argument in your pipeline script.