actions-vercel

Appearance

github-token ​

GitHubのPersonal Access Tokenまたはsecrets.GITHUB_TOKENを指定してください。

デフォルトでは、secrets.GITHUB_TOKENを使用します。

注意

github-tokenに入力する値は機密情報になるので、直接ファイルに記述せずSecretsを利用してください。

使用する場面 ​

与えられた権限に応じて、以下のような操作を行います。

  • コミットステータスの作成、更新
  • Deploymentの作成、更新
  • プルリクエストへのコメント作成、更新

必要な権限 ​

必要な権限が与えられていない場合は、スルーして通常通りVercelへのデプロイを行う仕組みになっています。お好みに合わせて必要な権限を与えて設定してください。

secrets.GITHUB_TOKENの場合 ​

権限説明
deploymentsデプロイメントを作成、更新する場合はwriteに設定
statusesコミットステータスを作成、更新する場合はwriteに設定
pull-requestsプルリクエストにコメントを作成する場合はwriteに設定
yml
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' }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

Personal Access Tokenの場合 ​

repoスコープが必要です。