Guide for GitLab
Integrate the AI Code Review Agent into your GitLab workflow.
Last updated
Integrate the AI Code Review Agent into your GitLab workflow.
Last updated
Bito Inc. (c) 2024
Speed up code reviews by configuring the AI Code Review Agent with your GitLab repositories. 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 GitLab Personal Access Token: For GitLab merge request code reviews, a token with api scope is required. View Guide
Authorizing a GitLab Personal Access Token for use with SAML single sign-on:
If your GitLab organization enforces SAML Single Sign-On (SSO), you must authorize your Personal Access Token through your Identity Provider (IdP); otherwise, Bito's AI Code Review Agent won't function properly.
For more information, please refer to these GitLab 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 GitLab, select GitLab to proceed.
To enable merge request reviews, you’ll need to connect your Bito workspace to your GitLab account.
Start by generating a Personal Access Token with api scope in your GitLab account. Once generated, enter the token into the Personal Access Token input field in Bito.
For guidance, refer to the instructions in the Prerequisites section.
We recommend setting the token expiration to at least one year. This prevents the token from expiring early and avoids disruptions in the AI Code Review Agent's functionality.
Additionally, we highly recommend updating the token before expiry to maintain seamless integration and code review processes.
Click Validate to ensure the token is functioning properly. If the token is successfully validated, you can select your GitLab Group from the dropdown menu.
Click Connect Bito to GitLab to proceed.
After connecting Bito to your GitLab account, 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 GitLab account.
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 merge requests and provides detailed feedback.
Manually trigger code review: To initiate a manual review, simply type /review in the comment box on the merge 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 merge 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 merge 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 merge 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 merge 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 merge request (MR) summary
Changelist showing key changes and impacted files in a merge request.
AI code review feedback posted as comments on the merge request.
