Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport PR #2744 to release/v1.7 for use ci-container for update deps cron job #2748

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Nov 15, 2024

Description

SSIA

Related Issue

Versions

  • Vald Version: v1.7.14
  • Go Version: v1.23.3
  • Rust Version: v1.82.0
  • Docker Version: v27.3.1
  • Kubernetes Version: v1.31.2
  • Helm Version: v3.16.2
  • NGT Version: v2.3.4
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • New Features

    • Introduced a new job for CI container detection in the update workflow.
  • Improvements

    • Updated the dependency update job to rely on the new container detection job.
    • Enhanced the command sequence for updating dependencies by removing unnecessary commands.

These changes streamline the update process and improve the overall efficiency of the CI workflow.

Copy link

cloudflare-workers-and-pages bot commented Nov 15, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0cc6996
Status:⚡️  Build in progress...

View logs

Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the GitHub Actions workflow file .github/workflows/update-deps.yaml by adding a new job called detect-ci-container and updating the existing update-version job to depend on it. The update-version job now uses an output from the detect-ci-container job for its container image and has had the make deps command removed. A comment regarding the potential removal of the make license command has been added, while the logic for checking repository differences and subsequent labeling steps remains unchanged.

Changes

File Path Change Summary
.github/workflows/update-deps.yaml - Added new job detect-ci-container.
- Updated update-version job to depend on detect-ci-container.
- Removed make deps command from update-version.
- Added comment regarding potential removal of make license command.

Possibly related PRs

  • Add auto deps version update workflow #2707: This PR modifies the .github/workflows/update-deps.yaml file to enhance the dependency management workflow, which is directly related to the changes made in the main PR that also involves modifications to the same workflow file.
  • use ci-container for update deps cron job #2744: This PR also updates the .github/workflows/update-deps.yaml file, adding a new job and adjusting existing jobs, which aligns closely with the changes described in the main PR.

Suggested labels

priority/low, type/ci, size/S, actions/backport/release/v1.7

Suggested reviewers

  • datelier
  • kpango
  • kmrmt

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
🪧 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 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 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.

@vdaas-ci
Copy link
Collaborator Author

[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

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (1)
.github/workflows/update-deps.yaml (1)

Line range hint 75-82: Fix the shell script syntax in version comparison

The version comparison logic contains a syntax error and might not work as expected.

Apply this fix:

-          if ${LATEST} eq "1.7"; then
+          if [ "${LATEST}" = "1.7" ]; then

Also, consider using a more robust version comparison:

-            SUPPORT=$(echo ${LATEST} | awk '{print $1-0.1}')
+            SUPPORT=$(echo "${LATEST}" | awk -F. '{printf "%.1f", $1"."$2-0.1}')
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 667eecf and bac320f.

📒 Files selected for processing (1)
  • .github/workflows/update-deps.yaml (2 hunks)
🔇 Additional comments (3)
.github/workflows/update-deps.yaml (3)

57-58: Clarify the necessity of the license command

The comment suggests uncertainty about whether make license should be removed. Since this is a backport PR, we should maintain consistency with the source PR #2744.

#!/bin/bash
# Description: Check if the source PR (#2744) retained or removed the license command
# Expected: Should match the decision made in the source PR

gh pr view 2744 --json files \
  --jq '.files[] | select(.path == ".github/workflows/update-deps.yaml") | .patch' \
  | grep -A 5 -B 5 "make license"

27-28: Verify the referenced workflow file exists

The job references a reusable workflow file _detect-ci-container.yaml. Let's ensure this file exists and is properly configured.

✅ Verification successful

Referenced workflow file exists and is properly configured

The reusable workflow _detect-ci-container.yaml exists and contains a valid workflow definition that:

  • Accepts workflow calls and provides an output named TAG
  • Uses appropriate actions to determine and detect Docker image tags
  • Follows proper GitHub Actions syntax and conventions
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the referenced workflow file exists
# Expected: File should exist and contain valid workflow definition

if [ -f ".github/workflows/_detect-ci-container.yaml" ]; then
    echo "File exists. Checking content..."
    cat ".github/workflows/_detect-ci-container.yaml"
else
    echo "ERROR: Referenced workflow file does not exist!"
fi

Length of output: 1861


31-33: LGTM! Container configuration looks correct.

The job dependency and container configuration are properly set up. The container image uses the GitHub Container Registry format and dynamically sets the tag from the detect-ci-container job output.

✅ Verification successful

Container configuration is correctly implemented and widely used

The container configuration is properly set up:

  • The detect-ci-container reusable workflow determines the appropriate container tag
  • The container image ghcr.io/vdaas/vald/vald-ci-container is consistently used across multiple workflows
  • The tag is dynamically obtained through the workflow's outputs using proper job dependencies
  • The pattern is well-established and standardized across the repository's workflows
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the container image exists in GitHub Container Registry
# Expected: Container image should exist with recent tags

gh api \
  -H "Accept: application/vnd.github+json" \
  "/orgs/vdaas/packages/container/vald-ci-container/versions" \
  --jq '.[0:5] | .[] | {created_at: .created_at, tags: .metadata.container.tags}'

Length of output: 237


Script:

#!/bin/bash
# Let's verify the container image existence using a different approach
# First, check if the workflow file exists and its content
cat .github/workflows/update-deps.yaml

# Then check for any related container configuration in other workflow files
fd -e yaml -e yml . .github/workflows/ --exec grep -l "ghcr.io/vdaas/vald/vald-ci-container" {}

Length of output: 4166


Script:

#!/bin/bash
# Let's check the detect-ci-container workflow that provides the TAG
cat .github/workflows/_detect-ci-container.yaml

# Also check one of the other workflows using this container to understand the pattern
cat .github/workflows/unit-test.yaml

Length of output: 5116

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.

3 participants