HTTP runs API vs GitHub Action

There is no hosted POST/GET runs control plane in the MVP. Prefer the composite Action or CLI; HTTP polling inputs are reserved and ignored today.

Some teams prototype CI with a script that polls a remote /v1/runs-style API (for example vendor “agentic run” helpers). Restormel Testing 0.1.x does not ship a supported HTTP runs API. The runner executes in your job via the CLI or the composite GitHub Action—the same contract as local.

What to use instead

  • GitHub Actions — use packages/testing-github-action (published as @restormel/testing-github-action) or invoke pnpm exec testing run directly.
  • Other CI — shell out to the CLI after pnpm install and Playwright browser install; upload the artefact directory from the run.

Action inputs you can ignore

poll_interval_seconds and timeout_minutes on the composite action are documentation placeholders for a possible future hosted mode. They are ignored today. Use GitHub’s timeout-minutes on the job or step for wall-clock limits.

Future: sidecar or HTTP parity

If we add an official small sidecar that implements POST/GET /v1/runs for teams already wired to curl, it will be documented here and versioned separately from the core CLI. Until then, treat any HTTP poller as unsupported for Restormel Testing to avoid fork drift.

CI guide · Fork PRs and workflow triggers