GitHub Action
Action reference
Inputs and outputs of the Agentiqa composite GitHub Action — generated from action.yml.
E2E tests written in plain English, run against your live app. Results, videos and run links right in your workflow.
Public reference: agentiqa/qa-action@v1. See the GitHub Action guide for setup and examples, and CI Integration for the exit-code contract and JSON envelope.
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
service-key | yes | — | Project-scoped Agentiqa CLI service key (sk_...). Required. Mint one from the Agentiqa web app or desktop app (Project Settings -> CLI Service Keys -> Create Key) or via /api/cli-quickstart-key. Pass it from a repository secret; never inline. |
api-url | no | — | Override the Agentiqa control-plane API URL (AGENTIQA_API_URL). Leave empty to use production (https://agentiqa.com). Set to https://s.agentiqa.com to target staging. |
engine-url | no | — | Optional hosted-engine URL override; only meaningful with runtime: cloud. Leave empty for the default Agentiqa cloud engine (https://engine.agentiqa.com). Set https://s-engine.agentiqa.com for staging, or the URL of your own hosted engine. |
plan-id | no | — | Run a single test plan by id (tplan_...). Overrides label-ids when set. |
label-ids | no | — | Comma-separated label ids; runs all plans tagged with any of them. Ignored when plan-id is set. |
mode | no | sequential | Execution order for the selected plans: sequential | parallel. |
cli-version | no | latest | Version of the Agentiqa CLI to run: an npm dist-tag (latest, staging) or an exact semver (e.g. 1.4.2). Default latest. |
artifacts-dir | no | agentiqa-artifacts | Directory (relative to the workspace) for run artifacts and the JSON result envelope. |
fail-on | no | plan-failure | Exit-code gating policy. One of: never - never fail the job on the run outcome (report-only; read outputs downstream). plan-failure - (default) fail when a plan failed (exit 1) OR on a config/usage error (exit 2 — permanent, must fail loudly). Only retryable infra errors (exit 3) are swallowed, surfacing as outcome=infra-error for a digest/reporter to handle. Exit 3 also covers a NO-VERDICT batch — one whose only non-passing plans could not reach a verdict (a persistent engine disconnect, or the blocked cascade of one) — so a transient WS drop no longer reads as a red plan-failure. Read the outcome step output to gate more strictly (fail-on: any). any - fail on any nonzero exit. Use for release gates. |
node-version | no | 22 | Node.js version to set up on the runner (18+). |
upload-artifacts | no | true | Upload the artifacts directory (screenshots/video/result JSON) as a build artifact. |
artifact-name | no | — | Name for the uploaded artifact. Defaults to agentiqa-artifacts-<run_id>-<attempt> when empty. |
share-links | no | false | Mint an opt-in PUBLIC, revocable share link for each cloud run (passes --share to the CLI) so reviewers can open a run from the step summary without an Agentiqa login. The Run column links the share URL when present. Default false (privacy-conservative). Cloud runtime only. |
retention-days | no | 14 | Retention period (in days) for the uploaded artifact. Only applies when upload-artifacts is true. Defaults to 14; the repo/org artifact-retention cap still bounds it. |
Outputs
| Output | Description |
|---|---|
outcome | Run outcome bucket: passed | plan-failure | config-error | infra-error. Note: exit 0 with zero executed plans buckets as config-error (a run that tests nothing is not a pass). |
json-path | Path to the captured JSON result envelope (schemaVersion:1). Empty if the run was not attempted. |
exit-code | Raw CLI process exit code (0 pass / 1 plan failure / 2 usage-config / 3 infra). |
plans-total | Total plans reported in the JSON envelope (empty if no envelope). |
plans-passed | Number of plans with outcome=passed. |
plans-failed | Number of plans with outcome != passed. |
artifact-name | Resolved artifact name used for the upload. |
cli-resolved-version | The Agentiqa CLI version actually executed, resolved at run time from agentiqa --version (e.g. 1.1.32). Makes verdict drift across publishes attributable when cli-version is a floating dist-tag (latest/staging). Empty if capture failed or the run was not attempted. |