Setup
1
Install the App
In the dashboard, go to Integrations and choose Install GitHub App.
Pick the repositories you want it to see.
2
Connect a repository to a project
Still under Integrations, connect the repository to a clickproof project
and tell it two things:
- Artifact name: the name your workflow uses when it uploads the build
with
actions/upload-artifact. clickproof downloads that artifact from the pull request’s own workflow run. - Target branch: only pull requests aimed at this branch run automatically. Leave it empty for every branch.
3
Open a pull request
Once your CI finishes and the artifact exists, clickproof picks it up, runs
the project’s tests on a real device, and reports back.
Your build still comes from your own pipeline. clickproof does not build your
app; it takes the artifact your workflow already uploads, which means the thing
under test is exactly what your CI produced.
What lands on the pull request
A check run with the verdict, and a comment with a row per test linking to its report. A check that fails blocks the pull request the same way any other failing check does. Only tests whose journey touches the change are run. If a pull request changes nothing a user can see, clickproof says so in a comment rather than silently running nothing.Asking for a specific test
Comment on the pull request:Run the saved suite
Run part of the suite
Run one-off instructions
test: runs exactly what you asked, once, against the current build. It is not
added to the project’s suite, so a throwaway request does not come back on every
future pull request.
The handle is your App’s slug. If you installed a self-hosted or renamed App,
use that name instead of
@clickproof.