Skip to main content

GitHub App

The DriftWise GitHub App connects your GitHub organization to DriftWise for automatic PR commenting. This is separate from the GitHub Actions integration — the App handles the GitHub side (posting comments), while Actions handles the CI side (sending plan data).

What It Does​

When installed, the GitHub App:

  • Posts PR comments with plan analysis results (risk score, narrative, callouts)
  • Links repositories to your DriftWise org for automatic routing
  • Identifies PRs by repository owner for comment delivery

Installation​

1. Install the GitHub App​

Visit the DriftWise GitHub App page and install it on your GitHub organization or user account. Select which repositories to grant access to.

2. Register the installation in DriftWise​

After installing on GitHub, the dashboard's post-install redirect handles the DriftWise-side registration automatically. If you need to register manually, call POST /orgs/:id/github-installations with installation_id (the integer from GitHub's callback URL) and account_login (the GitHub org/user that installed the app). Owner/admin role required.

3. Configure webhooks​

Set up a webhook config for your CI provider (Atlantis, GitHub Actions, or GitLab CI). When plan data arrives via webhook, DriftWise uses the GitHub App installation to post comments back to the PR.

Managing installations​

List, register, and unlink installations via the org-scoped /github-installations endpoints. Removing an installation from DriftWise only clears the DriftWise-side record — to fully uninstall, also remove the app from your GitHub organization settings.

See the webhooks tag of the API reference for endpoint contracts (GitHub installations live under the same tag as webhook configs).

How It Fits Together​

GitHub PR → Atlantis/Actions → Webhook → DriftWise → Analysis → GitHub App → PR Comment
  1. A PR triggers a Terraform plan in your CI
  2. CI sends the plan to DriftWise via webhook
  3. DriftWise analyzes the plan (risk scoring, narrative)
  4. DriftWise uses the GitHub App to post a comment on the PR with results