GitAuto: [FEATURE] Block PR until requested review response

gitauto-ai[bot] commented 2 weeks ago

Resolves #379

What is the feature

Block pull requests from being merged until all requested reviewers have approved the PR.

Why we need the feature

Ensuring that every pull request is reviewed and approved by the designated reviewers before it can be merged promotes code quality, accountability, and team collaboration. It prevents unreviewed code from being integrated into the main branch, reducing the risk of bugs and maintaining project standards.

How to implement and why

Configure Status Checks in GitHub:
- Utilize GitHub Actions to create a status check that monitors the review status of pull requests.
- Set up the status check to remain in the action required state until all required reviewers have approved the PR.
Update GitHub Workflow:
- Modify or create a GitHub Actions workflow in the .github/workflows directory to include a new step that checks for approval status.
- Use the GitHub API to retrieve the list of required reviewers and their approval statuses.
- Update the status check accordingly, setting it to awaiting review when reviews are pending and marking it as success once all approvals are received.
Implement Status Update Logic:
- Integrate the provided PHP example using the GuiBranco/Pancake library to programmatically set the PR status to action required until approved.
- Incorporate this logic into the existing CI/CD pipeline to automate the status check process.
Test the Implementation:
- Ensure that the status check correctly reflects the PR status during various stages, such as when reviews are pending, in progress, and completed.
- Validate that PRs cannot be merged until the status check passes by confirming that the GitHub branch protection rules enforce this requirement.

By following these steps, the feature ensures that PRs meet the required review process before merging, enhancing code reliability and team collaboration.

About backward compatibility

This feature does not affect existing workflows negatively since it adds an additional required status check to enforce review approvals. It maintains compatibility with current CI/CD processes, only enhancing the verification steps before merging PRs. Existing repositories can adopt this feature without disrupting their current practices, provided they have the necessary reviewer configurations in place.

Test these changes locally

git checkout -b gitauto/issue-379-9fbd57c1-1061-42ed-a2ac-15a83e27dc43
git pull origin gitauto/issue-379-9fbd57c1-1061-42ed-a2ac-15a83e27dc43

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepsource-io[bot] commented 2 weeks ago

Here's the code health analysis summary for commits e74be8f..08ee879. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Docker	✅ Success		View Check ↗
PHP	❌ Failure	❗ 4 occurences introduced 🎯 1 occurence resolved	View Check ↗
Secrets	✅ Success		View Check ↗
SQL	✅ Success		View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

gitauto-ai[bot] commented 2 weeks ago

Committed the Check Run review-approval error fix! Running it again...

gitauto-ai[bot] commented 2 weeks ago

Committed the Check Run php-lint error fix! Running it again...

github-actions[bot] commented 2 weeks ago

JSON and YAML Validation Results

YAML Validation Results

✅ File(s) Passed: 17
❌ File(s) Failed: 1
⏭️ File(s) Skipped: 0

Violations:

[
  {
    "file": ".github/workflows/review-approval-check.yml",
    "errors": [
      {
        "path": null,
        "message": "Invalid YAML",
        "error": "YAMLParseError Implicit keys need to be on a single line at line 27, column 5"
      }
    ]
  }
]

gitauto-ai[bot] commented 2 weeks ago

Committed the Check Run json-yaml-validate error fix! Running it again...

github-actions[bot] commented 2 weeks ago

JSON and YAML Validation Results

YAML Validation Results

✅ File(s) Passed: 17
❌ File(s) Failed: 1
⏭️ File(s) Skipped: 0

Violations:

[
  {
    "file": ".github/workflows/review-approval-check.yml",
    "errors": [
      {
        "path": null,
        "message": "Invalid YAML",
        "error": "YAMLParseError Implicit keys need to be on a single line at line 27, column 5"
      }
    ]
  }
]

gitauto-ai[bot] commented 2 weeks ago

Committed the Check Run json-yaml-validate error fix! Running it again...

github-actions[bot] commented 2 weeks ago

JSON and YAML Validation Results

YAML Validation Results

✅ File(s) Passed: 17
❌ File(s) Failed: 1
⏭️ File(s) Skipped: 0

Violations:

[
  {
    "file": ".github/workflows/review-approval-check.yml",
    "errors": [
      {
        "path": null,
        "message": "Invalid YAML",
        "error": "YAMLParseError Implicit keys need to be on a single line at line 37, column 7"
      }
    ]
  }
]

github-actions[bot] commented 2 weeks ago

JSON and YAML Validation Results

YAML Validation Results

✅ File(s) Passed: 17
❌ File(s) Failed: 1
⏭️ File(s) Skipped: 0

Violations:

[
  {
    "file": ".github/workflows/review-approval-check.yml",
    "errors": [
      {
        "path": null,
        "message": "Invalid YAML",
        "error": "YAMLParseError Implicit keys need to be on a single line at line 37, column 7"
      }
    ]
  }
]

github-actions[bot] commented 2 weeks ago

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

```txt 12:12AM INF scanning for exposed secrets... 12:12AM INF 622 commits scanned. 12:12AM INF scan completed in 143ms 12:12AM INF no leaks found ```