GitHub

Connect App Percy to GitHub to file bug reports from a snapshot, with the snapshot image and build context attached.

BrowserStack Percy’s GitHub integration lets you connect your Percy Project with GitHub for easier reporting of visual review findings. You can create GitHub issues from the Percy review dashboard at the snapshot level, including a specific browser and width combination. This helps you report issues faster without switching between tools.

How to integrate?

You integrate GitHub with Percy while creating an issue from the Percy build review screen.

Step 1: Open the Percy build you want to review and click the Report a bug icon on the review screen.

Step 2: Choose one of the following authentication options (this is a one-time setup):

• Option 1: Authenticate during issue creation.

  Click Report a bug, then authenticate via the BrowserStack Integrations consent screen to grant access to the repositories you want to file against. After successful authentication, Percy opens the GitHub issue form with mandatory fields such as Repository, Title, and Labels.

• Option 2: Enable group-level access

A Group Admin can enable group-level access for their team from the Accounts & Profile page. Locate GitHub under Project Management Tools and click Connect.

Then toggle the Enable Group Level Access for my team option. When you use this option, Percy creates all GitHub issues using the Group Admin’s authenticated session.

Step 3: Enter the required GitHub issue details in the form.

• When you create a GitHub issue for the first time, enter details such as the organisation, repository, project, and issue type.
• For subsequent issue creation, Percy automatically fills the organisation and repository you used previously.

• When you update an existing issue, select a GitHub issue from the available list and update it as needed. Percy adds the latest snapshot details and screenshots to the issue description.

Step 4: Click Create or Update.

Percy creates or updates the GitHub issue and links it to the selected snapshot.

How to check?

Percy creates GitHub issues at the snapshot level. You can access created issues from multiple places in the Percy review experience:

• Build-level issue count on the Percy build listing screen
• Snapshot thumbnail, which shows linked GitHub issues
• Issue count on the Report a bug icon

These indicators help you quickly identify which snapshots already have associated GitHub issues.

How to open the issue?

After Percy creates a GitHub issue:

1. Open the Percy build review screen.
2. Click the linked GitHub issue from the snapshot or the Report a bug panel.

Percy opens the issue on GitHub in a new tab, where you can track status, add comments, or update labels.

How to de-link?

You can remove the association between a GitHub issue and a Percy snapshot if the link is no longer needed.

1. Open the Percy build where the GitHub issue is linked.
2. Locate the linked GitHub issue.
3. Click Delink next to the issue.

1. Confirm the action.

Percy removes the association between the GitHub issue and the snapshot. This action does not update or close the GitHub issue.

Troubleshooting

• GitHub.com and GHEC only: GitHub Enterprise Server (self-hosted) is not supported.
• Issues not visible: Verify that the Percy Project maps to the correct GitHub repository and that the OAuth scope grants access to it.
• Authentication errors: Re-authenticate with GitHub if the connection fails. Confirm your browser is allowing third-party cookies for browserstack.com.
• Private repos missing from the picker: Re-authenticate from Accounts & Profile > Integrations > GitHub > Reconnect to grant private-repository scope.

Need more support? Contact BrowserStack.