GitAuto: [FEATURE] Disable `Auto-Merge` by user request

[gitauto-ai[bot]]

Resolves #373

What is the feature

Introduce the ability for users to disable the Auto-Merge feature through specific actions such as modifying labels or adding particular comments on a pull request. Additionally, allow users to re-enable Auto-Merge using designated actions.

Why we need the feature

Enhancing user control over the Auto-Merge functionality provides greater flexibility and ensures that merges occur only under desired conditions. This feature allows users to prevent automatic merging when certain criteria are not met or when additional review is needed, thereby improving the integrity of the codebase.

How to implement and why

1. Monitor Pull Request Events:

   • Label Changes: Track when the ✅ auto-merge or 🧷 do-not-merge labels are added or removed.
   • Auto-Merge Toggles: Detect when users manually enable or disable Auto-Merge.
   • Comments: Listen for specific comments such as auto-merge enable or auto-merge disable.

2. Update Auto-Merge Status:

   • Disabling Auto-Merge:
     • Disable the Auto-Merge setting on the pull request.
     • Remove the ✅ auto-merge label.
     • Add the 🧷 do-not-merge label to indicate that auto-merging is disabled.
   • Enabling Auto-Merge:
     • Enable the Auto-Merge setting or automatically merge the pull request if all checks pass.
     • Add the ✅ auto-merge label.
     • Remove the 🧷 do-not-merge label to signify that auto-merging is active.

3. Implement Event Handlers:

   • Develop handlers within the Src directory that respond to the tracked events and perform the necessary label and auto-merge status updates.
   • Ensure that these handlers interact seamlessly with the existing GitHub workflows defined in the .github directory.

4. Testing and Validation:

   • Write unit and integration tests to verify that the feature behaves as expected under various scenarios.
   • Validate that enabling and disabling Auto-Merge doesn't interfere with other automated processes.

5. Documentation:

   • Update the README.md and CONTRIBUTING.md files to include guidelines on how users can utilize the new Auto-Merge controls.
   • Provide examples and best practices for managing pull requests with the enhanced Auto-Merge feature.

About backward compatibility

This feature is designed to be backward compatible. Existing workflows and users who do not engage with the new Auto-Merge controls will experience no changes in behavior. The introduction of label-based and comment-based controls for Auto-Merge adds optional functionality that enhances flexibility without disrupting established processes.

Test these changes locally

git checkout -b gitauto/issue-373-963e756a-3fa9-4c96-82b0-5664bf980988
git pull origin gitauto/issue-373-963e756a-3fa9-4c96-82b0-5664bf980988

[coderabbitai[bot]]

[!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://docs.coderabbit.ai) 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.

[gitauto-ai[bot]]

Committed the Check Run SonarCloud Code Analysis error fix! Running it again...

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[gitauto-ai[bot]]

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

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[deepsource-io[bot]]

Here's the code health analysis summary for commits e37c5d0..0fdae19. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Docker	✅ Success		View Check ↗
PHP	❌ Failure	❗ 5 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]]

Committed the Check Run Codacy Static Code Analysis error fix! Running it again...

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[github-actions[bot]]

JSON and YAML Validation Results

JSON Validation Results

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

Violations:

[
  {
    "file": "Src/config/labels.json",
    "errors": [
      {
        "path": null,
        "message": "Invalid JSON"
      }
    ]
  }
]

[sonarcloud[bot]]

Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

[github-actions[bot]]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

```txt 1:36PM INF scanning for exposed secrets... 1:36PM INF 644 commits scanned. 1:36PM INF scan completed in 152ms 1:36PM INF no leaks found ```