Percy Developer Hub

Welcome to the Percy Developer Hub. You'll find comprehensive guides and documentation to help you start working with Percy as quickly as possible, as well as support if you get stuck. Let's jump right in!

Source code integrations

Covered in this doc

List of supported SCM integrations
Overview of how our SCM integrations work

Supported source code integrations

Don't see your integration listed? Check out our webhooks documentation, or send a note to support.

How it works

Percy integrates with your source code manager to run visual reviews alongside code reviews. It also facilitates a two-way sync between your Percy builds and your pull/merge requests, notifying your team when visual changes are detected and approved.

Notifications and status updates

By integrating with your SCM and linking a repository to a Percy project, your commits and pull/merge requests will automatically be correlated with Percy builds.

If visual changes are detected, Percy will be reported as needing review in your SCM. With one-click, you can review and approve the visual diffs in Percy.

Through this integration, Percy automatically pulls rich metadata into each build including information regarding the compared branches, committers, commit messages, and more.

Approval workflow

Approving a build in Percy sets the status to approved and the commit status in your SCM to "passed."

Note: By default, Percy approvals aren’t required before merging, but you can enable this feature once you’re ready for it.

As part of this visual review workflow, Percy supports various functionality:

What's next

Learn more about how Percy works with more complex workflows, maintaining base build selections and more.

Base build selection
Approval workflows

Source code integrations

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.