Configuration YAML

Configure review stages, environments, and permissions.

Use ellipsis.kind: code_review in code_review.yaml. The file customizes a pipeline; the dashboard toggle enables reviews.

Minimal configuration

.ellipsis/code_review.yaml
ellipsis:
  kind: code_review
  name: repository-review

This uses the built-in description agent and bug reviewer.

Stage behavior

FieldShapeDefault
pre_reviewList of agentsEmpty
descriptionOne agent or []Pull request description agent
reviewList of agents, at most eightOne bug reviewer
filterOne agent or []Empty
post_reviewList of agentsEmpty

Pre-review runs first. Description and review work follow. The gatekeeper filters findings before posting; post-review work follows the review.

An omitted stage inherits its default. A configured stage replaces the whole stage. An empty list disables it.

description: []
filter: []

This leaves review enabled and disables description updates and filtering.

Pull request descriptions

.ellipsis/code_review.yaml
ellipsis:
  kind: code_review
  name: concise-descriptions

description:
  name: summarize-change
  harness:
    type: claude_code
    model: claude-haiku-4-5-20251001
  instructions: |
    Summarize the behavior changed by this pull request.
    Include the affected modules and tests run.
    Preserve human-written context outside the summary.
  budget: 2

The description stage updates Ellipsis's summary in the pull request body. Disabling it stops future updates without removing an existing summary.

Pre-review filtering

.ellipsis/code_review.yaml
ellipsis:
  kind: code_review
  name: relevance-check

pre_review:
  - name: generated-only
    harness:
      type: claude_code
    instructions: |
      Check whether every changed file is generated output.
      Cancel review only when all changes are generated.
      Continue if any source code, test, or configuration changed.
    budget: 1

A deliberate pre-review cancellation marks the range covered. Prefer path filters when a static rule is sufficient.

Environment

environment:
  variables:
    - name: NODE_ENV
      value: test
  image:
    setup: |
      cd /sandbox/api-repo
      npm ci
  compute:
    cpu: 2
    memory: 8GB

Every stage receives the pipeline environment. A stage can override individual environment fields. The pull request repository is always cloned; add repositories only when the review needs more context.

Use Environment YAML for the shared field definitions.

Permissions

permissions:
  github:
    permissions: read_only

Stage GitHub credentials are read-only for review work. Ellipsis posts comments and description updates separately. Reviews do not approve, request changes, merge pull requests, or push commits.

Pipeline permissions merge with stage permissions, subject to the review credential restrictions.

Fields

FieldMeaning
ellipsis.kindRequired code_review
ellipsis.nameName shown for the configuration
ellipsis.enabledWhether this file participates in configuration selection
pull_requestsRepository, branch, path, label, draft, and author filters
environmentShared inline environment
permissionsShared GitHub and Ellipsis permissions
pre_review, description, review, filter, post_reviewStage agents
budgetRun allocation and trailing pipeline limits

An agent accepts name, harness, instructions, and optional environment, permissions, and budget. Review-stage agents may add pull_requests filters.

skills is part of the schema but is currently unavailable for session starts. Review agents do not declare automation triggers or custom output schemas.

environment, permissions, and budget merge field by field with defaults. A repository's file does not merge with the organization's file.

See Review scope, Custom reviewers, and Budgets.

On this page

Schedule a demo