Adds an option to ignore PR opens by regex matching

[okotek]

Type

enhancement

---

Description

• Introduced a feature to ignore PRs based on their title matching specified regex patterns.
• Added the re module in github_app.py for regex operations.
• Implemented logic in github_app.py to fetch the PR title and compare it against regex patterns specified in the configuration.
• Updated configuration.toml to include a new option ignore_pr_title for specifying regex patterns.

---

Changes walkthrough

	Relevant files
Enhancement	github_app.py Add Regex-Based PR Title Ignoring Feature                                pr_agent/servers/github_app.py Imported the re module for regex operations. Added logic to ignore PRs based on the title matching a regex pattern from the configuration. Extracted the PR title and compared it against a list of regex patterns to decide on ignoring the PR. +8/-0
Configuration changes	configuration.toml Configuration Option for Ignoring PRs by Title                      pr_agent/settings/configuration.toml Added a new configuration option ignore_pr_title as an empty list to hold regex patterns for ignoring PRs. +1/-0

---

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

[codiumai-pr-agent-pro]

PR Description updated to latest commit (e3dba12)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and localized to specific sections of the code. The addition of regex-based filtering for PR titles is a simple enhancement that does not significantly alter the existing logic or structure of the application.
🧪 Relevant tests	No
🔍 Possible issues	The implementation assumes ignore_pr_title_re will always be a list or a single string. If the configuration mistakenly sets this to a different type (e.g., a number or a boolean), it could cause runtime errors. Consider adding type validation or error handling for the configuration parsing. There's no explicit handling for invalid regex patterns specified in the configuration. Invalid regex could lead to uncaught exceptions during runtime. It might be beneficial to validate regex patterns on application startup and log a warning or error for any invalid patterns.
🔒 Security concerns	No

---

✨ 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.

[codiumai-pr-agent-pro]

PR Code Suggestions

	Suggestions
performance	Precompile regular expressions for performance improvement.                   Consider precompiling the regular expressions for performance improvement, especially if handle_request is called frequently. pr_agent/servers/github_app.py [135] -if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re): +ignore_pr_title_re_compiled = [re.compile(regex) for regex in ignore_pr_title_re] +if ignore_pr_title_re and any(regex.search(title) for regex in ignore_pr_title_re_compiled):
enhancement	Add exception handling for regex search to catch invalid patterns.            Use a more specific exception handling around the regex search to catch potential issues with invalid regex patterns. pr_agent/servers/github_app.py [135] -if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re): +try: + if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re): +except re.error as e: + get_logger().error(f"Invalid regex pattern: {e}") Refactor conditional check for enhanced readability.                          Refactor the conditional check for ignore_pr_title_re to enhance readability. pr_agent/servers/github_app.py [133-135] -if not isinstance(ignore_pr_title_re, list): - ignore_pr_title_re = [ignore_pr_title_re] -if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re): +ignore_pr_title_re = [ignore_pr_title_re] if not isinstance(ignore_pr_title_re, list) else ignore_pr_title_re +if any(re.search(regex, title) for regex in ignore_pr_title_re): Log the regex pattern that caused a PR to be ignored.                         Log the regex pattern that caused a PR to be ignored for better debugging and traceability. pr_agent/servers/github_app.py [135] -if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re): +ignored_regex = next((regex for regex in ignore_pr_title_re if re.search(regex, title)), None) +if ignored_regex: + get_logger().info(f"Ignoring PR with title '{title}' due to matching ignore pattern: {ignored_regex}")
maintainability	Document the GITHUB_APP.IGNORE_PR_TITLE setting.                 Ensure that the GITHUB_APP.IGNORE_PR_TITLE setting is documented, including the expected format and examples. pr_agent/servers/github_app.py [132] -ignore_pr_title_re = get_settings().get("GITHUB_APP.IGNORE_PR_TITLE", []) +# Ensure documentation for GITHUB_APP.IGNORE_PR_TITLE is updated with format and examples

---

✨ 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.

[barnett-yuxiang]

LGTM