Skip to content
Latest

GitHub integration

Connect GitHub to add:

  • commit and PR status checks
  • optional PR comments
  • better baseline selection in Git mode

What changes when GitHub is connected

Vizzly uses GitHub to find the merge base when local Git history is incomplete. It also posts check results on commits and pull requests.

Status checks

Checks reflect the build’s review state:

  • approved builds can report success
  • builds with only identical comparisons report success
  • rejected builds report failure
  • builds waiting for review report that action is required

An identical-only build does not need a human approval. If a build has changed or new comparisons, approve those comparisons to approve the build.

PR comments

You can also enable PR comments and choose whether they include:

  • no images
  • new screenshots
  • diff images

Troubleshooting

If checks are missing or attached to the wrong commit, check:

  • the repository is linked to the project
  • the GitHub App has access to that repository
  • the commit SHA Vizzly received in CI

If the baseline is wrong, check the baseline branch and the Git history available to Vizzly.

Next steps