वर्सेल में तैनाती से पहले एक अनिवार्य कदम के रूप में GitHub क्रियाओं में नाटककार E2E
डिफ़ॉल्ट परिनियोजन में समस्या
GitHub से जुड़ा वर्सेल प्रोजेक्ट main में प्रत्येक पुश को सीधे उत्पादन में तैनात करता है। GitHub क्रियाओं में परीक्षण समानांतर में चलते हैं, और यदि वे विफल होते हैं, तो टूटा हुआ संस्करण पहले से ही उपयोगकर्ताओं को सेवा प्रदान कर रहा है। हमें आदेश की आवश्यकता है: पहले परीक्षण, फिर तैनाती, और ठीक उसी असेंबली को तैनात करना जिसका परीक्षण किया गया था।
दो कार्य योजनाएँ हैं।
योजना ए. सीआई एप्लिकेशन बनाता है, इसे स्थानीय रूप से चलाता है, प्लेराइट चलाता है, और यदि सफल होता है, तो इकट्ठे आर्टिफैक्ट को सीएलआई के माध्यम से वर्सेल को भेजता है।
योजना बी. वर्सेल एक पूर्वावलोकन परिनियोजन बनाता है, सीआई यूआरएल द्वारा इसका परीक्षण करता है, और सफल होने पर, उसी परिनियोजन को उत्पादन में बढ़ावा दिया जाता है।
स्कीम ए को कॉन्फ़िगर करना आसान है और यह पूर्वावलोकन की उपलब्धता पर निर्भर नहीं करता है। सर्किट बी वास्तविक वर्सेल इंफ्रास्ट्रक्चर (मिडिलवेयर, एज फ़ंक्शंस, पूर्वावलोकन पर्यावरण चर) का परीक्षण करता है। नीचे योजना ए का पूर्ण संस्करण और बी के लिए अंतर दिया गया है।
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 पूर्ण कवरेज का स्थान नहीं है। उन परिदृश्यों को लें जिनमें पैसा खर्च होता है या उपयोगकर्ताओं को नुकसान उठाना पड़ता है:
// 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> से गुजरते समय क्रैश हो जाता है। एक परीक्षण उपयोगकर्ता केवल परीक्षण या पूर्वावलोकन डेटाबेस में मौजूद होना चाहिए।
आरेख ए के लिए वर्कफ़्लो
# .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 build तैनाती के लिए और npm run build स्थानीय लॉन्च के लिए। यदि कोई परीक्षण असेंबली उत्पादन डेटाबेस में जाती है, तो यह खतरनाक है - npm run build और next start के लिए अलग-अलग परीक्षण पर्यावरण चर का उपयोग करें।
स्कीम बी में अंतर
स्थानीय सर्वर के बजाय, पूर्वावलोकन परिनियोजन के पते के साथ E2E_BASE_URL सेट करें (vercel deploy --token=... इसे stdout पर प्रिंट करता है)। पूर्वावलोकन आमतौर पर परिनियोजन सुरक्षा द्वारा बंद कर दिया जाता है; स्वचालन के लिए, प्रोजेक्ट सेटिंग्स में स्वचालन के लिए प्रोटेक्शन बायपास सक्षम करें और x-vercel-protection-bypass हेडर में रहस्य पास करें - उपरोक्त कॉन्फ़िगरेशन पहले से ही ऐसा करता है। सफल परीक्षण के बाद, vercel promote <url> --token=... चलाएँ।
दुर्घटनाओं से कैसे निपटें
- आर्टिफैक्ट
playwright-reportडाउनलोड करें औरnpx playwright show-reportखोलें। ट्रेस प्रत्येक चरण पर DOM, नेटवर्क और कंसोल दिखाता है। - परीक्षण केवल सीआई में क्रैश होता है: अक्सर इसका कारण कोल्ड स्टार्ट या अलग-अलग समय क्षेत्रों के दौरान टाइमआउट होता है।
useमेंTZऔरlocaleकी तुलना करें। - अस्थिर परीक्षण का इलाज
retriesबढ़ाकर नहीं किया जाता है।waitForTimeoutके माध्यम से प्रतीक्षा की तलाश करें और इसेexpectके माध्यम से स्थिति जांच से बदलें।
जब यह अनावश्यक हो
फ़ॉर्म और प्राधिकरण के बिना एक स्थिर साइट के लिए, लिंक बनाना और जांचना पर्याप्त है। यदि परीक्षणों में 10-15 मिनट से अधिक समय लगता है, तो उन्हें विभाजित करें: एक छोटा धुआं सेट तैनाती को अवरुद्ध करता है, एक पूरा सेट निर्धारित समय के अनुसार आगे बढ़ता है।