GitHub integration

Technical reference for Verify’s GitHub integration.

GitHub App

Verify uses the Aviator GitHub App for repository access.

Permissions

Permission
Access
Purpose

Repository contents

Read

Analyze code during verification

Pull requests

Read/Write

Post verification results, comments

Checks

Read/Write

Create PR status checks

Organization members

Read

Suggest reviewers

Metadata

Read

Basic repository info

Installation

The app can be installed with:

  • All repositories — Access to every repo in the org

  • Selected repositories — Access only to chosen repos

Change access in GitHub: Organization Settings → Installed GitHub Apps → Aviator → Configure

PR checks

Check name

Check statuses

Status
GitHub state
Description

Pending

queued

Verification not started

Running

in_progress

Verification running

Passed

success

All checks passed

Failed

failure

One or more checks failed

Error

failure

Verification error (not code failure)

Action required

action_required

Needs attention (e.g., no spec)

Check output

Title format:

or

Summary format:

Slash commands

Commands are triggered by PR comments.

Command
Action

/aviator verify

Trigger verification

/aviator link <spec-id>

Link spec to PR

/aviator status

Show verification status

Commands are case-insensitive. The bot responds with a confirmation comment.

PR comments

Failure comment

When verification fails, Aviator posts a summary comment:

Configure comments in Verify → Settings → Notifications.

Comment options

Option
Description
Default

Post on failure

Comment when verification fails

On

Post on pass

Comment when verification passes

Off

Update existing

Update previous comment vs new

On

Webhooks

Aviator sends webhooks for verification events.

Events

Event
Trigger

verification.started

Verification begins

verification.completed

Verification finishes

spec.approved

Spec is approved

Payload

Configure webhooks in Verify → Settings → Webhooks.

Branch protection

To require Verify:

  1. Repository Settings → Branches → Add rule

  2. Enable “Require status checks to pass”

  3. Search and select “Aviator Verify”

Auto-linking

Verify can automatically link specs to PRs.

Methods

Method
How it works

Branch name

Spec ID or title in branch name

PR description

Spec ID mentioned in description

Manual link

/aviator link command

Branch name patterns

PR description pattern

or

Rate limits

Operation
Limit

Verification runs

100/hour per repository

API requests

1000/hour per organization

Webhook deliveries

No limit

See also

Last updated

Was this helpful?