Connect GitHub
Install the Lighthouse GitHub App so your team can add repositories and scan pull requests.
Lighthouse reads your code and reports on pull requests through a GitHub App. Installing the app connects GitHub to your team. The repositories you give the app access to are the ones your team can add to Lighthouse.
Connect
In Lighthouse, go to Settings › Git providers and press Connect GitHub.
On GitHub, choose the account or organization that owns your repositories.
Choose All repositories, or Only select repositories and pick them. You can change this later.
Approve. GitHub returns you to Lighthouse, which shows GitHub connected and lists the repositories under Ready to add as repositories.
Connecting doesn't add repositories to Lighthouse by itself. Next, add the ones you want.
Start from Lighthouse
Always press Connect GitHub in Lighthouse. If you install the app from its GitHub page instead, Lighthouse can't tell which team it belongs to, and nothing is connected.
Manage the connection
The GitHub card under Settings › Git providers has three actions:
| Action | Use it to |
|---|---|
| Sync | Refresh the list of repositories after changing the app's access on GitHub. |
| Manage on GitHub | Open the app's settings on GitHub to add or remove repositories. |
| Disconnect | Remove the app from your team. Pull request scans stop. |
Troubleshooting
| You see | Do this |
|---|---|
| GitHub sent your install request to the account owner. | An owner of the GitHub organization must approve the app. After they do, press Connect GitHub again. |
| That GitHub installation is already connected to another Lighthouse team. | Disconnect it from the other team first, or install the app on a different account. |
| That install didn't start from Lighthouse, so nothing was connected. | Return to Lighthouse and press Connect GitHub. |
| That connection link expired. Start again. | Press Connect GitHub again. |
| Installation paused | Someone suspended the app on GitHub. Re-enable it in the app's GitHub settings. Pull request scans resume. |
| A repository is missing from the list | Press Manage on GitHub, give the app access to it, then press Sync. |