Merge pull request #406 from Codium-ai/hl/custom_labels

Add documentation to custom labels

README.md

@@ -31,6 +31,8 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
 ‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues
 \
 ‣ **Add Documentation ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to un-documented functions/classes in the PR.
+\
+‣ **Generate Custom Labels ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
 
 See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different platforms.
 
@@ -115,6 +117,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif
 |       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |       |
 |       | Find similar issue                          |   :white_check_mark:    |                         |                             |          |          |       |
 |       | Add Documentation                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
+|       | Generate Labels                           |   :white_check_mark:    |   :white_check_mark:    |         |     |          |      |
 |       |                                             |        |        |      |      |      |
 | USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |
 |       | App / webhook                               |   :white_check_mark:    |   :white_check_mark:    |           |          |          |

docs/DESCRIBE.md

@@ -26,7 +26,7 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti
 - `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is false.
 
 - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
-
+- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes)
 ### Markers template
 
 markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.

docs/GENERATE_CUSTOM_LABELS.md

@@ -1,5 +1,5 @@
 # Generate Custom Labels
-The `generte_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
+The `generate_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
 
 It can be invoked manually by commenting on any PR:
 ```
@@ -10,26 +10,27 @@ For example:
 If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
 
 <kbd><img src=./../pics/custom_labels_list.png width="768"></kbd>
-When running the `generte_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
+When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
 <kbd><img src=./../pics/custom_label_published.png width="768"></kbd>
 
-### Configuration options
+### How to enable custom labels
-To enable custom labels, you need to add the following configuration to the [custom_labels file](./../pr_agent/settings/custom_labels.toml):
+#### CLI
+To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the [custom_labels file](./../pr_agent/settings/custom_labels.toml):
+#### Github Action and Gihub App
+To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the `.pr_agent.toml` file in you repository.
+
+#### Configuration changes
  - Change `enable_custom_labels` to True: This will turn off the default labels and enable the custom labels provided in the custom_labels.toml file.
- - Add the custom labels to the custom_labels.toml file. It should be formatted as follows:
+ - Add the custom labels. It should be formatted as follows:
- ```
+
+```
+[config]
+enable_custom_labels=true
+
 [custom_labels."Custom Label Name"]
 description = "Description of when AI should suggest this label"
-```
- - You can add modify the list to include all the custom labels you wish to use in your repository.
 
-#### Github Action
+[custom_labels."Custom Label 2"]
-To use the `generte_labels` tool with Github Action:
+description = "Description of when AI should suggest this label 2"
-
-- Add the following file to your repository under `env` section in `.github/workflows/pr_agent.yml`
-- Comma separated list of custom labels and their descriptions
-- The number of labels and descriptions should be the same and in the same order (empty descriptions are allowed):
 ```
-CUSTOM_LABELS: "label1, label2, ..."
+
-CUSTOM_LABELS_DESCRIPTION: "label1 description, label2 description, ..."
-```

docs/REVIEW.md

@@ -25,6 +25,7 @@ Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings
 - `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
 - `automatic_review`: if set to false, no automatic reviews will be done. Default is true.
 - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes) 
 ####  Incremental Mode
 For an incremental review, which only considers changes since the last PR-Agent review, this can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again, the following command can be used:
 ```

docs/TOOLS_GUIDE.md

@@ -6,5 +6,6 @@
 - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
 - [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
 - [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md)
+- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md)
 
 See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent.