Skip to content

feat: Enable set PRs with auto merge for branches#698

Merged
myakove merged 6 commits intomainfrom
auto-merge-by-branch
Apr 6, 2025
Merged

feat: Enable set PRs with auto merge for branches#698
myakove merged 6 commits intomainfrom
auto-merge-by-branch

Conversation

@myakove
Copy link
Copy Markdown
Collaborator

@myakove myakove commented Apr 2, 2025

In the config file under the desire repository set:

set-auto-merge-prs:
    - my-branch

To set auto merge for ech PR under this branch

Summary by CodeRabbit

  • New Features
    • Introduced an auto-merge setting that automatically merges pull requests targeting the main branch.
    • Enhanced branch protection configurations with an additional auto-merge criteria.
    • Updated merge logic to determine automatic merging based on new configuration settings.
    • Added a new property for auto-merge in the configuration schema.

In the config file under the desire repository set:
```
set-auto-merge-prs:
    - my-branch
```

To set auto merge for ech PR under this branch
@myakove-bot
Copy link
Copy Markdown
Collaborator

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
  • to assign reviewer to PR use /assign-reviewer @<reviewer>
Supported /retest check runs
  • /retest tox: Retest tox
  • /retest build-container: Retest build-container
  • /retest python-module-install: Retest python-module-install
  • /retest pre-commit: Retest pre-commit
  • /retest all: Retest all
Supported labels
  • hold
  • verified
  • wip
  • lgtm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 2, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a new configuration entry named set-auto-merge-prs to facilitate auto-merging of pull requests for specified branches. This change is reflected in the primary configuration file (example.config.yaml) and the API schema (webhook_server_container/config/schema.yaml), where the property is added under the branch_protection object. Additionally, the logic within the ProcessGithubWehook class in the GitHub API is updated to utilize this new configuration for determining auto-merge eligibility.

Changes

File(s) Change Summary
example.config.yaml
webhook_server_container/config/schema.yaml
Added new configuration entry/property set-auto-merge-prs for specifying branches eligible for auto-merge; schema file restructured the branch_protection object.
webhook_server_container/libs/github_api.py Introduced new attribute set_auto_merge_prs in the ProcessGithubWehook class and updated the set_pull_request_automerge method’s logic and logging.

Possibly related PRs

  • check if pr is already set to auto merge before enable #586: The changes in the main PR and the retrieved PR are related as both involve modifications to the auto-merge functionality within the ProcessGithubWehook class in webhook_server_container/libs/github_api.py, specifically regarding the handling of the set-auto-merge-prs configuration.
  • feat: Enable set PRs with auto merge for branches #698: The changes in the main PR and the retrieved PR are related as both introduce the set-auto-merge-prs configuration entry, with the main PR adding it under the repositories key and the retrieved PR adding it under the branch_protection object in the schema.
  • Set PR as auto-merge when committer is part of auth-merged users #574: The changes in the main PR and the retrieved PR are related as both modify the set_pull_request_automerge method in the ProcessGithubWehook class, with the main PR introducing a new attribute that influences the auto-merge logic.

Suggested labels

size/L, approved-myakove

Suggested reviewers

  • rnetser

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fb4dc6 and b1ab6dc.

📒 Files selected for processing (1)
  • webhook_server_container/libs/github_api.py (4 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
webhook_server_container/config/schema.yaml (1)

189-190: Enhance "conventional-title" Definition for Schema Consistency
The current definition of conventional-title is given using a shorthand (conventional-title: string), which differs from the explicit object notation used for other properties. For consistency with the rest of the schema, it is recommended to define it as follows:

-        conventional-title: string
+        conventional-title:
+          type: string

This change ensures consistency in JSON schema styling and readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e1ed537 and 4487580.

📒 Files selected for processing (3)
  • example.config.yaml (1 hunks)
  • webhook_server_container/config/schema.yaml (1 hunks)
  • webhook_server_container/libs/github_api.py (2 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
webhook_server_container/libs/github_api.py (1)
webhook_server_container/libs/config.py (1)
  • get_value (27-36)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: tox
  • GitHub Check: python-module-install
  • GitHub Check: pre-commit
  • GitHub Check: build-container
🔇 Additional comments (7)
example.config.yaml (1)

112-115: New Configuration Option: set-auto-merge-prs

This new entry adds a list of branches (in this case, just "main") for which pull requests should be auto-merged. Please verify that its placement and indentation match the intended structure of your repository configuration. If the key was meant to be nested inside an object (such as within a branch protection configuration) per your overall design, confirm that the current layout aligns with the schema.

webhook_server_container/libs/github_api.py (3)

388-388: Implementation of new configuration for branch-based auto-merge looks good

Adding a new attribute to retrieve branch names for auto-merge from the configuration follows the established pattern in this codebase.


2021-2025: Flexible auto-merge decision with branch inclusion logic

The modified logic appropriately combines both branch-based and user-based criteria for determining when to enable auto-merge.


2030-2030: Improved logging message clarity

The log message has been updated to reflect that auto-merge decisions can now be based on multiple rules rather than just the parent committer.

webhook_server_container/config/schema.yaml (3)

175-180: Define New Auto-Merge Property Clearly
The new property set-auto-merge-prs is correctly defined as an array of strings with an appropriate description to indicate its purpose for automatically merging pull requests for specified branches. This aligns well with the PR objectives.


181-185: Verify "can-be-merged-required-labels" Schema Consistency
The schema for can-be-merged-required-labels is defined as an array of strings, which is consistent with the expected type. Its placement under the branch_protection object appears intentional.


186-188: Confirm "jira-tracking" Property Definition
The property jira-tracking is correctly defined as a boolean with a default value of true. This is in line with the intended configuration and maintains consistency with other boolean properties in the schema.

@myakove myakove merged commit 1235ac6 into main Apr 6, 2025
2 checks passed
@myakove myakove deleted the auto-merge-by-branch branch April 6, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants