Getting Started
Connect a Repository
Link your GitHub repositories to Assay for automated code review
Connect a Repository
Assay integrates with GitHub as a GitHub App. Here's how to connect your repositories.
Connecting Your First Repository
- Navigate to Repositories in your dashboard sidebar
- Click the Connect Repository button
- You'll see a list of repositories from your GitHub account
- Click Connect next to the repository you want to enable
Once connected, Assay will:
- Install webhook listeners for PR events
- Start monitoring for new pull requests
- Be ready to review on your next PR
Repository Permissions
Assay requires the following GitHub permissions:
| Permission | Purpose |
|---|---|
| Read repository contents | Analyze code context during reviews |
| Read pull requests | Access PR diffs and metadata |
| Write pull request comments | Post review findings |
| Read repository metadata | Display repo info in dashboard |
Managing Connected Repositories
Pause a Repository
If you want to temporarily stop reviews without disconnecting:
- Go to Repositories
- Find the repository and click the menu (⋮)
- Select Pause
Paused repositories won't trigger automatic reviews, but you can still run manual reviews.
Disconnect a Repository
To completely remove a repository from Assay:
- Go to Repositories
- Find the repository and click the menu (⋮)
- Select Disconnect
This removes the webhook and stops all monitoring. Your review history is preserved.
Organization Repositories
To connect organization repositories:
- Ensure you have admin access to the organization
- The organization owner may need to approve Assay's GitHub App installation
- Once approved, organization repos will appear in your available repositories
Troubleshooting
Repository not appearing?
- Ensure you have push access to the repository
- For organization repos, check if the GitHub App needs approval
- Try refreshing your GitHub connection in Settings
Webhooks not working?
- Check that the repository is not paused
- Verify the GitHub App is still installed on the repo
- Review recent webhook deliveries in GitHub's repo settings