Code review requires an organization-level AI model key. Upsun Dispatch supports model keys for OpenAI and Anthropic. If you have not added one yet, store it before running your first review. See AI models.
Before you start
You need:- Access to the Upsun Dispatch organization you want to connect.
- Permission in GitHub to install or configure the Upsun Dispatch GitHub App for the repositories you want Upsun Dispatch to review.
- An organization model key stored for OpenAI or Anthropic. See AI models.
Connect a GitHub installation
1
Open GitHub integration settings
In the Upsun Dispatch console, open your organization settings, then go to integrations and choose GitHub.
2
Start the GitHub App install
Select the action to install or connect the GitHub App. Upsun Dispatch sends you to GitHub to choose the account and repositories for the installation.
3
Approve the installation in GitHub
Complete the GitHub authorization and installation flow. GitHub returns you to Upsun Dispatch when the setup callback is complete.
4
Link the installation to your organization
After GitHub redirects you back, Upsun Dispatch links the installation to the organization you started from. Once linked, Upsun Dispatch refreshes repository information so connected repositories can appear in the console.
Recover a pending installation
If you install the GitHub App but do not finish linking it to a Upsun Dispatch organization, Upsun Dispatch can show it as a pending installation. Return to your organization’s GitHub integration settings and link the pending installation from there. For a smooth recovery:- Sign in to Upsun Dispatch with the same user who completed the GitHub setup.
- Link the installation to the intended organization.
- If Upsun Dispatch reports that the installation is already linked elsewhere, disconnect it from that organization first or choose a different installation.
Disconnect or relink GitHub
You can disconnect a GitHub installation from the organization’s integration settings. Disconnecting in Upsun Dispatch detaches the installation from the organization. It does not uninstall the GitHub App in GitHub, and Upsun Dispatch preserves history so the installation can be linked again later. To relink, start the GitHub setup again or use the pending installation flow if the installation is available for recovery.How GitHub code review runs start
After GitHub is connected, the built-in Code review workflow can run on pull requests in connected repositories. Upsun Dispatch supports both automatic and manual review starts:- Automatic reviews run when a pull request is opened or updated on a connected GitHub repository, as long as the repository’s workflow trigger mode is automatic.
- Manual reviews run when you comment a whole-message command on a pull request, such as
@upsun-dispatch review. - Full reviews run when you comment
@upsun-dispatch full reviewon a pull request. - Cancellations run when you comment
@upsun-dispatch cancelon a pull request.
GitHub commands must be whole-message commands addressed to the Upsun Dispatch bot. Comments that are not addressed commands are ignored.