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

use ci-container for update deps cron job #2744

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Nov 14, 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
Contributor

coderabbitai bot commented Nov 14, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the GitHub Actions workflow file .github/workflows/update-deps.yaml. A new job called detect-ci-container is added, which is utilized by the existing update-version job, now dependent on the completion of detect-ci-container. The update-version job also specifies a container image based on the output from the new job and removes the make deps command, while retaining the logic for checking repository changes.

Changes

File Change Summary
.github/workflows/update-deps.yaml - Added job detect-ci-container
- Updated update-version to depend on detect-ci-container
- Specified container image in update-version
- Removed make deps command
- Comment added regarding make license command

Possibly related PRs

Suggested labels

type/ci, size/M, actions/backport/release/v1.7

Suggested reviewers

  • kmrmt
  • datelier

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.

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 (2)
.github/workflows/update-deps.yaml (2)

Line range hint 78-85: Fix the version comparison syntax

There's a syntax error in the version comparison that could cause the label selection to fail.

Apply this fix:

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

Additionally, consider using semantic version comparison for more robust version handling:

- if [ "${LATEST}" = "1.7" ]; then
+ if printf '%s\n' "1.7" "${LATEST}" | sort -V | head -n1 | grep -q "^1.7$"; then

Line range hint 46-61: Add error handling for make commands

The sequence of make commands could benefit from better error handling to ensure each step completes successfully.

Consider wrapping the commands in a shell function with error handling:

       run: |
+        set -eo pipefail
+        
+        run_make() {
+          echo "Running: make $1"
+          if ! make "$1"; then
+            echo "::error::Failed to run make $1"
+            return 1
+          fi
+        }
+        
-        make files
-        make update
-        make helm/schema/all
+        run_make files
+        run_make update
+        run_make helm/schema/all
         # ... apply to other make commands
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 229f851 and daa4844.

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

57-57: Clarify the necessity of the license update step

The comment suggests uncertainty about whether make license is needed. This should be definitively decided to maintain consistency across dependency updates.

#!/bin/bash
# Check if license files are being modified by the make target
git log --oneline -p | grep -B 5 "make license" | grep -B 5 "diff --git.*LICENSE"

# Check if the license make target is used in other workflows
fd -t f . .github/workflows -x grep -l "make license" {}

27-33: Verify the CI container workflow and image availability

The changes introduce a dependency on a reusable workflow and a dynamic container image. We should ensure:

  1. The reusable workflow _detect-ci-container.yaml exists and is properly configured
  2. The container image tag format is correct and the images are available
✅ Verification successful

CI container workflow setup is properly configured

The reusable workflow _detect-ci-container.yaml exists and is well-configured with:

  • A proper workflow_call interface that outputs the container TAG
  • A robust tag detection mechanism using custom actions
  • Integration with multiple workflows across the repository

The container image reference in update-deps.yaml correctly uses the output from the reusable workflow:

image: ghcr.io/vdaas/vald/vald-ci-container:${{ needs.detect-ci-container.outputs.TAG }}
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the reusable workflow exists
if [ -f ".github/workflows/_detect-ci-container.yaml" ]; then
    echo "Reusable workflow exists"
    cat ".github/workflows/_detect-ci-container.yaml"
else
    echo "Warning: Reusable workflow not found"
fi

# Check recent container images
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: 672


Script:

#!/bin/bash
# Let's check if the reusable workflow exists and its content
if [ -f ".github/workflows/_detect-ci-container.yaml" ]; then
    echo "=== Reusable workflow content ==="
    cat ".github/workflows/_detect-ci-container.yaml"
else
    echo "Reusable workflow not found"
fi

# Let's also check the update-deps.yaml for any container image references
echo -e "\n=== Container image references in update-deps.yaml ==="
grep -A 2 -B 2 "container:" .github/workflows/update-deps.yaml

# Check for any other workflow files that might reference the container
echo -e "\n=== Other workflow files with container references ==="
fd -t f . .github/workflows -x grep -l "vald-ci-container" {}

Length of output: 3337

@vdaas-ci
Copy link
Collaborator

[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

@kmrmt kmrmt merged commit 246fb12 into main Nov 15, 2024
53 checks passed
@kmrmt kmrmt deleted the ci/workflow/use-ci-container-for-update-deps branch November 15, 2024 04:50
vdaas-ci pushed a commit that referenced this pull request Nov 15, 2024
kpango added a commit that referenced this pull request Nov 18, 2024
Signed-off-by: vankichi <[email protected]>
Co-authored-by: Kiichiro YUKAWA <[email protected]>
Co-authored-by: Yusuke Kato <[email protected]>
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
This was referenced Dec 3, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 20, 2024
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.

4 participants