Baselines
A baseline is the reference screenshot Vizzly compares against.
If a screenshot does not match an existing baseline, it shows up as new or missing instead of changed.
How matching works
By default, Vizzly matches screenshots using:
- screenshot name
- captured image width
- browser, if present
Changing the name or captured image width can make a screenshot appear as new.
Baseline signature properties
Add signature properties when a screenshot needs separate baselines for variants such as:
themedevicelocale
For example, add theme to keep separate dark and light baselines for dashboard.
Baseline modes
Git mode
Git mode is the default. Vizzly searches your Git history in this order:
- use the latest earlier approved build on the same branch
- otherwise use an approved build at
common_ancestor_sha, if the build includes one - otherwise ask GitHub for the merge base, if GitHub is connected
- otherwise use the latest earlier approved build on the baseline branch
Vizzly can skip a build if its screenshot count suggests captures are missing.
Manual branch mode
Each branch gets its own manually selected baseline.
Use this when branches need to evolve independently for a while.
Manual mode
One fixed build acts as the baseline for every branch until you change it.
Use this when you want a stable, frozen reference point.
Which builds can become baselines
Vizzly uses completed, approved builds as baselines. Pending, rejected, failed, and identical-only builds are not baseline candidates.
Common issues
A screenshot shows up as new
Check whether the name, captured image width, browser, or configured signature properties changed.
Git mode did not find the baseline you expected
Check:
- the configured baseline branch
- whether that branch has an earlier approved build
- whether the build has enough screenshots to be a useful baseline
You cannot mark a build as baseline
The build must be completed and approved, and you need permission to manage the project.