From e070140e7b1c007d1e449f0c160fca1215a138ba Mon Sep 17 00:00:00 2001 From: Brendan Holly Date: Mon, 9 Mar 2026 17:20:04 -0400 Subject: [PATCH] docs: Add setup:e2e script for installing playwright chromium and update contributing documentation for clarity --- .github/workflows/ci.yml | 4 ++-- .github/workflows/nextjs-canary-test.yml | 2 +- CONTRIBUTING.md | 14 +++++++++----- package.json | 3 ++- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d731d50..8ff56e8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -107,7 +107,7 @@ jobs: run: pnpm build - name: Install Playwright browsers - run: pnpm --filter e2e-test-app exec playwright install --with-deps chromium + run: pnpm setup:e2e - name: Build e2e app env: @@ -169,7 +169,7 @@ jobs: run: pnpm build - name: Install Playwright browsers - run: pnpm --filter e2e-test-app exec playwright install --with-deps chromium + run: pnpm setup:e2e - name: Build e2e app with ElastiCache handler env: diff --git a/.github/workflows/nextjs-canary-test.yml b/.github/workflows/nextjs-canary-test.yml index b35639c..1808c6b 100644 --- a/.github/workflows/nextjs-canary-test.yml +++ b/.github/workflows/nextjs-canary-test.yml @@ -71,7 +71,7 @@ jobs: - name: Install Playwright browsers if: steps.build.outcome == 'success' - run: pnpm --filter e2e-test-app exec playwright install --with-deps chromium + run: pnpm setup:e2e - name: Build e2e app id: build_e2e diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bd6903..ede5763 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,10 +20,14 @@ Thank you for your interest in contributing! This document provides guidelines a ```bash pnpm install ``` -4. **Create a branch** for your work: - ```bash - git checkout -b feature/my-new-feature - ``` +4. **Setup e2e testing**: +```bash + pnpm setup:e2e +``` +5. **Create a branch** for your work: +```bash + git checkout -b feature/my-new-feature +``` ## Development Workflow @@ -55,7 +59,7 @@ pnpm test pnpm test:e2e # Or run everything at once -pnpm lint && pnpm typecheck && pnpm test +pnpm lint && pnpm typecheck && pnpm test && pnpm test:e2e ``` ### Commit Messages diff --git a/package.json b/package.json index 7fa90a4..8a96676 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,8 @@ "docker:up": "docker compose up -d", "docker:down": "docker compose down", "docker:logs": "docker compose logs -f redis", - "clean": "turbo clean && rm -rf node_modules" + "clean": "turbo clean && rm -rf node_modules", + "setup:e2e": "pnpm --filter e2e-test-app exec playwright install --with-deps chromium" }, "devDependencies": { "@biomejs/biome": "^1.9.4",