Skip to main content

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.

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.

​
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

1

Click Authorize GitHub

In your ewake dashboard → Integrations → GitHub → click Authorize GitHub.GitHub integration modal in ewake
2

Review and authorize

Review the permissions on GitHub’s authorization page → click Authorize.You’ll be redirected back to the ewake dashboard.

​
Part 2, GitHub App Installation

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

Click Install ewake GitHub App

In the ewake dashboard, click Install ewake GitHub App.
2

Select your organisation

Choose the organisation where ewake should be installed.
3

Choose repository access

Select repositories

Recommended. Grant access only to repos relevant to your production environment. More control, smaller footprint.

All repositories

Simpler to set up. ewake only reads repos relevant to an active investigation.
If using Select repositories, use this as a guide:
IncludeExclude
Service codeRepos 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 definitionsArchived or unused repos
4

Install

Click Install. You’ll be redirected back to ewake.
GitHub is connected. Ewake can now access your repositories and deployment history.
Ewake only requires read access to GitHub. It never writes to repositories, opens pull requests, pushes code, or modifies any data in your organisation.

​
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 → Install → select your organisation → choose repository access → Install.
OAuth authorization and the GitHub App installation are two separate and independent steps. Both are required.

Track deployments from GitHub Actions →

Send deployment events to ewake directly from your CI/CD pipeline.

What does ewake access in GitHub? →

Full read-only permission breakdown for the GitHub integration.