Skip to content

GitHub App

The GitHub App is the foundation of reviewGOOSE. It provides:

  1. Real-time notifications: Sends PR events to Dashboard, Slack, and Goose instantly
  2. PR state tracking: Monitors CI status, approvals, and changes
  3. Turn-based tracking: Determines whose turn it is to act on each PR

Required for all other components to function.

Part of reviewGOOSE - Home | Getting Started | Dashboard | Slack | Goose

How It Works

When you create or update a PR:

  1. GitHub webhook fires and sends event to reviewGOOSE
  2. Real-time broadcast to Dashboard, Slack, and Goose (under 1 second)
  3. State tracking updates based on CI, approvals, and changes

Typical response time: Under 1 second

Installation

Free for Public Repositories

Access to public repositories is completely free. Start with 1-2 public repos to evaluate, then expand later if needed.

  1. Visit: reviewGOOSE Real-Time GitHub App

  2. Click Install

  3. Choose your installation scope:

    • Select Only select repositories
    • Pick 1-2 public repositories for testing
    • Click Install

    Why public repos? They're lower risk for evaluation and let you verify the functionality before expanding to private repositories.

    • Select All repositories (or choose specific repos)
    • Click Install

Verify Installation

Visit your dashboard, login with GitHub, and confirm PRs appear within seconds.

The app will automatically: - Enable real-time notifications for all selected repos - Track PR state changes

To add/remove repos later: GitHub Settings → Installed GitHub Apps → reviewGOOSE Real-Time GitHub App → Configure → Repository access

GitHub Permissions

Required permissions:

  • Pull requests: Read (track PR state)
  • Contents: Read (read .codeGROOVE configuration files)
  • Repository metadata: Read (repo names)
  • Organization members: Read (identify reviewers)

Note: Contents access is used only to read configuration files in your .codeGROOVE repository (like slack.yaml). We do not read source code in your other repositories.

Details: Security

Troubleshooting

PRs not appearing: Check if GitHub App installed on repo. Verify repository access in GitHub Settings → Installed GitHub Apps. Wait 60 seconds for sync.

Webhook failures: Go to Repository Settings → Webhooks. Check "Recent Deliveries" for errors.

Stale data: Hard refresh Dashboard (Ctrl+Shift+R). Data updates within 60 seconds of GitHub events.

Get Support →