Skip to content

DocsConfiguration

Turn a fix into a pull request

Connect a GitHub App so proposed repairs arrive where your team already reviews.

About 8 min read

With a repository connected, the product can read the relevant source while analysing, and open a branch and pull request carrying a proposed repair. It never pushes to your default branch.

1. Create a GitHub App (once, by an administrator)

Go to GitHub → Settings → Developer settings → GitHub Apps → New GitHub App.

FieldValue
Homepage URLThe address of your instance
Callback URLhttps://your-instance/projects/github/callback
Setup URLhttps://your-instance/projects/github/callback
Webhook URLhttps://your-instance/api/github-app/webhook
Webhook secretA random string — keep a copy
Request user authorization (OAuth)Off

Then generate a private key and download it.

Developing on localhost? Use http://localhost:3000/projects/github/callback and tunnel the webhook with smee.io or ngrok to http://localhost:3001/api/github-app/webhook.

2. Store the credentials

Open Settings → GitHub App and paste the App ID, client ID, private key, and webhook secret. The private key is encrypted before it is stored and never returned by the API.

3. Connect a project

  1. Open Project → Edit → Git integration.
  2. Press Connect GitHub App and install it on the organisation or repository.
  3. GitHub sends you back with an installation ID, which is saved against that project only — one project cannot use another's installation.
  4. Choose the repository, the default branch, and optionally a source path prefix such as src/.

4. Use it on an incident

Open an incident with a suggested fix and press Create pull request. A branch is created, the change is committed, and the pull request link appears on the incident so the review trail stays attached to the evidence.

Review the diff like any other pull request. The proposal is generated; the approval is yours.