diff --git a/README.md b/README.md index 26cb77d1..2c459ae5 100644 --- a/README.md +++ b/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: | | | | diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 3db21a13..d9402dec 100644 --- a/docs/DESCRIBE.md +++ b/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. diff --git a/docs/GENERATE_CUSTOM_LABELS.md b/docs/GENERATE_CUSTOM_LABELS.md index 5bab2e33..596ab5ba 100644 --- a/docs/GENERATE_CUSTOM_LABELS.md +++ b/docs/GENERATE_CUSTOM_LABELS.md @@ -22,7 +22,8 @@ To enable custom labels, you need to apply the [configuration changes](#configur #### 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. It should be formatted as follows: - ``` + +``` [config] enable_custom_labels=true diff --git a/docs/REVIEW.md b/docs/REVIEW.md index 5445ccdd..7f2f42cb 100644 --- a/docs/REVIEW.md +++ b/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: ``` diff --git a/docs/TOOLS_GUIDE.md b/docs/TOOLS_GUIDE.md index b3831961..545f6b27 100644 --- a/docs/TOOLS_GUIDE.md +++ b/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. \ No newline at end of file