Skip to content

github-app.md

Latest commit

 

History

History
109 lines (75 loc) · 2.68 KB

github-app.md

File metadata and controls

109 lines (75 loc) · 2.68 KB

CodeDecay GitHub App

The CodeDecay GitHub App is an optional hosted surface for teams that want CodeDecay to run automatically on pull requests.

The app does not replace the CLI or GitHub Action. The open-source CLI remains local-first and useful without the hosted app.

What the app does

For pull request events, the app:

  1. receives a GitHub webhook,
  2. creates an in-progress CodeDecay check run,
  3. checks out the pull request into a temporary directory,
  4. runs deterministic CodeDecay analysis,
  5. posts or updates one PR comment,
  6. completes the check run.

For the first hosted version, the app only runs deterministic PR analysis. It does not run project commands, deployment commands, LLM calls, model calls, or CodeDecayCloud services.

GitHub App settings

Create a GitHub App in the GitHub organization that will own the hosted app.

Set the webhook URL to:

https://<render-service-host>/github/webhooks

Subscribe to these events:

  • Pull request

Use these repository permissions:

  • Metadata: read-only
  • Contents: read-only
  • Pull requests: read-only
  • Issues: read and write
  • Checks: read and write

The Issues permission is required because GitHub PR comments use the Issues API.

Render deployment

Create a Render Web Service connected to this repository.

Build command:

pnpm install --frozen-lockfile && pnpm --filter @submuxhq/codedecay-github-app build

Start command:

pnpm --filter @submuxhq/codedecay-github-app start

Required environment variables:

GITHUB_APP_ID=<numeric app id>
GITHUB_PRIVATE_KEY=<GitHub App private key PEM>
GITHUB_WEBHOOK_SECRET=<webhook secret configured in GitHub>
NODE_ENV=production

Optional environment variables:

PORT=3000
GITHUB_WEBHOOK_PATH=/github/webhooks

If the private key is stored with escaped newlines, the service converts \n back to PEM newlines at startup.

First staging test

Before installing the app broadly:

  1. install the GitHub App on a test repository,
  2. open a harmless documentation-only PR,
  3. confirm the CodeDecay check run appears,
  4. confirm one PR comment is created,
  5. push another commit to the PR,
  6. confirm the existing CodeDecay comment is updated instead of duplicated.

Do not enable branch protection around the app until the staging PR behavior is verified.

Safety boundary

The hosted app intentionally has a narrow v0 boundary:

  • no telemetry,
  • no LLM or model calls,
  • no arbitrary command execution,
  • no project test/start/deploy command execution,
  • no persisted repository checkout,
  • temporary checkout directories are removed after analysis.

Future hosted execution or red-team behavior should require a separate design and sandboxing review.