Merge pull request #837 from Codium-ai/tr/persistent_describe

feat: add persistent comment option for PR descriptions
Codium-ai · Apr 2, 2024 · a13c6e9 · a13c6e9
2 parents dfe8301 + 9614f61
commit a13c6e9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md
@@ -27,6 +27,8 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
 
     - `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.
 
+    - `publish_description_as_comment_persistent`: if set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.
+
     - `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.

diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml
@@ -52,7 +52,6 @@ maximal_review_effort=5
 
 [pr_description] # /describe #
 publish_labels=true
-publish_description_as_comment=false
 add_original_user_description=true
 keep_original_user_title=true
 use_bullet_points=true
@@ -61,6 +60,9 @@ enable_pr_type=true
 final_update_message = true
 enable_help_text=false
 enable_help_comment=true
+# describe as comment
+publish_description_as_comment=false
+publish_description_as_comment_persistent=true
 ## changes walkthrough section
 enable_semantic_files_types=true
 collapsible_file_list='adaptive' # true, false, 'adaptive'

diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py
@@ -132,7 +132,14 @@ async def run(self):
                 # publish description
                 if get_settings().pr_description.publish_description_as_comment:
                     full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
-                    self.git_provider.publish_comment(full_markdown_description)
+                    if get_settings().pr_description.publish_description_as_comment_persistent:
+                        self.git_provider.publish_persistent_comment(full_markdown_description,
+                                                                     initial_header="## Title",
+                                                                     update_header=True,
+                                                                     name="describe",
+                                                                     final_update_message=False, )
+                    else:
+                        self.git_provider.publish_comment(full_markdown_description)
                 else:
                     self.git_provider.publish_description(pr_title, pr_body)