# GitHub pull request status checks

Canonical: https://snapvisor.io/docs/github

> Connect Snapvisor to GitHub for build status checks on your pull requests, including a light install that works without read access to your code.



Install the Snapvisor GitHub App and every build posts a status check back to the pull request — so nothing merges with an unreviewed visual change.

## What the app does [#what-the-app-does]

The GitHub App links your repositories so Snapvisor can post commit and pull-request status checks. It reads the PR's base branch to resolve the [baseline](/baseline-build) and reports whether each build has unreviewed changes.

## Check names and states [#check-names-and-states]

Snapvisor posts its check under the name **snapvisor**. When several projects share a repository the name carries the project (`snapvisor/<project>`), a named build adds its name (`snapvisor/<build>`, or `snapvisor/<project>/<build>` for both; a build named `default` adds nothing), and the [summary check](/summary-checks) is `snapvisor/summary`. GitLab shows the same names on commit statuses.

| Build state                            | Check state | Description                                                 |
| -------------------------------------- | ----------- | ----------------------------------------------------------- |
| Queued or processing                   | Pending     | "Build is queued" or "Build in progress..."                 |
| Changes waiting for a reviewer         | Pending     | "N changes awaiting review" (or "1 change awaiting review") |
| Approved, auto-approved, or no changes | Success     | The approval or "no changes found"                          |
| Rejected by a reviewer                 | Failure     | The stats and "rejected"                                    |
| Expired, screenshots never arrived     | Failure     | "Build expired — screenshots never arrived"                 |

A build with unreviewed changes is **pending**, not failed: nothing is broken, a person just has not decided yet. The check only fails when a reviewer rejects the changes.

<Callout type="warn">
  Until recently the check was named `argos` (and `argos/summary`), and unreviewed changes showed as failed. To give you time to switch, Snapvisor keeps posting the old names, with the same state as the new ones and a description that starts with "deprecated:", until **2026-11-25**. After that date only the `snapvisor` names are posted, and a rule that still asks for the old name waits for a check that is never posted and blocks the merge.

  Before 2026-11-25, in your repository's branch protection or ruleset, replace the required check `argos` with `snapvisor` and `argos/summary` with `snapvisor/summary` (a named build or a project in a shared repository follows the same pattern: `argos/<name>` becomes `snapvisor/<name>`).

  Only required checks block a merge. A pending `snapvisor` check holds a pull request until someone approves or rejects the changes; a check that is not required never does.
</Callout>

## Require the Snapvisor check in branch protection [#require-the-snapvisor-check-in-branch-protection]

A check only blocks a merge once GitHub is told it is required. The required check is named `snapvisor`.

1. Open a pull request that triggers a Snapvisor build, so GitHub has seen the check at least once. GitHub only offers checks that ran recently.
2. In your repository, go to **Settings**, then **Branches**, and edit the rule for your default branch. With rulesets, go to **Settings**, then **Rules**, then **Rulesets**.
3. Turn on **Require status checks to pass before merging**.
4. Search for `snapvisor` and select it. Add `snapvisor/summary` as well if you use a [summary check](/summary-checks).
5. Save the rule.

Select the check that matches how the build is posted instead of plain `snapvisor`: `snapvisor/<project>` when several projects share the repository, `snapvisor/<build>` for a named build, and `snapvisor/<project>/<build>` for both. A build named `default` adds no suffix.

Do not select the old `argos` check. It is deprecated and stops being posted after 2026-11-25, see the notice above.

## Pull request comment [#pull-request-comment]

Snapvisor posts one comment on the pull request that lists the builds of its latest commit, and edits that comment as builds change instead of adding new ones.

The comment is a table with one row per build:

* **Build:** the build name, with an **Inspect** link. When the repository has several projects the project name is prefixed.
* **Status:** the build state. Once reviewed it shows who approved or rejected it and how many comment threads it has. A build with changes also gets a **Review** link.
* **Details:** the counts of changed, added, removed, failed and ignored screenshots.
* **Updated (UTC):** when the build last changed.

Deployments of the same commit appear in a second table.

The comment is on by default (`prCommentEnabled` in the API). To turn it off for a project, open the project, go to **Settings**, then **Git**, switch off **Pull request comments** and save. Only project admins see the Git tab, and the switch appears once the project is connected to a GitHub (or origin) repository. The status check is not affected. Builds of a merge queue never get a comment.

## GitHub integration without content permission [#github-integration-without-content-permission]

If your security policy won't grant a third party read access to your source, install the **light** GitHub App variant instead. It requests no content permission — Snapvisor never reads your code — and still posts status checks on your pull requests.

<Callout>
  The light install is a separate GitHub App connection on your team. You can switch to it, or uninstall it, at any time from your team's settings.
</Callout>

## Reviewing screenshots on the pull request [#reviewing-screenshots-on-the-pull-request]

For the whole loop — upload, status check, comment, review and approve — see [visual regression testing in GitHub pull requests](https://snapvisor.io/visual-regression-testing-github). To run it in a workflow, use [GitHub Actions](/github-actions).

## Authentication in CI [#authentication-in-ci]

On GitHub Actions you don't have to store an `ARGOS_TOKEN` at all. Snapvisor supports [tokenless authentication](/learn/integrations/github-tokenless-authentication) and short-lived [OIDC tokens](/learn/integrations/github-oidc-authentication) so builds authenticate without a long-lived secret. For workflows covering merge queues, shallow checkouts, fork pull requests and re-runs, see [GitHub Actions recipes](/github-actions).

