Getting Started

Make sure to check out the requirements before you start.

Suite

Existing Suite Demo Suite

Target

Remote Server Local Server Vercel Preview

Run From

Local CLI GitHub Actions Other CI/CD

1. Connect GitHub

Install the Endform GitHub App to enable OIDC authentication in your workflows:

Connect GitHub in Dashboard →

2. Connect Vercel

Connect your Vercel account to automatically test preview deployments:

Connect Vercel in Dashboard →

3. Create workflow file

Create .github/workflows/endform-e2e.yml in your repository:

name: Run end to end tests with endform

on:
  pull_request: # or push: if you want to run on commits to main
    branches:
      - main

permissions:
  contents: read
  id-token: write # required for authentication with Endform

jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Node
        uses: actions/setup-node@v4

      - name: Set up pnpm (or whichever package manager you use)
        uses: pnpm/action-setup@v4
        with:
          run_install: true

      - name: Wait for Vercel deployment
        uses: endformdev/actions/run-with-vercel-deployment@main
        with:
          project-name: your-vercel-project-name
          set-url-env-var: BASE_URL # Sets the Vercel preview URL as this environment variable
          set-vercel-bypass-env-var: VERCEL_BYPASS_TOKEN # Exports a deployment protection bypass token as this env var

      - name: Run end to end tests with endform
        working-directory: . # where your playwright suite is located
        run: |
          npx endform@latest test

4. Commit your changes

Stage and commit your workflow file:

git add -A && git commit -m "Add endform github actions workflow"

5. Push to trigger tests

Push your changes to trigger the workflow on your next pull request:

git push

View your results

Once your tests complete, results will appear in the Endform dashboard.