Skip to content

Git hosts

GitHub

Connect GitHub by installing the TryCodeBot GitHub App on the accounts that own your repositories.

Install the app

Connect

In the web app, go to Settings → Integrations and click Connect next to GitHub. You’ll be sent to GitHub to install the TryCodeBot app.

Pick the account and repositories

Choose the organization or user account that owns your repositories, then either All repositories or a selection. You can change the selection later from GitHub.

Turn on code review

Back in Codebot, open Code review → Add repository to choose which repositories get reviewed. Installing the app alone doesn’t review anything.

To connect more than one GitHub organization, click Add account and install the app again on the other organization.

What the app can access

The app asks for the permissions it needs to review and work on pull requests:

  • Contents, to clone the code it reviews and push the agent’s changes;
  • Pull requests, to post reviews, comments and replies, and to open pull requests;
  • Checks, to report each review as a check;
  • Issues, to read issues and answer @trycodebot comments;
  • Actions (read-only), so the agent can read CI logs when you ask about a failing check.

It only sees the repositories you installed it on. On GitHub, Codebot posts as TryCodeBot, marked as a bot.

When the app asks for a new permission after an update, an organization owner has to accept it in GitHub’s settings for the installation. Until then, the features that need it are limited.

Review command and mentions

  • @trycodebot review on a pull request runs a review. See Review on demand.
  • @trycodebot with anything else hands the request to the agent.

Both work for owners, members and collaborators of the repository.

Required checks

Codebot reports reviews as a check named Code review. To block merges on critical issues, see Checks and merge gate.

Disconnect

In Settings → Integrations → GitHub, open the ⋯ menu next to an account and choose Disconnect. Codebot uninstalls the app from that account and forgets its repositories, including their review settings and their runs. If another Codebot organization uses the same installation, the app stays installed for it.

Uninstalling the app on GitHub, under GitHub Apps in the account’s settings, does the same.