Remove functionality and references to 'remove_previous_review_comment' by mrT23 · Pull Request #732 · The-PR-Agent/pr-agent

mrT23 · 2024-03-03T09:25:02Z

Type

enhancement

Description

Removed the remove_previous_review_comment option across the codebase, simplifying the PR review process.
Updated documentation and examples to reflect the removal of the remove_previous_review_comment option.
Simplified the logic in pr_reviewer.py for handling PR review comments.

Changes walkthrough

Relevant files

Enhancement

pr_reviewer.py `Simplify PR Review Comment Handling` pr_agent/tools/pr_reviewer.py Removed the functionality and references to the `remove_previous_review_comment` option. Simplified the logic for publishing PR reviews and handling previous comments.	+2/-6

Documentation

Usage.md `Update Documentation for PR-Agent Configuration` Usage.md Updated the documentation to reflect the removal of `remove_previous_review_comment` option. Simplified the example configuration for the PR-Agent usage.	+2/-6
REVIEW.md `Documentation Update for Review Tool` docs/REVIEW.md Removed the reference to the `remove_previous_review_comment` option in the review tool documentation.	+0/-1

Configuration changes

configuration.toml `Configuration Simplification by Removing Unused Option` pr_agent/settings/configuration.toml Removed the `remove_previous_review_comment` configuration option.	+0/-1

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

…t' option

qodo-code-review · 2024-03-03T09:25:25Z

PR Description updated to latest commit (f1bd67b)

Copy walkthrough table to "Files Changed" Tab

qodo-code-review · 2024-03-03T09:25:33Z

PR Review

(Review updated until commit `f1bd67b`)

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and involve removing a specific feature and its references throughout the codebase. The logic simplification in `pr_reviewer.py` and the documentation updates are clear and concise.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

relevant file	pr_agent/tools/pr_reviewer.py
suggestion	Consider adding a log message before removing comments to help with debugging and tracking actions performed by the tool. This can be particularly useful in scenarios where comments are unexpectedly removed or when trying to understand the sequence of events during the review process. [medium]
relevant line	if comment:

relevant file	pr_agent/tools/pr_reviewer.py
suggestion	Ensure that the removal of `remove_previous_review_comment` logic does not affect any external integrations or scripts that might be relying on this feature. If there are known dependencies, consider communicating these changes to affected users or providing migration paths. [important]
relevant line	-remove_previous_review_comment=false

relevant file	Usage.md
suggestion	Update the documentation to include a section on why the `remove_previous_review_comment` option was removed, if applicable. This can help users understand the rationale behind the change and how it benefits the PR review process. [medium]
relevant line	- "/review -i --pr_reviewer.remove_previous_review_comment=true",

relevant file	docs/REVIEW.md
suggestion	Given the removal of the `remove_previous_review_comment` feature, consider adding a note or section on best practices for managing review comments to maintain a clean and organized PR discussion thread. This could include manual cleanup or using other tools. [medium]
relevant line	-`remove_previous_review_comment`: if set to true, the tool will remove the previous review comment before adding a new one. Default is false.

