Getting Started

Connect a GitHub Repo

RunPilotAI integrates with GitHub Actions to capture test results automatically on every push. Follow these steps to connect your first repository.

Step 1 — Add your project

In Projects, click Connect Repository and fill in:

  • GitHub URL — e.g. https://github.com/org/repo
  • Default branch — usually main
  • Workflow file — e.g. test.yml

Step 2 — Copy your ingestion key

After creating the project, open the project detail page to find your Ingest API Key. Add it as a GitHub Actions secret named RUNPILOT_API_KEY.

Step 3 — Update your workflow

Add the ingestion step to your existing GitHub Actions workflow. This example uses Playwright:

yaml
name: Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20

      - run: npm ci
      - run: npx playwright test --reporter=json --output=playwright-results.json

      - name: Send results to RunPilotAI
        if: always()
        run: |
          curl -s -X POST https://runpilotai.com/api/ingest/playwright \
            -H "Content-Type: application/json" \
            -H "x-api-key: ${{ secrets.RUNPILOT_API_KEY }}" \
            -d @playwright-results.json

Step 4 — Trigger a run

Push a commit or manually trigger the workflow. Within seconds the run appears in RunPilotAI with full pass/fail breakdown.

GitHub Actions re-runs

RunPilotAI can trigger a fresh run directly from the dashboard using the GitHub Actions workflow_dispatch event. You need to set the GITHUB_TOKEN environment variable with a personal access token that has workflow scope.

Quick StartPlaywright