概要

nexterias/actions-vercelは、GitHub Actionsを使用してVercelにデプロイを行うためのアクションです。

• Vercelのビルド、デプロイまでのプロセスをGitHub Actionsに組み込むことが可能になる
• GitHub Actionsの良さを活かしたCI/CDを構築できるようになります
• vercel build, vercel deploy --prebuiltをサポート
  • ビルドをGitHub Actions上で行い、そのデータをVercelにデプロイすることが可能
    • Vercel側のビルド時間をゼロにすることができます
• VercelのGitHub連携機能を模倣的に再現可能
  • プルリクエストが作成、更新された際にプレビューURLを発行し、コメントを作成
  • コミットステータスの更新
  • デプロイメントを作成、更新
• ubuntu-latest, macos-latest, windows-latestで動作可能
• Vercelのプロセスの前後で任意の処理を実行可能
  • ビルド前のテストなど
  • デプロイ後の通知、Lighthouseによるスコア計測など

下記のようなワークフローファイルを作成することで、GitHub Actionsを利用してVercelにデプロイを行うことができます。

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@v4

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

使用例

• nexterias/homepage | GitHub