cron：「定期的にコマンドやスクリプトを実行する仕組み」を指す

Github Actions

.ymlファイルの作成

Github / Actions からworkflowを作成（ .yml）

cron.yml：

name: Vercel Cron

on:
  schedule:
    - cron: '*/10 * * * *'  # 10分おき
  workflow_dispatch:

jobs:
  run-cron:
    runs-on: ubuntu-latest
    steps:
      - name: Call API
        run: |
          curl -H "x-api-key: ${{ secrets.CRON_KEY }}" \
          https://xxx.vercel.app/api/cron-test

"x-api-key: ${{ secrets.CRON_KEY }}" ：cronで実行したいAPIルートを保護
https://xxx.vercel.app/api/cron-test ：APIルートへの絶対URL
- ${{ secrets.BASE_URL }}/api/cron-test ：URLもSecretに登録すると、変更に対応しやすい

実行したいAPIルートのメソッドが POST の場合：

run: |
  curl -X POST \
       -H "x-api-key: ${{ secrets.CRON_KEY }}" \
       https://xxx.vercel.app/api/cron-test

環境変数

「Githubリポジトリ/設定/Secrets/actions」、「プロジェクトの.envファイル」、「Vercel/設定/環境変数」に同じ環境変数を書く

例：CRON_TEST_KEY="test1234"

*GithubのSecretsページで再び環境変数の値を見ようとしても表示されない

route.ts

import { NextRequest, NextResponse } from "next/server";

export async function GET(req: NextRequest) {
  if (req.headers.get("x-api-key") !== process.env.CRON_KEY) {
    return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
  }

  // 実行したい処理
  console.log("Cron job running!");

  return NextResponse.json({ status: "ok" });
}

Vercel cron

Vercel cronは２つのアプリまで
それぞれのcronは１日１回まで
"0 13 * * *" ：毎日13時に実行するようにしても 13 ~ 14時の間に実行される

cronを２つ以上使うとVercelでエラーが出る

Error: Your plan allows your team to create up to 2 Cron Jobs. Your team currently has 2, and this project is attempting to create 1 more, exceeding your team's limit.

vercel.json：ルートに置く

{
  "crons": [
    {
      "path": "/api/test-cron",
      "schedule": "0 17 * * *" #毎日 17:00（午後5時）に実行
    }
  ]
}

route.ts：

import { NextRequest, NextResponse } from "next/server";

export async function GET(req: NextRequest) {
  if (req.headers.get('authorization') !== `Bearer ${process.env.CRON_SECRET}`) {
    return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
  }

  console.log("Vercel cron job running!");

  return NextResponse.json({ status: "ok" });
}

Vercel cronの場合 vercel.json にはHTTPヘッダーを書く事が出来ないので、Vercelのダッシュボードにroute.tsと同じCRON_SECRET 等を作って追加する

Cloudflare Workers

workersの基本的な部分は省略

最小構成のテンプレートを以下のコマンドから作成

npm create cloudflare@latest

やることは認証で保護されたアプリ側のAPIルートに定期的にリクエストをし、リクエストをトリガーに書かれたコードを実行させる。

index.ts：

import { env } from 'cloudflare:workers';

export default {
	async scheduled() {
		console.log('Cron triggered!');
		await fetch(`${env.APP_BASE_URL}/api/cron`, {
			method: 'POST',
			headers: {
				Authorization: `Bearer ${env.CRON_SECRET}`,
			},
		});
	},
};

wrangler.jsonc：

	"triggers": {
		"crons": ["0 * * * *"]
	}

npm run deployをした後にダッシュボードを見ると「トリガーイベント」が追加されている。

定期実行：Github Actions / Vercel cron / Cloudflare

定期実行：Github Actions / Vercel cron / Cloudflare