#Overview

nexterias/actions-vercel is an action for deploying to Vercel with GitHub Actions.

• You can integrate Vercel's build and deployment processes into GitHub Actions.
• You can build CI/CD that takes advantage of GitHub Actions.
• Supports vercel build and vercel deploy --prebuilt
  • You can build on GitHub Actions and deploy that data to Vercel.
    • This can reduce build time on the Vercel side to zero.
• Can reproduce Vercel's GitHub integration features in an imitative manner
  • Issues preview URLs and creates comments when pull requests are created or updated
  • Updates commit statuses
  • Creates and updates Deployments
• Works on ubuntu-latest, macos-latest, and windows-latest
• You can run arbitrary processing before and after Vercel processes
  • Tests before building
  • Notifications after deployment and score measurement with Lighthouse

Create a workflow file like the following to deploy to Vercel with GitHub Actions.

name: Vercel

on:
  push:
    branches: [main]
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    permissions:
      contents: read
      deployments: write
      statuses: write
      pull-requests: write

    steps:
      - uses: actions/checkout@v7

      - uses: nexterias/actions-vercel@v2
        with:
          token: ${{ secrets.VERCEL_TOKEN }}
          org-id: ${{ secrets.VERCEL_ORG_ID }}
          project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          production: ${{ github.ref == 'refs/heads/main' }}

#Examples

• nexterias/homepage | GitHub