Skip to main content

GitHub

GitHub is used in two stages.

Codebase Indexing​

Codebase indexing uses read-only access:

  • contents:read
  • metadata:read

Use this when you want inrelay to include codebase summaries in pre-flight checks, repo-first Technical Discovery, discovery repo-scope suggestions, cited code-inferred discovery answers, Delivery Plan generation, repo/docs refinement, and Handoff Pack preparation. After installing GitHub, select repositories in Settings > Integrations. inrelay indexes selected repositories and updates them incrementally from push webhooks.

inrelay indexes an inventory of eligible source paths and concise summaries; it does not store full repository source contents. Full files are fetched transiently on demand only to derive bounded citations or selected handoff/refinement context when GitHub access allows it.

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. Generated, vendored, build output, dependency, binary, and oversized files may be excluded from the index. RELAY_REPO_SOURCE_INVENTORY_ENABLED controls the expanded source inventory rollout.

Handoff Publishing​

Blueprint pull requests and GitHub Handoff Pack publishing require write access:

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

Use the write-permission upgrade only when automated Blueprint PR creation or update, blueprint validation statuses, or explicit Handoff Pack publishing to draft pull requests are enabled. GitHub write permissions are not required for PRD review, discovery search scope, draft task shaping, or Send to Linear.

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. inrelay can draft or update the Blueprint PR and validate it automatically, but GitHub review and merge remain explicit. inrelay does not auto-approve, auto-merge, dismiss reviews, or publish Handoff Packs without an explicit action. Use Refresh from GitHub only when inrelay's displayed Blueprint PR state looks stale.