Run check if can be merged when hold label is add/removed

[myakove]

Summary by CodeRabbit

• New Features

  • Enhanced size labeling for pull requests with defined size categories (XS, S, M, L, XL, XXL).
  • Streamlined logic for calculating and adding size labels based on pull request changes.

• Bug Fixes

  • Improved efficiency in the handling of existing labels during size label management.

[coderabbitai]

Walkthrough

The pull request introduces substantial modifications to the ProcessGithubWehook class in the webhook_server_container/libs/github_api.py file. Key changes include the complete refactoring of the get_size and add_size_label methods to enhance the logic for calculating and managing size labels for pull requests. The new implementation simplifies size categorization and improves efficiency while retaining existing functionality related to label management.

Changes

File Path	Change Summary
webhook_server_container/libs/github_api.py	Refactored get_size and add_size_label methods in ProcessGithubWehook for improved size label calculation and management. Minor adjustments made to label_by_user_comment method.

Possibly related PRs

• feat(github_api): refactor size label calculation #565: Refactors the add_size_label method to utilize the new get_size method, which is a key focus of the main PR's modifications.
• Add simple test for get_size #570: Adds tests specifically for the get_size method, which is central to the changes made in the main PR regarding size label calculations.

Suggested labels

commented-coderabbitai[bot]

Suggested reviewers

• rnetser

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[myakove-bot]

Report bugs in Issues

The following are automatically added:

• Add reviewers from OWNER file (in the root of the repository) under reviewers section.
• Set PR size label.
• New issue is created for the PR. (Closed when PR is merged/closed)
• Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

• To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
• To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
• To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
  verified label removed on each new commit push.
• To cherry pick a merged PR comment /cherry-pick <target branch to cherry-pick to> in the PR.
  • Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
  • Cherry-pick will be started when PR is merged
• To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
  • You can add extra args to the Podman build command
    • Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=<commit_hash>
• To add a label by comment use /<label name>, to remove, use /<label name> cancel
• To assign reviewers based on OWNERS file use /assign-reviewers
• To check if PR can be merged use /check-can-merge

Supported /retest check runs

• /retest tox: Retest tox
• /retest build-container: Retest build-container
• /retest python-module-install: Retest python-module-install

Supported labels

• hold
• verified
• wip
• lgtm

[myakove]

/verified

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

webhook_server_container/libs/github_api.py (1)

Line range hint 1721-1728: Good addition with room for improvement: Automatic merge for trusted users

The new set_pull_request_automerge method is a valuable addition that can streamline the workflow for trusted users. The use of the "SQUASH" merge method is a good practice for maintaining a clean commit history.

However, consider the following improvements:

1. Add error handling for the enable_automerge call to gracefully handle any failures.
2. Check if automerge is already enabled before making the API call to improve efficiency.
3. Add logging for cases when automerge is not enabled (i.e., when the user is not in the trusted list) for better traceability.

Example implementation:

def set_pull_request_automerge(self) -> None:
    if self.parent_committer in self.auto_verified_and_merged_users:
        self.logger.info(
            f"{self.log_prefix} Attempting to enable automerge. owner: {self.parent_committer} "
            f"is part of {self.auto_verified_and_merged_users}"
        )
        try:
            if not self.pull_request.auto_merge:
                self.pull_request.enable_automerge(merge_method="SQUASH")
                self.logger.info(f"{self.log_prefix} Automerge enabled successfully.")
            else:
                self.logger.info(f"{self.log_prefix} Automerge already enabled.")
        except Exception as e:
            self.logger.error(f"{self.log_prefix} Failed to enable automerge: {str(e)}")
    else:
        self.logger.info(f"{self.log_prefix} Automerge not enabled. {self.parent_committer} is not a trusted user.")

These changes will make the method more robust and informative.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 841b14e and 176aa65.

📒 Files selected for processing (1)

• webhook_server_container/libs/github_api.py (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

webhook_server_container/libs/github_api.py (2)

1154-1155: Improvement: Re-check merge status after hold label changes

The addition of self.check_if_can_be_merged() after handling the hold label is a good improvement. This ensures that the pull request's merge status is immediately re-evaluated when a user adds or removes the hold label, providing more responsive feedback to users.

---

Line range hint 1-1728: Overall: Positive improvements to pull request automation

The changes made to this file enhance the automation and responsiveness of the pull request workflow:

1. The addition to the user_commands method ensures that the merge status is re-checked immediately after a hold label is added or removed, improving the system's responsiveness to user actions.

2. The new set_pull_request_automerge method introduces automatic merging for trusted users, which can significantly streamline the workflow for these contributors.

These changes are well-integrated with the existing codebase and don't introduce any breaking changes or security issues. They represent a positive step towards more efficient pull request management.

While the new automerge functionality is a good addition, consider implementing the suggested improvements in error handling, efficiency, and logging to make it more robust and informative.

[myakove]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

webhook_server_container/libs/github_api.py (1)> Line range hint 1721-1728: Good addition with room for improvement: Automatic merge for trusted users

The new set_pull_request_automerge method is a valuable addition that can streamline the workflow for trusted users. The use of the "SQUASH" merge method is a good practice for maintaining a clean commit history.
However, consider the following improvements:

1. Add error handling for the enable_automerge call to gracefully handle any failures.
2. Check if automerge is already enabled before making the API call to improve efficiency.
3. Add logging for cases when automerge is not enabled (i.e., when the user is not in the trusted list) for better traceability.

Example implementation:

def set_pull_request_automerge(self) -> None:
    if self.parent_committer in self.auto_verified_and_merged_users:
        self.logger.info(
            f"{self.log_prefix} Attempting to enable automerge. owner: {self.parent_committer} "
            f"is part of {self.auto_verified_and_merged_users}"
        )
        try:
            if not self.pull_request.auto_merge:
                self.pull_request.enable_automerge(merge_method="SQUASH")
                self.logger.info(f"{self.log_prefix} Automerge enabled successfully.")
            else:
                self.logger.info(f"{self.log_prefix} Automerge already enabled.")
        except Exception as e:
            self.logger.error(f"{self.log_prefix} Failed to enable automerge: {str(e)}")
    else:
        self.logger.info(f"{self.log_prefix} Automerge not enabled. {self.parent_committer} is not a trusted user.")

These changes will make the method more robust and informative.

📜 Review details

@coderabbitai please open a flow-up issue for this.

[myakove-bot]

New container for quay.io/myakove/github-webhook-server:latest published

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@myakove, the follow-up issue has been created: Enhancements to set_pull_request_automerge Method

🔗 Analysis chain

@myakove, I'll open a follow-up issue for this.

---

@myakove, apologies for the issue with the script due to the backticks being interpreted as command substitutions. I've corrected the script by escaping the backticks in the title and body. Please see the updated script below:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Creating a new GitHub issue for the suggested enhancements
gh issue create \
  --title "Enhancements to `set_pull_request_automerge` Method" \
  --body "This issue tracks the suggested improvements to the \`set_pull_request_automerge\` method.\n\nRelated PR: https://github.com/myk-org/github-webhook-server/pull/582\n\nRequested by @myakove." \
  --assignee myakove

Length of output: 451

---

Script:

#!/bin/bash
# Corrected script to prevent command substitution by escaping backticks
gh issue create \
  --title "Enhancements to \`set_pull_request_automerge\` Method" \
  --body "This issue tracks the suggested improvements to the \`set_pull_request_automerge\` method.\n\nRelated PR: https://github.com/myk-org/github-webhook-server/pull/582\n\nRequested by @myakove." \
  --assignee myakove

Length of output: 355