xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-02 11:50:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update default setting for publish_labels to false and adjust related documentation

Browse Source
This commit is contained in:
mrT23
2024-10-21 17:56:15 +03:00
parent 3efd2213f2
commit 0b32b253ca
4 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -43,6 +43,16 @@ CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by p
## News and Updates ## 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 ### 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) Improved support for GitHub enterprise server with [GitHub Actions](https://qodo-merge-docs.qodo.ai/installation/github/#action-for-github-enterprise-server)

4
docs/docs/tools/describe.md
View File

@ -34,7 +34,7 @@ pr_commands = [
] ]
[pr_description] [pr_description]
publish_labels = ... publish_labels = true
... ...
``` ```
@ -49,7 +49,7 @@ publish_labels = ...
<table> <table>
<tr> <tr>
<td><b>publish_labels</b></td> <td><b>publish_labels</b></td>
<td>If set to true, the tool will publish the labels to the PR. Default is true.</td> <td>If set to true, the tool will publish labels to the PR. Default is false.</td>
</tr> </tr>
<tr> <tr>
<td><b>publish_description_as_comment</b></td> <td><b>publish_description_as_comment</b></td>

2
pr_agent/settings/configuration.toml
View File

@ -75,7 +75,7 @@ maximal_review_effort=5
[pr_description] # /describe # [pr_description] # /describe #
publish_labels=true publish_labels=false
add_original_user_description=true add_original_user_description=true
generate_ai_title=false generate_ai_title=false
use_bullet_points=true use_bullet_points=true

2
pr_agent/tools/pr_description.py
View File

@ -133,7 +133,7 @@ class PRDescription:
if get_settings().config.publish_output: if get_settings().config.publish_output:
# publish labels # 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) original_labels = self.git_provider.get_pr_labels(update=True)
get_logger().debug(f"original labels", artifact=original_labels) get_logger().debug(f"original labels", artifact=original_labels)
user_labels = get_user_labels(original_labels) user_labels = get_user_labels(original_labels)