This document provides a step-by-step guide for setting up and running the Bito Action Script. The Bito Action Script allows you to configure and run automated code reviews using the Bito Code Review Agent (CRA). It enables you to seamlessly integrate the CRA into your Continuous Integration/Continuous Deployment (CI/CD) pipeline. Follow the instructions below to configure and execute the script successfully.

• Navigate to the Bito platform: Bito Login.
• Use your credentials to log in to your account.

• After logging in, go to Configured Agents.
• Select Code Review Agent (CRA).
• Click on Create New Instance.

• Git Access Token: During the setup process, you'll need to provide a Git access token to allow the CRA to access your repositories. Please refer to Bito Documentation to create a Git access token.

• Agent Credentials: After a successful configuration, you'll receive a unique Agent Instance URL and Agent Instance Secret. These credentials are essential for configuring the Bito Action Script.

• Webhook Configuration: After configuring the CRA, set up the webhook in your selected Git provider. This webhook is necessary to gather analytical data, such as acceptance rates and feedback. Please refer to Webhook Configuration Documentation.

• Download the Bito Action Script and a sample configuration file from the following repository: Bito Action Script on GitHub.

• Open the bito_action.properties file located in the downloaded script folder.

• Update the following properties with the information provided during the CRA configuration:

  • agent_instance_url=<your_agent_instance_url>
  • agent_instance_secret=<your_agent_instance_secret>
  • pr_url=<your_git_repository_url> (Optional if using the runtime URL method)

You can run the Bito Action Script in two different ways, depending on your preference:

• Ensure the bito_action.properties file is updated with the correct values.

• Run the following command:

  bash ./bito_actions.sh bito_action.properties pr_url=<pr_url>

  • Replace <pr_url> with the pull request URL you want to review.

• Provide all necessary values directly in the command line:

  bash ./bito_actions.sh agent_instance_url=<agent_instance_url> agent_instance_secret=<secret> pr_url=<pr_url>

  • Replace <agent_instance_url>, , and <pr_url> with your specific values.

• Incorporate the Bito Action Script into your CI/CD pipeline by including the appropriate commands in your build or deployment scripts.

• This integration ensures that code reviews are automatically triggered as part of the pipeline, enhancing your development workflow by enforcing code quality checks on every code change.

During execution, the script will return various responses based on the success or failure of the process. Below are the possible responses:

Response:

Success:- Job Started with Id : ce82fae8-05da-4389-bddc-86ed583ab053

Response:

{"status":1,"response":"Secret is not valid","created":"2024-08-09T12:32:23.060340616Z"}

Response:

{"status":1,"response":"webhook is invalid: Please create a new instance","created":"2024-08-09T12:33:07.050869506Z"}

Response:

Error: pr_url is empty

Below is a sample bito_action.properties file:

agent_instance_url=your_agent_instance_url
agent_instance_secret=your_agent_secret
pr_url=

You are now ready to use the Bito Action Script for automated code reviews through CI/CD Pipelines. Ensure all configurations are correct before running the script. If you encounter any issues, consult the Bito Documentation or reach out to Bito support for assistance.