Skip to main content

GitHub

GitHub is used in two stages.

Codebase Indexing​

Phase 2 codebase indexing uses read-only access:

  • contents:read
  • metadata:read

Use this when you want Relay to include codebase summaries in technical discovery and task generation. After installing GitHub, select repositories in Settings > Integrations. Relay indexes selected repositories and updates them incrementally from push webhooks.

Current indexing support includes:

  • Python.
  • TypeScript and JavaScript.
  • Go.
  • Ruby.
  • Framework-scoped PHP: Composer-based Laravel, Symfony, and Slim.

Unsupported languages, unsupported PHP frameworks, stale indexes, and unsupported workspace graphs are surfaced as warnings instead of being treated as certain context.

Delivery Handoff​

Phase 4 delivery handoff requires write access:

  • contents:write
  • pull_requests:write
  • statuses:write
  • metadata:read

Use the write-permission upgrade only when implementation-pack branches, draft pull requests, and blueprint validation statuses are enabled.

GitHub is also used for blueprint pull requests. In blueprint-enabled workspaces, the blueprint repository is the source of truth for blueprint.md and relay.yaml.