From 0b32b253ca6f404a6f2280a1a463d0b2199379c5 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Mon, 21 Oct 2024 17:56:15 +0300 Subject: [PATCH 1/2] docs: update default setting for publish_labels to false and adjust related documentation --- README.md | 10 ++++++++++ docs/docs/tools/describe.md | 4 ++-- pr_agent/settings/configuration.toml | 2 +- pr_agent/tools/pr_description.py | 2 +- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 98a3fc1e2..92900cefe 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,16 @@ CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by p ## News and Updates +### October 21, 2024 +The default setting for `pr_description.publish_labels` has been updated to `false`. This means that labels generated by the `/describe` tool will no longer be published, unless this configuration is explicitly set to `true`. + +We constantly strive to balance informative AI analysis with reducing unnecessary noise. User feedback indicated that in many cases, the original PR title alone provides sufficient information, making the generated labels (`enhancement`, `documentation`, `bug fix`, ...) redundant. +The [`review_effort`](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options) label, generated by the `review` tool, will still be published by default, as it provides valuable information enabling reviewers to prioritize small PRs first. + +However, every user has different preferences. To still publish the `describe` labels, set `pr_description.publish_labels=true` in the [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/). +For more tailored and relevant labeling, we recommend using the [`custom_labels`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) tool, that allows generating labels specific to your project's needs. + + ### October 14, 2024 Improved support for GitHub enterprise server with [GitHub Actions](https://qodo-merge-docs.qodo.ai/installation/github/#action-for-github-enterprise-server) diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index bd24da1e3..6e8515b0e 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -34,7 +34,7 @@ pr_commands = [ ] [pr_description] -publish_labels = ... +publish_labels = true ... ``` @@ -49,7 +49,7 @@ publish_labels = ... - + diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index d4ecf3794..60858b010 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -75,7 +75,7 @@ maximal_review_effort=5 [pr_description] # /describe # -publish_labels=true +publish_labels=false add_original_user_description=true generate_ai_title=false use_bullet_points=true diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py index c965d84e7..169533a52 100644 --- a/pr_agent/tools/pr_description.py +++ b/pr_agent/tools/pr_description.py @@ -133,7 +133,7 @@ async def run(self): if get_settings().config.publish_output: # publish labels - if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"): + if get_settings().pr_description.publish_labels and pr_labels and self.git_provider.is_supported("get_labels"): original_labels = self.git_provider.get_pr_labels(update=True) get_logger().debug(f"original labels", artifact=original_labels) user_labels = get_user_labels(original_labels) From 1c6f7f9c064120aa52652df1de56439731b6d312 Mon Sep 17 00:00:00 2001 From: Tal Date: Tue, 22 Oct 2024 08:12:15 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92900cefe..8f26f56ec 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,22 @@ CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by p ## News and Updates ### October 21, 2024 +**Disable publishing labels by default:** + The default setting for `pr_description.publish_labels` has been updated to `false`. This means that labels generated by the `/describe` tool will no longer be published, unless this configuration is explicitly set to `true`. We constantly strive to balance informative AI analysis with reducing unnecessary noise. User feedback indicated that in many cases, the original PR title alone provides sufficient information, making the generated labels (`enhancement`, `documentation`, `bug fix`, ...) redundant. The [`review_effort`](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options) label, generated by the `review` tool, will still be published by default, as it provides valuable information enabling reviewers to prioritize small PRs first. However, every user has different preferences. To still publish the `describe` labels, set `pr_description.publish_labels=true` in the [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/). -For more tailored and relevant labeling, we recommend using the [`custom_labels`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) tool, that allows generating labels specific to your project's needs. +For more tailored and relevant labeling, we recommend using the [`custom_labels 💎`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) tool, that allows generating labels specific to your project's needs. + +![image](https://github.com/user-attachments/assets/8f38d222-53b1-4742-b2ec-7ea0a30c9076) + +→ + +![image](https://github.com/user-attachments/assets/8285bd90-0dda-4c7e-9237-bbfde5e21880) + ### October 14, 2024 @@ -65,7 +74,8 @@ New ability for the `review` tool - **ticket compliance feedback**. If the PR co ### September 21, 2024 Need help with PR-Agent? New feature - simply comment `/help "your question"` in a pull request, and PR-Agent will provide you with the [relevant documentation](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334). - +![image](https://github.com/user-attachments/assets/7c214d9c-e7bb-4028-83b6-9515d7310d19) +
publish_labelsIf set to true, the tool will publish the labels to the PR. Default is true.If set to true, the tool will publish labels to the PR. Default is false.
publish_description_as_comment