#Get Started

This section explains the steps for actually using nexterias/actions-vercel to deploy to Vercel.

#Prerequisites

• A GitHub account
• A Vercel account
• Vercel CLI

#Create a Repository and Vercel Project

First, create a repository on GitHub.

gh repo create --public --clone example-vercel-project
cd ./example-vercel-project

Next, create a project on Vercel.

vercel link

If the command completes successfully, a folder named .vercel should be created in the current directory, and project.json should be created inside it.

The project.json file contains two properties, projectId and orgId. Record each value.

# projectId
cat ./vercel/project.json | jq -r '.projectId'

# orgId
cat ./vercel/project.json | jq -r '.orgId'

#Create a Vercel Access Token

Go to Account Settings and create an access token.

After filling in the fields above and clicking Create, you will receive an access token. Record its value.

#Register Secret Information

1. Go to the repository page from github,com
2. Click the Settings tab
3. In the Security section, click Secrets and variables
4. Click the Secrets tab

Register the values above from New repository secret as follows.

#Configure GitHub Actions

Create a .github/workflows directory in your repository, then create a file named vercel.yml in it with the following contents.

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' }}

You can now deploy to Vercel with GitHub Actions.