✨ Review tool usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: `[pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation When you first install PR-Agent app, the default mode for the `review` tool is: `pr_commands = ["/review", ...]` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels The `review` tool can auto-generate two specific types of labels for a PR: a `possible security issue` label, that detects possible security issues (`enable_review_labels_security` flag) a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Extra sub-tools The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more.
Auto-approve PRs By invoking: `/review auto_approve` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: `[pr_reviewer] enable_auto_approval = true` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: `[pr_reviewer] maximal_review_effort = 5`
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

qodo-code-review · 2024-03-03T09:25:35Z

PR Code Suggestions

Category	Suggestions
Enhancement	Ensure critical operations are performed even if comment publishing fails. Consider handling the scenario where `self.git_provider.publish_persistent_comment` or `self.git_provider.publish_comment` fails. Currently, if an exception occurs in these methods, `self.git_provider.remove_initial_comment` and subsequent operations will not be executed. You might want to ensure that cleanup and other critical operations are performed even if publishing comments fails. pr_agent/tools/pr_reviewer.py [124-128] -self.git_provider.publish_persistent_comment(pr_review, -self.git_provider.publish_comment(pr_review) +try: + self.git_provider.publish_persistent_comment(pr_review, +except Exception as e: + get_logger().exception("Failed to publish persistent comment: {}", e) +try: + self.git_provider.publish_comment(pr_review) +except Exception as e: + get_logger().exception("Failed to publish comment: {}", e)
Enhancement	Consider adjustments to settings or mechanisms after removing `remove_previous_review_comment`. After removing the `remove_previous_review_comment` setting, consider if there are any default behaviors or settings that should be adjusted to accommodate this change. For example, if the removal of comments was a critical part of your workflow, you might need to introduce new settings or mechanisms to handle previously addressed use cases. pr_agent/settings/configuration.toml [37] -persistent_comment=true +# Consider introducing new settings or mechanisms if needed to handle use cases previously covered by `remove_previous_review_comment`.
Possible issue	Verify the change in behavior for fetching previous reviews aligns with intended functionality. Since the method `_get_previous_review_comment` no longer checks the setting `remove_previous_review_comment` before attempting to get the previous review, ensure that this change aligns with the intended functionality. If the intention was to always attempt to get the previous review regardless of the setting, this change is correct. Otherwise, you might need to reintroduce a condition or setting that controls this behavior. pr_agent/tools/pr_reviewer.py [294] -if hasattr(self.git_provider, "get_previous_review"): +# If a condition is needed to control fetching the previous review, reintroduce it here. +if some_condition and hasattr(self.git_provider, "get_previous_review"):
Documentation	Update documentation to reflect the removal of the `remove_previous_review_comment` feature. Update the documentation in `Usage.md` to reflect the removal of the `remove_previous_review_comment` feature. It's crucial to keep the documentation aligned with the codebase to avoid confusion. Since the feature is being removed, ensure that all references and explanations regarding this feature are updated or removed accordingly. Usage.md [218] -This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters. +# Ensure to update this section to reflect the removal of `remove_previous_review_comment` and its implications on the behavior of the PR-Agent.
Documentation	Remove references to the deprecated `remove_previous_review_comment` setting in the documentation. Since the `remove_previous_review_comment` setting is being removed, ensure that all references to it in the documentation, such as in `REVIEW.md`, are also removed or updated. This helps in maintaining consistency and clarity in the documentation. docs/REVIEW.md [77] -# This line was removed, ensure the documentation reflects this change accurately. +# Update or remove references to `remove_previous_review_comment` in the documentation.

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: `pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: `[pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

mrT23 · 2024-03-03T09:26:57Z

/review auto_approve

qodo-code-review · 2024-03-03T09:27:04Z

Auto-approved PR

mrT23 · 2024-03-03T12:41:54Z

Persistent review updated to latest commit f1bd67b

mrT23 · 2024-03-03T16:22:51Z

/improve

qodo-code-review · 2024-03-03T16:22:59Z

PR Code Suggestions

Category	Suggestions
Enhancement	Add error handling for publishing comments to improve robustness. Consider handling the case where `self.git_provider.publish_persistent_comment` or `self.git_provider.publish_comment` fails. You may want to log an error or retry the operation. pr_agent/tools/pr_reviewer.py [124-128] -self.git_provider.publish_persistent_comment(pr_review, -self.git_provider.publish_comment(pr_review) +try: + self.git_provider.publish_persistent_comment(pr_review, +except Exception as e: + get_logger().exception("Failed to publish persistent comment, error: {e}") +try: + self.git_provider.publish_comment(pr_review) +except Exception as e: + get_logger().exception("Failed to publish comment, error: {e}")
Enhancement	Suggest manual management of previous review comments in documentation. Since the `remove_previous_review_comment` option has been removed, consider adding a section on how users can manually manage previous review comments if needed. docs/REVIEW.md [82] +### Managing Previous Review Comments +With the removal of the automatic previous review comment deletion feature, users may need to manually manage their review comments. Here are some tips on how to do so effectively. + ### PR Reflection
Possible issue	Verify the safety of removing initial comments. Ensure that `self.git_provider.remove_initial_comment()` is necessary and correctly implemented, as removing initial comments might unintentionally delete important information. pr_agent/tools/pr_reviewer.py [130] +# Ensure this operation is safe and won't remove important comments self.git_provider.remove_initial_comment()
Documentation	Update documentation to reflect changes in review comment handling. Update the documentation to reflect the removal of the `remove_previous_review_comment` feature and its implications on the review process. Usage.md [218] -This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters. +This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters. Note that previous review comments will not be removed automatically.
Maintainability	Ensure application consistency after removing a configuration setting. After removing the `remove_previous_review_comment` setting, ensure that all references and dependencies on this setting are also updated or removed to avoid any potential inconsistencies in the application's behavior. pr_agent/settings/configuration.toml [37] persistent_comment=true +# Ensure no leftover code relies on the now-removed `remove_previous_review_comment` setting

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: `pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: `[pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

mrT23 · 2024-03-04T08:56:12Z

Preparing review...

mrT23 · 2024-03-04T09:00:50Z

Preparing review...

mrT23 · 2024-03-04T09:06:53Z

Persistent review updated to latest commit f1bd67b

Pham-Khanh-Long · 2025-04-29T09:05:10Z

/review

qodo-free-for-open-source-projects · 2025-04-29T09:05:28Z

PR Reviewer Guide 🔍

(Review updated until commit `f1bd67b`)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
✅ No TODO sections
🔒 No security concerns identified
⚡ Recommended focus areas for review Dead Code The methods `_get_previous_review_comment` and `_remove_previous_review_comment` are now unused after removing their invocations in the `run` method. These methods should be removed entirely to avoid maintaining dead code. def _get_previous_review_comment(self): """ Get the previous review comment if it exists. """ try: if hasattr(self.git_provider, "get_previous_review"): return self.git_provider.get_previous_review( full=not self.incremental.is_incremental, incremental=self.incremental.is_incremental, ) except Exception as e: get_logger().exception(f"Failed to get previous review comment, error: {e}") def _remove_previous_review_comment(self, comment): """ Remove the previous review comment if it exists. """ try: if comment: self.git_provider.remove_comment(comment) except Exception as e: get_logger().exception(f"Failed to remove previous review comment, error: {e}") Incomplete Refactoring While the call to `_get_previous_review_comment` was removed from the `run` method, the method itself was modified to remove the configuration check. This suggests incomplete refactoring - either the method should be removed entirely or there's a missing use case. if hasattr(self.git_provider, "get_previous_review"): return self.git_provider.get_previous_review( full=not self.incremental.is_incremental, incremental=self.incremental.is_incremental, )

hcmyxconan15 · 2025-10-28T04:51:50Z

/review

qodo-free-for-open-source-projects · 2025-10-28T04:52:05Z

Persistent review updated to latest commit f1bd67b

qodo-free-for-open-source-projects · 2026-01-23T02:27:04Z

Persistent review updated to latest commit f1bd67b

Updates the GitHub Action example, the last-commit badge, the Tagging bot link, and the three demo links in "See It in Action" to reference the community-owned the-pr-agent/pr-agent repo. Verified PR #530 and PR #732 resolve at the new org (the original repo was transferred, not forked, so PR numbers and history are preserved); old links 301 to the new ones today, but pinning to the canonical repo avoids relying on the redirect long-term. Image URLs hosted at codium.ai (logos, screenshots) are left alone because they're CDN assets that would need to be re-uploaded elsewhere first; out of scope for this slug-only fix.

Remove functionality and references to 'remove_previous_review_commen…

f1bd67b

…t' option

qodo-code-review Bot added the enhancement New feature or request label Mar 3, 2024

qodo-code-review Bot added the Review effort [1-5]: 2 label Mar 3, 2024

qodo-code-review Bot approved these changes Mar 3, 2024

View reviewed changes

mrT23 merged commit 68fab0b into main Mar 3, 2024

mrT23 deleted the tr/remove_outdated_option branch March 3, 2024 09:27

CatsMiaow mentioned this pull request Mar 26, 2024

Can I change the response language to something other than English? #822

Closed

qodo-free-for-open-source-projects Bot added Review effort 2/5 and removed Review effort [1-5]: 2 labels Apr 29, 2025

naorpeled mentioned this pull request May 2, 2026

docs(readme): point examples at the-pr-agent/pr-agent slug #2363

Merged

2 tasks

Conversation

mrT23 commented Mar 3, 2024 • edited by qodo-code-review Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type

Description

Changes walkthrough

Uh oh!

qodo-code-review Bot commented Mar 3, 2024

Uh oh!

qodo-code-review Bot commented Mar 3, 2024 • edited by mrT23 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review

(Review updated until commit f1bd67b)

Uh oh!

qodo-code-review Bot commented Mar 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions

Uh oh!

mrT23 commented Mar 3, 2024

Uh oh!

qodo-code-review Bot commented Mar 3, 2024

Uh oh!

mrT23 commented Mar 3, 2024

Uh oh!

mrT23 commented Mar 3, 2024

Uh oh!

qodo-code-review Bot commented Mar 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions

Uh oh!

mrT23 commented Mar 4, 2024

Uh oh!

mrT23 commented Mar 4, 2024

Uh oh!

mrT23 commented Mar 4, 2024

Uh oh!

Pham-Khanh-Long commented Apr 29, 2025

Uh oh!

qodo-free-for-open-source-projects Bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Reviewer Guide 🔍

(Review updated until commit f1bd67b)

Uh oh!

hcmyxconan15 commented Oct 28, 2025

Uh oh!

qodo-free-for-open-source-projects Bot commented Oct 28, 2025

Uh oh!

qodo-free-for-open-source-projects Bot commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrT23 commented Mar 3, 2024 •

edited by qodo-code-review Bot

Loading

qodo-code-review Bot commented Mar 3, 2024 •

edited by mrT23

Loading

(Review updated until commit `f1bd67b`)

qodo-code-review Bot commented Mar 3, 2024 •

edited

Loading

qodo-code-review Bot commented Mar 3, 2024 •

edited

Loading

qodo-free-for-open-source-projects Bot commented Apr 29, 2025 •

edited

Loading

(Review updated until commit `f1bd67b`)