| api-key | Your API key | yes | — |
| project-id | The project ID to execute (v2 only).
Use this OR test-suite-id, not both. | — | — |
| playwright-project-name | The Playwright project name(s) to run (v2 only).
Maps to the --project CLI flag.
Optional - if not provided, all projects will run. | — | — |
| run-group-name | Deprecated. Use playwright-project-name instead. | — | — |
| env-overrides | A YAML string or JSON object containing environment variable overrides (v2 only).
Each key is a variable name and the value is a string.
Example:
BASE_URL: https://staging.example.com
API_KEY: abc123 | — | — |
| environment-name | Name of the environment to use for this run (v2 only).
For example: "Staging", "Production".
When omitted, falls back to the project's default environment. | — | — |
| test-group-id | The test group ID to execute (v1 only) | — | — |
| test-suite-id | The test suite ID to execute (v1 only).
Use this OR project-id, not both. | — | — |
| domain-override | Newline-separated tuple (pair) with original first as first line and the replacement second (v1 only).
Use to replace website URLs when running tests | — | — |
| url-replacement | Newline-separated tuple (pair) with original first as first line and the replacement second (v1 only).
Use to replace website URLs when running tests | — | — |
| github-comment | If enabled, will leave a comment on either the commit or PR with relevant test results.
Requires proper permissions. | — | true |
| github-token | This token is used for used for leaving the comments on PRs/commits.
By default, we'll use the github actions bot token, but you can override this a repo scoped PAT. | — | ${{ github.token }} |
| async | If set, will launch the tests but not wait for them to finish and the action will always output success.
Note: Github comments will not function if this is set | — | false |
| environment | The environment to inherit variables from (v1 only).
For v2, use environment-name instead.
Defaults to 'PRODUCTION'. | — | PRODUCTION |
| variable-overrides | A JSON object of variable overrides to pass to the tests (v1 only).
The key is the variable name and the value is the value to override it with.
The value can be a string or an object with a 'value' property and an optional 'sensitive' property. | — | {} |
| note | Optional note to add to the test run to help identify it (v1 only).
This note will be included in the test run metadata. | — | — |