diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index e0de5153..06e7bc68 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -23,13 +23,13 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen !!! example "Possible configurations" - - `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true. + - `disable_publish_labels`: if set to true, the tool will not publish the labels to the PR. Default is false. - `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false. - `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is true. - - `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is true. + - `generate_ai_title`: if set to true, the tool will automatically generate a title for the PR. If false, it will keep the original title. Default is false. - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". @@ -37,7 +37,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen - `enable_pr_type`: if set to false, it will not show the `PR type` as a text value in the description content. Default is true. - - `final_update_message`: if set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true. + - `disable_final_update_message`: if set to true, the tool will skip adding a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false. - `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true. - `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive". diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 837c71d3..b6c32a0d 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -51,14 +51,14 @@ maximal_review_effort=5 [pr_description] # /describe # -publish_labels=true +disable_publish_labels=false publish_description_as_comment=false add_original_user_description=true -keep_original_user_title=true +generate_ai_title=false use_bullet_points=true extra_instructions = "" enable_pr_type=true -final_update_message = true +disable_final_update_message = false enable_help_text=false enable_help_comment=true ## changes walkthrough section diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py index 7500efa7..d23698c8 100644 --- a/pr_agent/tools/pr_description.py +++ b/pr_agent/tools/pr_description.py @@ -95,7 +95,7 @@ class PRDescription: self.file_label_dict = self._prepare_file_labels() pr_labels, pr_file_changes = [], [] - if get_settings().pr_description.publish_labels: + if not get_settings().pr_description.disable_publish_labels: pr_labels = self._prepare_labels() if get_settings().pr_description.use_description_markers: @@ -118,7 +118,7 @@ class PRDescription: if get_settings().config.publish_output: # publish labels - if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"): + if (not get_settings().pr_description.disable_publish_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) @@ -137,7 +137,7 @@ class PRDescription: self.git_provider.publish_description(pr_title, pr_body) # publish final update message - if (get_settings().pr_description.final_update_message): + if (not get_settings().pr_description.disable_final_update_message): latest_commit_url = self.git_provider.get_latest_commit_url() if latest_commit_url: pr_url = self.git_provider.get_pr_url() @@ -294,7 +294,7 @@ class PRDescription: # Remove the 'PR Title' key from the dictionary ai_title = self.data.pop('title', self.vars["title"]) - if get_settings().pr_description.keep_original_user_title: + if not get_settings().pr_description.generate_ai_title: # Assign the original PR title to the 'title' variable title = self.vars["title"] else: