Getting Started

Make sure to check out the requirements before you start.

Suite

Existing Suite Demo Suite

Target

Remote Server Local Server Vercel Preview Soon

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. Create workflow file

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

name: Run end to end tests with endform

on:
  pull_request:
    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: Set up pnpm (or whichever package manager you use)
        uses: pnpm/action-setup@v4

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

      # Any other setup needed for your local server to run...

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

3. Commit your changes

Stage and commit your workflow file:

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

4. 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.