Add workflow to check git conflict for backport PR

[hlts2]

Description

In backport PR, conflicts are forced to be included.
For this reason, I have implemented a workflow that checks conflicts in the diffs.

Related Issue

Versions

• Vald Version: v1.7.12
• Go Version: v1.22.5
• Rust Version: v1.77.2
• Docker Version: v27.1.1
• Kubernetes Version: v1.30.3
• Helm Version: v3.15.3
• NGT Version: v2.2.4
• Faiss Version: v1.8.0

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• New Features

  • Introduced an automated workflow to check for merge conflicts in pull requests, enhancing collaboration and code integration.

• Improvements

  • Streamlined the pull request process by providing early detection of potential merge conflicts to prompt users for resolution.

• Documentation

  • Updated README to include a conflict marker, indicating an unresolved merge conflict that requires attention.

[coderabbitai]

Warning

Rate limit exceeded

@hlts2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 21 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 91f2826 and 1c06101.

Walkthrough

Walkthrough

The newly introduced GitHub Actions workflow, check-conflict.yml, automates the detection of merge conflicts in pull requests. Triggered by pull request events, it consists of two jobs: one for logging context and another for checking conflicts, which runs only for non-forked repositories. The workflow identifies specific conflict markers in the codebase and notifies users when conflicts are detected, thereby facilitating smoother collaboration and integration.

Changes

File Path	Change Summary
.github/workflows/check-conflict.yml	Added workflow to automate merge conflict checks on PRs.
README.md	Added conflict marker indicating unresolved merge issue.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubActions as GA
    participant Repo

    User->>GA: Open Pull Request
    GA->>GA: Trigger Workflow
    GA->>Repo: Checkout Code
    GA->>Repo: Configure Git Safe Directory
    GA->>Repo: Check for Conflicts
    alt Conflicts Found
        GA->>User: Notify to resolve conflicts
    else No Conflicts
        GA->>User: Proceed with PR
    end

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between caa8f03 and 3b97625.

Files selected for processing (1)

• .github/workflows/check-conflict.yml (1 hunks)

Additional comments not posted (4)

.github/workflows/check-conflict.yml (4)

1-15: Header section looks good.

The licensing information and workflow name are correctly specified.

---

16-18: Trigger section looks good.

The workflow is correctly triggered by pull request events.

---

25-41: Job setup for check-conflict looks good.

The job runs on ubuntu-latest and includes necessary steps for checking out the repository, setting Git config, and checking for conflicts.

---

19-24: Job setup for dump-contexts-to-log looks good.

The job runs on ubuntu-latest and uses the necessary actions.

However, verify that the custom action .github/actions/dump-context exists and functions correctly.

Verification successful

Custom action .github/actions/dump-context exists.

Now, let's verify its configuration to ensure it functions correctly.

---

Custom action .github/actions/dump-context is correctly configured and functional.

The action file contains steps to dump various GitHub contexts to the log, ensuring it works as intended.

• action.yaml includes steps to dump GitHub, job, steps, runner, strategy, and matrix contexts.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the custom action `.github/actions/dump-context`.

# Test: Check if the custom action directory exists. Expect: Directory exists.
if [ -d ".github/actions/dump-context" ]; then
  echo "Custom action exists."
else
  echo "Custom action does not exist."
  exit 1
fi

Length of output: 94

---

Script:

#!/bin/bash
# Description: Verify the configuration of the custom action `.github/actions/dump-context`.

# Test: Check if the action metadata file exists and is correctly configured. Expect: File exists and contains valid configuration.

# Check for the presence of action.yml or action.yaml
if [ -f ".github/actions/dump-context/action.yml" ]; then
  ACTION_FILE=".github/actions/dump-context/action.yml"
elif [ -f ".github/actions/dump-context/action.yaml" ]; then
  ACTION_FILE=".github/actions/dump-context/action.yaml"
else
  echo "Action metadata file not found."
  exit 1
fi

# Output the content of the action metadata file for review
cat "$ACTION_FILE"

Length of output: 1644

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	1c06101
Status:	✅  Deploy successful!
Preview URL:	https://fef0abea.vald.pages.dev
Branch Preview URL:	https://fix-ci-conflict.vald.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3b97625 and 466779c.

Files selected for processing (1)

• .github/workflows/check-conflict.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/check-conflict.yml

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 466779c and 91f2826.

Files selected for processing (2)

• .github/workflows/check-conflict.yml (1 hunks)
• README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/check-conflict.yml

[vdaas-ci]

[WARNING:CONFLICT] You may require to fix the conflict. Please check.

[kpango]

LGTM thanks!!