Agent Configuration: bito-cra.properties File
Setting up your agent: understanding the bito-cra.properties file
Note: This file is only available for people who are using the self-hosted version of AI Code Review Agent.
The bito-cra.properties file offers a comprehensive range of options for configuring the AI Code Review Agent, enhancing its flexibility and adaptability to various workflow requirements.
bito-cra.properties Available Options
Property Name | Supported Values | Is Mandatory? | Description |
---|---|---|---|
mode |
| Yes | Whether to run the Docker container in CLI mode for a one-time code review or as a webhooks service to continuously monitor for code review requests. |
pr_url | Pull request URL in GitLab, GitHub and Bitbucket | Yes, if the mode is CLI. | The pull request provides files with changes and the actual code modifications.
When the
This release only supports webhook calls; other REST API calls are not yet supported. |
code_feedback |
| No | Setting it to |
bito_cli.bito.access_key | Yes | Bito Access Key is an alternative to standard email and OTP authentication. | |
git.provider |
| Yes, if the mode is CLI. | The name of git repository provider. |
git.access_token | A valid Git access token provided by GITLAB or GITHUB or BITBUCKET | Yes | You can use a personal access token in place of a password when authenticating to GitHub/GitLab/BitBucket in the command line or with the API. |
git.domain | A URL where Git is hosted. | No | It is used to enter the custom URL of self-hosted GitHub/GitLab Enterprise. |
static_analysis |
| No | Enable or disable FBInfer based static code analysis, which is used to uncover functional issues in the code. |
dependency_check |
| No | This feature is designed to identify security vulnerabilities in open-source dependency packages, specifically for JS/TS/Node.JS and GoLang. Without this input, reviews for security vulnerabilities will not be conducted. |
dependency_check.snyk_auth_token | A valid authentication token for accessing Snyk's cloud-based security database. | No | If not provided, access to Snyk's cloud-based security database for checking security vulnerabilities in open-source dependency packages will not be available. |
server_port | A valid and available TCP port number. | No | This is applicable when the |
review_comments |
| No | Set the value to
The default value is |
review_scope |
| No | Specialized commands to perform detailed analyses on specific aspects of your code. You can provide comma-separated values to perform multiple types of code analysis simultaneously. Learn more |
exclude_branches | Glob/regex pattern. | No | This filter allows users to skip automated reviews for pull requests based on the source or target branch. This filter is useful in scenarios where automated reviews are unnecessary or could potentially disrupt the workflow. You can specify additional branches using a comma-separated list or string patterns (glob/regex). By default, |
exclude_files | Glob/regex pattern. | No | A list of files/folders that the AI Code Review Agent will not review if they are present in the diff. By default, these files are excluded: |
exclude_draft_pr |
| No | A binary setting that enables/disables automated review of pull requests (PR) based on the draft status.
The default value is |
Last updated