GitHub Actions 中的 Playwright E2E 作为部署到 Vercel 之前的强制步骤
默认部署的问题
连接到 GitHub 的 Vercel 项目将 main 中的每个推送直接部署到生产环境中。 GitHub Actions 中的测试并行运行,如果失败,则损坏的版本已经在为用户提供服务。我们需要顺序:首先测试,然后部署,并准确部署已测试的程序集。
有两种工作方案。
方案 A. CI 构建应用程序,在本地运行它,运行 Playwright,如果成功,则通过 CLI 将组装的工件发送到 Vercel。
方案 B. Vercel 创建预览部署,CI 通过 URL 对其进行测试,如果成功,则将相同的部署提升到生产环境。
方案A更容易配置,并且不依赖于预览的可用性。电路 B 测试实际的 Vercel 基础设施(中间件、边缘函数、预览环境变量)。以下是方案 A 的完整版本以及方案 B 的差异。
禁用 Git 自动部署
在vercel.json中:
{
"git": {
"deploymentEnabled": false
}
}只能对单个分支禁用:"deploymentEnabled": { "main": false }。然后,将继续自动创建拉取请求的预览。
编剧配置
// playwright.config.ts
import { defineConfig, devices } from "@playwright/test";
const baseURL = process.env.E2E_BASE_URL ?? "http://localhost:3000";
export default defineConfig({
testDir: "./e2e",
fullyParallel: true,
forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0,
reporter: process.env.CI ? [["html", { open: "never" }], ["github"]] : "list",
use: {
baseURL,
trace: "on-first-retry",
extraHTTPHeaders: process.env.VERCEL_AUTOMATION_BYPASS_SECRET
? { "x-vercel-protection-bypass": process.env.VERCEL_AUTOMATION_BYPASS_SECRET }
: undefined,
},
projects: [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }],
webServer: process.env.E2E_BASE_URL
? undefined
: {
command: "npm run start",
url: "http://localhost:3000",
reuseExistingServer: !process.env.CI,
timeout: 120_000,
},
});forbidOnly 将防止意外提交的 test.only 跳过其他测试。 trace: "on-first-retry" 仅保存不稳定测试的跟踪,以避免膨胀伪影。
测试什么
部署前的端到端并不是全覆盖的地方。以需要花费金钱或用户来破坏的场景为例:
// e2e/critical.spec.ts
import { test, expect } from "@playwright/test";
test("главная отдаёт контент и навигацию", async ({ page }) => {
await page.goto("/");
await expect(page.getByRole("navigation")).toBeVisible();
await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
});
test("вход с тестовым пользователем", async ({ page }) => {
await page.goto("/login");
await page.getByLabel("Email").fill(process.env.E2E_USER_EMAIL!);
await page.getByLabel("Пароль").fill(process.env.E2E_USER_PASSWORD!);
await page.getByRole("button", { name: "Войти" }).click();
await expect(page).toHaveURL(/\/dashboard/);
});
test("страница статьи открывается при клиентской навигации", async ({ page }) => {
await page.goto("/forum");
await page.locator('a[href*="/forum/"]').first().click();
await expect(page.locator("article")).toBeVisible();
});最后一个测试捕获了直接加载页面时不可见的一类错误:通过 <Link> 时崩溃。测试用户必须仅存在于测试或预览数据库中。
图 A 的工作流程
# .github/workflows/deploy.yml
name: test-and-deploy
on:
push:
branches: [main]
jobs:
e2e-deploy:
runs-on: ubuntu-latest
env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm i -g vercel@latest
- run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
- run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
- run: npm run build
- run: npx playwright install --with-deps chromium
- run: npx playwright test
env:
E2E_USER_EMAIL: ${{ secrets.E2E_USER_EMAIL }}
E2E_USER_PASSWORD: ${{ secrets.E2E_USER_PASSWORD }}
- uses: actions/upload-artifact@v4
if: failure()
with:
name: playwright-report
path: playwright-report/
retention-days: 7
- run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}vercel pull 加载项目设置和环境变量,vercel build 将输出收集到 .vercel/output 中,deploy --prebuilt 发送它而不在 Vercel 端重新组装。仅当所有先前的步骤都已通过时,才会执行部署步骤。
这里应用程序构建了两次:vercel build用于部署,npm run build用于本地启动。如果测试程序集进入生产数据库,这是危险的 - 对 npm run build 和 next start 使用单独的测试环境变量。
方案B的区别
设置 E2E_BASE_URL 为预览部署的地址,而不是本地服务器(vercel deploy --token=... 将其打印到标准输出)。预览通常由部署保护关闭;对于自动化,请在项目设置中启用自动化保护绕过,并在 x-vercel-protection-bypass 标头中传递机密 - 上面的配置已经执行了此操作。测试成功后,运行vercel promote <url> --token=...。
如何处理崩溃
- 下载工件
playwright-report并打开npx playwright show-report。跟踪显示每个步骤的 DOM、网络和控制台。 - 测试仅在 CI 中崩溃:最常见的原因是冷启动或不同时区期间超时。比较
use中的TZ和locale。 - 不稳定的测试不通过增加
retries来处理。通过waitForTimeout查找等待,并通过expect将其替换为状态检查。
当不需要的时候
对于没有表单和授权的静态站点,建立和检查链接就足够了。如果测试时间超过 10-15 分钟,请将其分开:短烟组阻止部署,全套烟组按计划进行。