> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Required. How Ordyn reads your code, reviews pull requests, and opens fixes.

**1. Connect**

Go to **Connections**, click **Connect** next to GitHub, and install the Ordyn GitHub App.

**2. Choose repositories**

Enable the repositories Ordyn should read. Start with one if you want to test the workflow first.

**3. Pick a default repository**

In the GitHub connection settings, select the repository Auto Monitors should work on. Pull request reviews, monitor creation, and deploy verification apply to this repository.

## What Ordyn does with GitHub

* Reads code and recent commits during investigations and indexes the repository for search.
* Posts one review per pull request with the monitors it expects to create. See [Pull requests](/detect/pull-requests).
* Listens for GitHub Deployments to know when a change reached production. This needs the **Deployments: Read-only** permission and the **Deployment statuses** webhook. Existing installations are asked to approve it once. See [Deploys](/detect/deploys).
* Creates branches and opens pull requests for fixes. See [Fix with Ordyn](/fix/overview).

## Permissions

Install the Ordyn GitHub App on the repositories Ordyn should read and approve its requested permissions.

### Code and pull requests

Read code, open fix branches and pull requests, and review pull requests.

| Permission | Used for |
| - | - |
| `contents: write` | Reading code and pushing fix branches |
| `pull_requests: write` | Opening fix pull requests and posting reviews |
| `issues: write` | Assigning pull requests (GitHub assignees use the Issues API) |
| `metadata: read` | Listing repositories |
| `checks: read` | Reading CI results on Ordyn's pull requests |
| `actions: read` | Reading workflow runs and deployment environments |

### Deployments

Know when a change reached production, so Auto Monitors can verify the deploy.

| Permission | Used for |
| - | - |
| `deployments: read` | Also needs the Deployment statuses webhook event. Existing installations are asked to approve it once. |

### Repository webhooks

Add a deployment webhook to a repository. Only needed if you set up deploy detection that way.

Permissions: `repository_hooks: write`.

* Ordyn does not push to protected branches or merge.
* Ordyn receives these webhook events: pull requests, pull request reviews and review comments, issue comments, installations and deployment statuses.

Permission catalog version `2026-10-16.1`. See [permission changes](/reference/permission-changes).

GitHub only for now. GitLab and Bitbucket are not supported.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.