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

# GitHub

> Track deployments, create and update issues, fetch commits, and enrich PR links with automatic status tracking for incident management.

Connect GitHub to Rootly to automate issue tracking, surface commit context during incidents, and capture deployment signals as they happen.

**This integration allows you to:**

* Create and update GitHub issues from incident workflows
* Fetch recent commits across repositories during an incident
* Receive push, pull request, and issue events as Rootly pulses
* Automatically enrich GitHub PR links shared in Slack with live status updates

## Before You Begin

<Callout icon="⚠️" color="#FEF3C7">
  You must be an **Owner** of your GitHub organization and an **Admin** of your Rootly account to complete this installation.

  We recommend using a **service account** so the integration continues to work if a user leaves your organization.
</Callout>

This integration uses a two-step process:

1. Install the **rootlyhq** GitHub App from the GitHub Marketplace
2. Connect GitHub to Rootly via OAuth

## Permissions

The following GitHub App permissions are required:

| Permission    | Access Level |
| ------------- | ------------ |
| Checks        | Read         |
| Code          | Read         |
| Deployments   | Read         |
| Metadata      | Read         |
| Pull Requests | Read         |
| Issues        | Read + Write |

## Installation

### Step 1: Install the GitHub Marketplace App

<Steps>
  <Step title="Open your organization's GitHub Apps page">
    Navigate to the GitHub Apps page for your organization. Replace `<your-organization-name>` with your organization's name:

    ```
    https://github.com/organizations/<your-organization-name>/settings/installations
    ```

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-1.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=b36d46867fcd9ec693b570408368c50f" width="1268" height="806" data-path="images/integrations/github/github/images-1.webp" />
    </Frame>

    Click **GitHub Marketplace**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-2.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=d790ec1ff5cfd36735160f0a7130cc55" width="971" height="507" data-path="images/integrations/github/github/images-2.webp" />
    </Frame>
  </Step>

  <Step title="Find and add the Rootly app">
    Search for **rootly** and click on the Rootly app.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-3.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=b6f63563c4514b0547c932876d9bd126" width="1387" height="488" data-path="images/integrations/github/github/images-3.webp" />
    </Frame>

    Click **Add** to begin the installation.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-4.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=9c62c6e0d319305360ef2d9168b6a050" width="1327" height="619" data-path="images/integrations/github/github/images-4.webp" />
    </Frame>
  </Step>

  <Step title="Select the correct organization">
    If you belong to multiple GitHub organizations, select the correct one and click **Install it for free**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-5.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=571bc16cc26843cf72ffac0e0e63346f" width="1134" height="380" data-path="images/integrations/github/github/images-5.webp" />
    </Frame>

    Confirm the correct organization is selected. Check **Allow my billing information to be linked with this organization** and click **Save**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-6.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=4e5bedce5c5fbf29048efa2138c6ded6" width="1063" height="801" data-path="images/integrations/github/github/images-6.webp" />
    </Frame>

    Click **Complete order and begin installation**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-7.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=019e6bc2e658d9eb4c00d34c8008a866" width="1119" height="699" data-path="images/integrations/github/github/images-7.webp" />
    </Frame>
  </Step>

  <Step title="Set repository scope and install">
    Select the desired **scope of access** (all repositories or specific repositories) and click **Install**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-8.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=cedf43ad993137d8ea1750e55bc0d8b5" width="631" height="800" data-path="images/integrations/github/github/images-8.webp" />
    </Frame>
  </Step>

  <Step title="Log out of GitHub">
    Log out of your GitHub account before proceeding. This is required so Rootly can re-establish the connection under the correct account.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-9.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=195b8dc2c07f8db44c54db20067da375" width="325" height="744" data-path="images/integrations/github/github/images-9.webp" />
    </Frame>
  </Step>
</Steps>

### Step 2: Connect GitHub to Rootly

<Steps>
  <Step title="Find GitHub in Rootly Integrations">
    Navigate to the [Integrations](https://rootly.com/account/integrations) page in Rootly and search for **github**.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-10.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=ffbab81e537037e4fb22a073e13821b8" width="1023" height="502" data-path="images/integrations/github/github/images-10.webp" />
    </Frame>
  </Step>

  <Step title="Authorize the connection">
    You'll be prompted to sign in to GitHub to authorize the connection to your organization.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-11.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=a5c2365dddb44b4e866dc7fe1d748046" width="445" height="626" data-path="images/integrations/github/github/images-11.webp" />
    </Frame>
  </Step>

  <Step title="Save the integration">
    Click **Save** to complete the setup.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-12.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=0018df07a82ef7f2b40543030d8c7d58" width="920" height="348" data-path="images/integrations/github/github/images-12.webp" />
    </Frame>

    <Callout icon="✅" color="#DCFCE7">
      GitHub is now connected. You can use the **Create Issue**, **Update Issue**, and **Get Commits** workflow actions, and GitHub events will begin flowing in as pulses.
    </Callout>
  </Step>
</Steps>

## Uninstall

Uninstalling requires two steps — removing the integration from Rootly and uninstalling the GitHub App.

<Steps>
  <Step title="Delete from Rootly">
    Delete the GitHub integration from Rootly via the **Integrations** page.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-13.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=8f068abd328d19c5caed134732ee6b3d" width="918" height="341" data-path="images/integrations/github/github/images-13.webp" />
    </Frame>
  </Step>

  <Step title="Uninstall from GitHub">
    Uninstall the **rootlyhq** app from your organization's GitHub Apps page.

    <Frame>
      <img alt="Document Image" src="https://mintcdn.com/rootly/7PwamMJIAOaYlZ7c/images/integrations/github/github/images-14.webp?fit=max&auto=format&n=7PwamMJIAOaYlZ7c&q=85&s=4417aeb09e7fb4f6a97e1b028a1797fd" width="1282" height="1254" data-path="images/integrations/github/github/images-14.webp" />
    </Frame>
  </Step>
</Steps>
