clickproof-ai/run-tests is a composite Action. It needs bash, curl, and
jq, all preinstalled on GitHub-hosted runners.
Inputs
string
required
clickproof API key (
cp_live_…). Store it as a repository secret and pass
${{ secrets.CLICKPROOF_API_KEY }} — never hard-code it.string
required
The project id to test.
string
required
Path to the build to upload:
.apk for Android, or a zipped simulator .app
for iOS. A device .ipa cannot run on a simulator and is refused.string
Run a single test by id. Omit to run every test in the project (a suite).
string
default:"https://clickproof.app"
clickproof base URL. Override to target staging or a custom domain.
number
default:"1200"
Maximum seconds to wait for all runs to finish before failing.
number
default:"10"
Seconds between status polls.
boolean
default:"true"
Fail the job when any test fails or errors. Set
false for report-only runs
that never fail the build.Outputs
number
Number of tests that passed.
number
Number of tests that failed or errored.
number
Total number of tests run.
Using outputs
What it does
1
Upload
POST /api/v1/projects/:id/build — uploads your build.2
Trigger
POST /api/v1/projects/:id/runs — starts the test(s).3
Poll
GET /api/v1/runs/:id — polls each run until it reaches a terminal status.4
Report
Writes the results table to the job summary and exits non-zero on any
failure.