Backport PR #2548 to release/v1.7 for Add workflow to check git conflict for backport PR

[vdaas-ci]

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.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	efe4cd9
Status:	✅  Deploy successful!
Preview URL:	https://b3f6a9c4.vald.pages.dev
Branch Preview URL:	https://backport-release-v1-7-fix-ci-4sjd.vald.pages.dev

View logs

[coderabbitai]

Walkthrough

Walkthrough

This update introduces a new GitHub Actions workflow called check-conflict.yml, which automates the detection of merge conflicts in pull requests. It includes jobs for logging context and checking for conflicts, specifically targeting non-forked repositories. The automation improves the pull request process by notifying contributors of any merge conflicts, enhancing collaboration and code integration efficiency.

Changes

Files	Change Summary
.github/workflows/check-conflict.yml	Added a new workflow to automate conflict detection in pull requests, including jobs for logging context and checking for merge conflicts.

Sequence Diagram(s)

sequenceDiagram
    participant User as Pull Request Contributor
    participant GitHub as GitHub
    participant Workflow as check-conflict.yml
    participant CI as CI User

    User->>GitHub: Create Pull Request
    GitHub->>Workflow: Trigger on Pull Request
    Workflow->>Workflow: dump-contexts-to-log
    Workflow->>Workflow: check-conflict
    alt Non-forked Repository
        Workflow->>Workflow: Check for Conflict Markers
        alt Conflicts Found
            Workflow->>CI: Retrieve Last Comment
            alt Comment Exists
                Workflow->>User: Notify of Conflict Resolution
            else No Comment
                Workflow->>User: Post New Conflict Alert
            end
        else No Conflicts
            Workflow->>User: No Conflicts Found
        end
    else Forked Repository
        Workflow->>User: Skip Conflict Check
    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 bc93d26 and efe4cd9.

Files selected for processing (1)

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

Additional comments not posted (7)

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

16-18: LGTM! Workflow metadata and triggers are correctly defined.

The workflow name and trigger event for pull requests are appropriately set.

---

20-24: LGTM! Job dump-contexts-to-log is correctly defined.

The job runs on ubuntu-latest and includes steps for checking out the repository and running a custom action.

---

25-27: LGTM! Job check-conflict is correctly defined.

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

---

33-35: LGTM! Step for setting Git config is correctly defined.

The step sets the Git config to add the current workspace as a safe directory.

---

56-58: LGTM! Environment variables are correctly defined.

The environment variables GITHUB_TOKEN and API_URL are appropriately set and used in the script.

---

37-55: Verify the conflict checking script.

Ensure that the script correctly identifies conflict markers and posts a comment on the PR if conflicts are found.

---

26-26: Verify the condition for the job.

Ensure that the condition for the job correctly identifies non-forked repositories.

Verification successful

---

Condition for the job is correctly set to identify non-forked repositories.

The condition if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false }} is present in the workflow file and ensures that the job runs only for pull requests from non-forked repositories.

• .github/workflows/check-conflict.yml, line 26

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the condition for the job `check-conflict`.

# Test: Search for the condition usage. Expect: Only occurrences of the condition in the workflow file.
rg --type yaml -A 1 $'if: ${{ github.event_name == \'pull_request\' && github.event.pull_request.head.repo.fork == false }}'

Length of output: 317

---

Script:

#!/bin/bash
# Description: Verify the condition for the job `check-conflict`.

# Test: Search for the condition usage. Expect: Only occurrences of the condition in the workflow file.
rg --type yaml -A 1 'if: \${{ github.event_name == "pull_request" && github.event.pull_request.head.repo.fork == false }}'

Length of output: 314

---

Script:

#!/bin/bash
# Description: Verify the condition for the job `check-conflict`.

# Test: Search for the condition usage. Expect: Only occurrences of the condition in the workflow file.
rg --type yaml -A 2 'if:.*github.event_name == "pull_request".*github.event.pull_request.head.repo.fork == false'

Length of output: 115

---

Script:

#!/bin/bash
# Description: Verify the condition for the job `check-conflict`.

# Test: Search for any conditional statements in the workflow file. Expect: Occurrences of `if:` statements and their context.
rg --type yaml -A 2 'if:' .github/workflows/check-conflict.yml

Length of output: 204

[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

[hlts2]

LGTM!