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

# GitHub

> Connect GitHub to let ewake correlate production issues with deployments and code changes.

<Info>
  **What you'll get:** After connecting GitHub, ewake can correlate incidents with deployments, surface the diff that likely caused a regression, and explain code changes during an investigation.
</Info>

***

## Prerequisites

* A GitHub account with **admin access** to your organisation
* Access to your ewake dashboard

***

## Configuration

The GitHub integration has two parts: **OAuth authorization** (user-level) and **GitHub App installation** (organisation-level). Both are required.

### Part 1, OAuth Authorization

<Steps>
  <Step title="Click Authorize GitHub">
    In your ewake dashboard → **Integrations** → **GitHub** → click **Authorize GitHub**.

    <img src="https://mintcdn.com/ewakeai/M1QmRrA-jDM2VkcE/images/integrations/code/github/connect-modal.png?fit=max&auto=format&n=M1QmRrA-jDM2VkcE&q=85&s=36b0d2729fddcaa378475569d700a71b" alt="GitHub integration modal in ewake" style={{ maxHeight: "320px", objectFit: "cover", objectPosition: "top", borderRadius: "8px" }} width="551" height="715" data-path="images/integrations/code/github/connect-modal.png" />
  </Step>

  <Step title="Review and authorize">
    Review the permissions on GitHub's authorization page → click **Authorize**.

    You'll be redirected back to the ewake dashboard.
  </Step>
</Steps>

### Part 2, GitHub App Installation

OAuth alone doesn't grant access to organisation repositories. The GitHub App installation is a separate step.

<Steps>
  <Step title="Click Install ewake GitHub App">
    In the ewake dashboard, click **Install ewake GitHub App**.
  </Step>

  <Step title="Select your organisation">
    Choose the organisation where ewake should be installed.
  </Step>

  <Step title="Choose repository access">
    <CardGroup cols={2}>
      <Card title="Select repositories" icon="list-check">
        **Recommended.** Grant access only to repos relevant to your production environment. More control, smaller footprint.
      </Card>

      <Card title="All repositories" icon="layer-group">
        Simpler to set up. ewake only reads repos relevant to an active investigation.
      </Card>
    </CardGroup>

    If using **Select repositories**, use this as a guide:

    | Include                                    | Exclude                                 |
    | ------------------------------------------ | --------------------------------------- |
    | Service code                               | Repos containing secrets or credentials |
    | Deployment configs (Helm, k8s manifests)   | Customer data or PII repositories       |
    | Infrastructure as code (Terraform, Pulumi) | Audit or compliance-only repos          |
    | CI/CD pipeline definitions                 | Archived or unused repos                |
  </Step>

  <Step title="Install">
    Click **Install**. You'll be redirected back to ewake.

    <Check>
      GitHub is connected. Ewake can now access your repositories and deployment history.
    </Check>

    <Note>
      Ewake only requires **read access** to GitHub. It never writes to repositories, opens pull requests, pushes code, or modifies any data in your organisation.
    </Note>
  </Step>
</Steps>

***

## Can't see your org repositories?

If you've authorized via OAuth but org repos aren't appearing, the GitHub App installation is missing.

Go to [github.com/apps/ewake-github](https://github.com/apps/ewake-github) → **Install** → select your organisation → choose repository access → **Install**.

<Note>
  OAuth authorization and the GitHub App installation are two separate and independent steps. Both are required.
</Note>

***

<CardGroup cols={2}>
  <Card title="Track deployments from GitHub Actions →" icon="rocket" href="/integrations/deployment/deployment-tracking">
    Send deployment events to ewake directly from your CI/CD pipeline.
  </Card>

  <Card title="What does ewake access in GitHub? →" icon="shield-halved" href="/security/permissions#github">
    Full read-only permission breakdown for the GitHub integration.
  </Card>
</CardGroup>