Skip to content

Getting started

First review

Approve your first build so it becomes the baseline.

Open the build from the project page. The build page lists its screenshots grouped by state (changed, added, removed, unchanged) and shows the selected one in a viewer.

How a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approvedHow a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approved
  1. Look through the screenshots. In a first build every one is Added.
  2. Approve them one by one, or approve the whole build. The build becomes Approved, and it's now the baseline for later builds with the same name.
  3. Upload the same screenshots again (a re-run). The build finishes with no changes and circi upload --wait exits 0.

Now change a screenshot and upload from a new commit. The build shows that screenshot as changed, with the diff next to the baseline. That is the loop. Reviewing a build covers the build page, shortcuts, comments and requests.

CirCI
A build page with one changed screenshot: the baseline and the new version side by side.
A changed screenshot, baseline on the left.
  • Link the project to its repository to get a CirCI check on pull requests with Approve and Reject buttons, and a summary comment: GitHub, GitLab, Bitbucket.
  • Mark that check as required in the repository's branch protection to block merges until someone reviews.
  • Add Slack or a webhook to hear about builds.