Guide for GitHub (Self-Managed)
Integrate the AI Code Review Agent into your self-hosted GitHub Enterprise workflow.
Last updated
Integrate the AI Code Review Agent into your self-hosted GitHub Enterprise workflow.
Last updated
Bito Inc. (c) 2024
Speed up code reviews by configuring the AI Code Review Agent with your self-managed GitHub Enterprise server. In this guide, you'll learn how to set up the Agent to receive automated code reviews that trigger whenever you create a pull request, as well as how to manually initiate reviews using available commands.
You need a Bito 10X Developer paid plan to get started. For more information about costs, please visit our Pricing Page.
coming soon...
Before proceeding, ensure you've completed all necessary prerequisites.
Create a GitHub Personal Access Token (classic): For GitHub pull request code reviews, ensure you have a CLASSIC personal access token with "repo" scope. We do not support fine-grained tokens currently. View Guide
Authorizing a GitHub Personal Access Token for use with SAML single sign-on:
If your GitHub organization enforces SAML Single Sign-On (SSO), you must authorize your Personal Access Token (classic) through your Identity Provider (IdP); otherwise, Bito's AI Code Review Agent won't function properly.
For detailed instructions, please refer to the GitHub documentation.
Follow the step-by-step instructions below to install the AI Code Review Agent using Bito Cloud:
Log in to Bito Cloud with a workspace subscribed to the Bito 10X Developer plan.
Navigate to the Code Review Agent setup page via the sidebar.
Bito supports integration with the following Git providers:
GitHub
GitHub (Self-Managed)
GitLab
GitLab (Self-Managed)
Bitbucket
Since we are setting up the Agent for self-managed GitHub Enterprise server, select GitHub (Self-Managed) to proceed.
Supported versions:
GitHub Enterprise Server: 3.0 and above
To enable pull request reviews, you need to register and install the Bito’s AI Code Review Agent app on your self-managed GitHub Enterprise server.
If your network blocks external services from interacting with the GitHub server, whitelist all of Bito's gateway IP addresses in your firewall to ensure Bito can access your self-hosted repository. The Agent response can come from any of these IPs.
List of IP addresses to whitelist:
18.188.201.104
3.23.173.30
18.216.64.170
You need to enter the details for the below mentioned input fields:
Hosted GitHub URL: This is the domain portion of the URL where you GitHub Enterprise Server is hosted (e.g., https://yourcompany.github.com). Please check with your GitHub administrator for the correct URL.
Personal Access Token: Generate a Personal Access Token (classic) with “repo” scope in your GitHub (Self-Managed) account and enter it into the Personal Access Token input field. We do not support fine-grained tokens currently. For guidance, refer to the instructions in the Prerequisites section.
Click Validate to ensure the login credentials are working correctly. If the credentials are successfully validated, click the Install Bito App for GitHub button. This will redirect you to your GitHub (Self-Managed) server.
Now select where you want to install the app:
Choose All repositories to enable Bito for every repository in your account.
Or, select Only select repositories and pick specific repositories using the dropdown menu.
Bito app uses these permissions:
Read access to code and metadata
Read and write access to issues and pull requests
Read access to organization members
Click Install & Authorize to proceed.
After connecting Bito to your self-managed GitHub Enterprise server, you need to enable the AI Code Review Agent for your repositories.
Click the Go to repository list button to view all repositories Bito can access in your self-managed GitHub Enterprise server.
Use the toggles in the Code Review Status column to enable or disable the agent for each repository.
To customize the Agent’s behavior, you can edit existing configurations or create new Agents as needed.
Once a repository is enabled, you can invoke the AI Code Review Agent in the following ways:
Automated code review: By default, the Agent automatically reviews all new pull requests and provides detailed feedback.
Manually trigger code review: To initiate a manual review, simply type /review in the comment box on the pull request and submit it. This action will start the code review process.
The AI-generated code review feedback will be posted as comments directly within your pull request, making it seamless to view and address suggestions right where they matter most.
Note: To enhance efficiency, the AI Code Review Agent is disabled by default for pull requests involving the "main" or "master" branches. This prevents unnecessary processing and token usage, as changes to these branches are typically already reviewed in release or feature branches. To modify this default behavior and include the "main" or "master" branches, you can use the Source or Target branch filter.
The AI Code Review Agent automatically reviews code changes up to 5000 lines when a pull request is created. For larger changes, you can use the /review command.
It may take a few minutes to get the code review posted as a comment, depending on the size of the pull request.
Bito also offers specialized commands that are designed to provide detailed insights into specific areas of your source code, including security, performance, scalability, code structure, and optimization.
/review security: Analyzes code to identify security vulnerabilities and ensure secure coding practices.
/review performance: Evaluates code for performance issues, identifying slow or resource-heavy areas.
/review scalability: Assesses the code's ability to handle increased usage and scale effectively.
/review codeorg: Scans for readability and maintainability, promoting clear and efficient code organization.
/review codeoptimize: Identifies optimization opportunities to enhance code efficiency and reduce resource usage.
By default, the /review command generates inline comments, meaning that code suggestions are inserted directly beneath the code diffs in each file. This approach provides a clearer view of the exact lines requiring improvement. However, if you prefer a code review in a single post rather than separate inline comments under the diffs, you can include the optional parameter: /review #inline_comment=False
For more details, refer to Available Commands.
AI-generated pull request (PR) summary
Changelist showing key changes and impacted files in a pull request.
AI code review feedback posted as comments on the pull request.
