VercelにGitHub repositoryを連携していると、pushのたびにPreview Deploymentが作られます。

普段は便利なのですが、entire.ioを使っているprojectでは少しだけ注意が必要でした。

entireはcheckpointを保存するために、entire/checkpoints/v1というbranchを自動的にpushします。これはアプリケーションのPreviewを見たいbranchではないのですが、Vercelから見ると普通のGitHub branchへのpushです。

そのままだと、checkpointが更新されるたびにVercelのdeployが走ります。

壊れているわけではありません。ただ、deploy一覧やGitHub checksにアプリとは関係ないPreview Deploymentが増えていくので、少し面倒です。

vercel.jsonで除外する

Vercelでは、vercel.jsonのgit.deploymentEnabledでbranchごとの自動deployを無効化できます。

entire/checkpoints/v1を除外するなら、次のように書きます。

{  "$schema": "https://openapi.vercel.sh/vercel.json",  "git": {    "deploymentEnabled": {      "entire/checkpoints/v1": false    }  }}

既存のvercel.jsonがある場合は、既存設定を残したままgitを追加します。

{  "$schema": "https://openapi.vercel.sh/vercel.json",  "crons": [    {      "path": "/api/cron",      "schedule": "*/5 * * * *"    }  ],  "git": {    "deploymentEnabled": {      "entire/checkpoints/v1": false    }  }}

これで、entire/checkpoints/v1にpushされてもVercelの自動deployは走らなくなります。他のbranchはこれまで通りdeployされます。

ignoreCommandではなくbranch設定にする

VercelにはignoreCommandもありますが、今回やりたいことはbuildを途中で止めることではありません。

entire/checkpoints/v1は、そもそもdeploy対象ではないbranchです。

なので、git.deploymentEnabledで「このbranchはdeployしない」と書いておくほうが、あとから見ても意図がわかりやすいと思います。

小さい設定ですが、entireをVercel deploy対象のprojectで使うなら最初に入れておくと楽です。