Snapvisor Docs

Summary checks

A summary check rolls every Snapvisor build on a commit into one status, so you can require Snapvisor before a merge. Learn the auto, always, and never modes.

A summary check is a single status that represents every Snapvisor build on a commit — the easiest way to see at a glance whether a commit passes, and to mark Snapvisor as required for merge.

Why add one

A project can produce several builds on the same commit — different apps, shards, or Storybook and end-to-end runs side by side. Each posts its own check. The summary check aggregates them into one pass/fail status you can add to your branch protection rules.

Modes

  • Auto (recommended) — add a summary check only when a commit has more than one build.
  • Always — always post a summary check, even for a single build. Useful when builds run conditionally, so the required check is always present.
  • Never — don't post a summary check.

Requiring Snapvisor for merge

Set the mode to always, then add the summary check to your repository's required checks. Every pull request now has to have a passing Snapvisor status before it can merge — pair it with monitoring mode on trusted branches so the gate never blocks routine merges.

On this page