Getting Started

Step 1 — Create your account

Sign up at testquorum.dev/signup using your GitHub account. TestQuorum uses GitHub OAuth — there is no separate password to manage.

Step 2 — Add a repository

From the dashboard, click Add repository and install the TestQuorum GitHub App on the repository you want to monitor. Once added, your repository appears in the dashboard with a setup checklist.

Step 3 — Create an API key

Go to your repository in the dashboard and open API Keys. Create a key scoped to that repository and copy the secret — it is shown only once. Add it as a GitHub Actions secret named TESTQUORUM_API_KEY under Settings → Secrets and variables → Actions in your GitHub repository.

Step 4 — Add the workflow step

Add the following step to your existing CI workflow, or create a new file at .github/workflows/ci.yml.

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

      - name: Run tests via TestQuorum
        uses: testquorum/action@v0.1.0
        env:
          TESTQUORUM_API_KEY: ${{ secrets.TESTQUORUM_API_KEY }}

The runner auto-discovers what to test from your repo — no extra configuration is needed for Rust (Cargo.toml), Nix (flake.nix checks), or treefmt (treefmt.toml).

Step 5 — View your results

After your first run, the dashboard shows a per-test breakdown with pass, fail, and flaky results. Each test tracks its history across runs including timing.

We're also adding a Tests Dashboard — a GitHub issue on your repository that stays up to date with which tests are broken on main and a full directory of every tracked test. This feature is coming soon.

Next steps