docsgithub

GitHub integration

Connect a GitHub repository to an app so every bug report becomes an issue in the right repo.

Overview

Connecting GitHub links one of your apps to a single repository. From then on, every report submitted from that app automatically opens a GitHub issue with the description, screenshots, and the reporter's classification.

You can connect more than one tracker to the same app; each report fans out to every connected integration independently.

Before you start

  • You've created an app in the BugScreen console.
  • You can sign in to a GitHub account that can create issues in the repository you want reports filed into.

Connect GitHub

  1. Open your app in the console and go to the Integrations section.
  2. Click Connect GitHub. You'll be redirected to GitHub to authorize BugScreen.
  3. Approve the authorization on GitHub. You'll be returned to the console.
  4. Enter the repository owner and name that issues should be filed into, then confirm.
Tip: The owner can be your personal account or any organization you have access to. Only repositories the authorized account can write to are eligible.

What gets created

Each report opens a GitHub issue containing:

  • A title derived from the report.
  • A Markdown body with the description and any device or page metadata.
  • Screenshots embedded inline under a ## Screenshot heading.
  • The reporter's classification rendered in the body.

Labels

BugScreen applies a consistent set of labels so you can filter and automate:

  • bugscreen and bug on every issue.
  • type:bug, type:ui, or type:crash from the reporter's type.
  • severity:low, severity:medium, or severity:high from the reporter's severity.
BugScreen creates these labels in the repo as needed — you don't have to set them up first.

Test the connection

After connecting, use Test on the integration to confirm everything works end to end. The test files a real sample issue and shows you whether it succeeded.

Note: Testing creates a real Bug: … issue in your repository. You can close or delete the sample issue afterwards.

Change repo or disconnect

To file issues into a different repository, pick a different owner/repo from the integration — no need to reconnect. To stop filing issues entirely, disconnect the integration from the app's Integrations section.

Troubleshooting

If a test or real report fails to create an issue, check the following:

  • The authorized account lost access to the repo. Reconnect with an account that can write to it.
  • The repository was renamed, archived, or deleted. Update the selected owner/repo or point the integration at a live repo.
  • Connect is blocked with a plan-limit message. Your plan's integration limit has been reached — remove an unused integration or upgrade your plan.

Start shipping bug reports

Create an account to start shipping bug reports from your app.

Get started