Skip to content

Commit b0f3d07

Browse files
Update README.md
1 parent dcef4c2 commit b0f3d07

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

bito-action-script/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ This document provides a step-by-step guide for setting up and running the Bito
1717

1818
### 3. Configure the CRA Agent
1919

20-
- 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](https://docs.bito.ai/) to create a Git access token.
21-
- 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.
20+
- **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](https://docs.bito.ai/) to create a Git access token.
21+
22+
- **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.
23+
24+
- **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.
2225

2326
### 4. Download Bito Action Script
2427

@@ -33,7 +36,6 @@ This document provides a step-by-step guide for setting up and running the Bito
3336
- agent_instance_secret=<your_agent_instance_secret>
3437
- pr_url=<your_git_repository_url> (Optional if using the runtime URL method)
3538

36-
3739
### 6. Run the Bito Action Script
3840

3941
You can run the Bito Action Script in two different ways, depending on your preference:
@@ -48,7 +50,6 @@ You can run the Bito Action Script in two different ways, depending on your pref
4850
```
4951
- Replace <pr_url> with the pull request URL you want to review.
5052

51-
5253
#### Option 2: Using Runtime Values
5354

5455
- Provide all necessary values directly in the command line:
@@ -74,21 +75,18 @@ During execution, the script will return various responses based on the success
7475
Success:- Job Started with Id : ce82fae8-05da-4389-bddc-86ed583ab053
7576
7677
```
77-
7878
### 2. Invalid Secret
7979
**Response:**
8080
```plaintext
8181
{"status":1,"response":"Secret is not valid","created":"2024-08-09T12:32:23.060340616Z"}
8282
8383
```
84-
8584
### 3. Invalid Instance URL
8685
**Response:**
8786
```plaintext
8887
{"status":1,"response":"webhook is invalid: Please create a new instance","created":"2024-08-09T12:33:07.050869506Z"}
8988
9089
```
91-
9290
### 4. Missing Input Data for Script
9391
**Response:**
9492
```plaintext

0 commit comments

Comments
 (0)