Vercel Action

This action was formerly Zeit Now Deployment. Migration Guide

Introduction to Vercel

Vercel is a cloud platform for static sites and Serverless Functions that fits perfectly with your workflow. It enables developers to host Jamstack websites and web services that deploy instantly, scale automatically, and requires no supervision, all with no configuration.

This action make a Vercel deployment with github actions.

• Deploy to Vercel.
• Comment on pull request.
• Comment on commit.
• Password Protect ( Basic Auth )
• Alias domain to deployment.
• Create Deployment on GitHub.

Result

pull request example

commit

Inputs

Name	Required	Default	Description
vercel-token			Vercel token. see https://vercel.com/account/tokens
github-comment		true	Its type can be either string or boolean. When string, it leaves PR a comment with the string. When boolean, it leaves PR a default comment(true) or does not leave a comment at all(false).
github-token			if you want to comment on pull request or commit. ${{ secrets.GITHUB_TOKEN }} (GitHub token docs)
github-deployment		false	if you want to create a GitHub Deployment, set true.
github-deployment-environment			The environment for the GitHub deployment (e.g., production, staging, preview). If not specified, auto-detects: production when vercel-args contains --prod, otherwise preview.
vercel-project-id			❗Vercel CLI 17+,The name property in vercel.json is deprecated (https://zeit.ink/5F)
vercel-org-id			❗Vercel CLI 17+,The name property in vercel.json is deprecated (https://zeit.ink/5F)
vercel-args			This is optional args for vercel cli. Example: --prod
working-directory			the working directory
scope			If you are working in a team scope, you should set this value to your team ID.
alias-domains			You can assign a domain to this deployment. Please note that this domain must have been configured in the project. You can use pull request number via {{PR_NUMBER}} and branch via {{BRANCH}}.
vercel-project-name			The name of the project; if absent we'll use the vercel inspect command to determine. #27 & #28
vercel-version			vercel-cli package version if absent we will use one declared in package.json

Outputs

preview-url

The url of deployment preview.

preview-name

The name of deployment name.

deployment-id

The GitHub Deployment ID. Only set when github-deployment is true. Can be used by downstream steps to reference the deployment.

How To Use

Disable Vercel for GitHub

The Vercel for GitHub integration automatically deploys your GitHub projects with Vercel, providing Preview Deployment URLs, and automatic Custom Domain updates. See Git Configuration for more details.

We would like to use github actions for build and deploy instead of Vercel.

Disable automatic deployments by setting git.deploymentEnabled: false in your project configuration.

Using vercel.ts (recommended)

Install @vercel/config and create a vercel.ts file:

import type { VercelConfig } from '@vercel/config/v1';

export const config: VercelConfig = {
  public: false,
  git: {
    deploymentEnabled: false,
  },
};

Using vercel.json

{
  "public": false,
  "git": {
    "deploymentEnabled": false
  }
}

Note: The github.enabled property is deprecated. Use git.deploymentEnabled instead. See Turning off all automatic deployments.

Skip vercel's build step

Since we do the build in github actions, we don't need to build in vercel.

Method 1 - via vercel interface

• Specify "Other" as the framework preset, and
• Enable the Override option for the Build Command, and
• Leave the Build Command empty.
• This will prevent the build from being attempted and serve your content as-is.

See docs for more details

Method 2 - via project configuration

You can override the build command in your project configuration to skip Vercel's build step.

vercel.ts (recommended):

import type { VercelConfig } from '@vercel/config/v1';

export const config: VercelConfig = {
  buildCommand: '',
};

vercel.json:

{
  "buildCommand": ""
}

See Build Command docs and Programmatic Configuration for more details.

Project Linking

You should link a project via Vercel CLI in locally.

When running vercel in a directory for the first time, Vercel CLI needs to know which scope and Project you want to deploy your directory to. You can choose to either link an existing project or to create a new one.

NOTE: Project linking requires at least version 17 of Vercel CLI. If you have an earlier version, please update to the latest version.

vercel

? Set up and deploy “~/web/my-lovely-project”? [Y/n] y
? Which scope do you want to deploy to? My Awesome Team
? Link to existing project? [y/N] y
? What’s the name of your existing project? my-lovely-project
🔗 Linked to awesome-team/my-lovely-project (created .vercel and added it to .gitignore)

Once set up, a new .vercel directory will be added to your directory. The .vercel directory contains both the organization(vercel-org-id) and project(vercel-project-id) id of your project.

{ "orgId": "example_org_id", "projectId": "example_project_id" }

You can save both values in the secrets setting in your repository. Read the Official documentation if you want further info on how secrets work on Github.

Github Actions

• This is a complete .github/workflows/deploy.yml example.

Set the vercel-project-id and vercel-org-id you found above.

name: deploy website
on: [pull_request]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      #  your build commands
      # - run: |
      #    ng build --prod
      - uses: amondnet/vercel-action@v25 # deploy
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
          github-token: ${{ secrets.GITHUB_TOKEN }} # Optional
          vercel-args: --prod # Optional
          vercel-org-id: ${{ secrets.ORG_ID}} # Required
          vercel-project-id: ${{ secrets.PROJECT_ID}} # Required
          working-directory: ./sub-directory

Angular Example

See .github/workflows/example-angular.yml ,

Basic Auth Example

How to add Basic Authentication to a Vercel deployment

See .github/workflows/example-express-basic-auth.yml

source code

| @now/node-server is deprecated and stopped working. Use @vercel/node instead. #61

Alias Domains

You can assign a domain to this deployment. Please note that this domain must have been configured in the project.

If you want to assign domain to branch or pr, you should add Wildcard Domain.

You can use pull request number via {{PR_NUMBER}} and branch via {{BRANCH}}

Example

Wildcard Domains : *.angular.vercel-action.amond.dev

Per Pull Request

https://pr-{{PR_NUMBER}}.angular.vercel-action.amond.dev

• PR-1 -> https://pr-1.angular.vercel-action.amond.dev
• PR-2 -> https://pr-2.angular.vercel-action.amond.dev

Per Branch

https://{{BRANCH}}.angular.vercel-action.amond.dev

• develop -> https://develop.angular.vercel-action.amond.dev
• master -> https://master.angular.vercel-action.amond.dev
• master -> https://master.angular.vercel-action.amond.dev

See .github/workflows/example-angular.yml

name: deploy website
on: [pull_request]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: amondnet/vercel-action@v25
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
          github-token: ${{ secrets.GITHUB_TOKEN }} # Optional
          vercel-args: --prod # Optional
          vercel-org-id: ${{ secrets.ORG_ID}} # Required
          vercel-project-id: ${{ secrets.PROJECT_ID}} # Required
          working-directory: ./sub-directory # Your Working Directory, Optional
          alias-domains: | # Optional
            staging.angular.vercel-action.amond.dev
            pr-{{PR_NUMBER}}.angular.vercel-action.amond.dev

GitHub Deployments

You can create GitHub Deployments to track your Vercel deployments directly in GitHub's Environments tab.

Set github-deployment to true and provide a github-token with deployments: write permission.

The environment is auto-detected from vercel-args: production when --prod is present, otherwise preview. You can override this with github-deployment-environment.

name: deploy website
on: [pull_request]
jobs:
  deploy:
    runs-on: ubuntu-latest
    permissions:
      deployments: write
    steps:
      - uses: actions/checkout@v2
      - uses: amondnet/vercel-action@v25
        id: vercel
        with:
          vercel-token: ${{ secrets.VERCEL_TOKEN }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          vercel-org-id: ${{ secrets.ORG_ID}}
          vercel-project-id: ${{ secrets.PROJECT_ID}}
          github-deployment: true
          # github-deployment-environment: staging  # Optional override
      - run: echo "Deployment ID is ${{ steps.vercel.outputs.deployment-id }}"

The deployment lifecycle:

1. A GitHub Deployment is created with status in_progress before the Vercel deploy
2. On success, the status is updated to success with the preview URL
3. On failure, the status is updated to failure
4. Previous deployments to the same environment are automatically deactivated

Note: GitHub Deployment errors are non-blocking. If the GitHub API call fails, the Vercel deployment will still proceed normally.

Migration from v2

1. Change action name in workflows from now-deployment to vercel-action

   - name: Vercel Action
     uses: amondnet/vercel-action@v25

2. Change input values.
   • zeit-token -> vercel-token
   • now-org-id -> vercel-org-id
   • now-project-id -> vercel-project-id