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

Fix typo for docker.mk #2720

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Fix typo for docker.mk #2720

merged 1 commit into from
Oct 25, 2024

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Oct 25, 2024

Description

SSIA

Related Issue

Versions

  • Vald Version: v1.7.13
  • Go Version: v1.23.2
  • Rust Version: v1.81.0
  • Docker Version: v27.3.1
  • Kubernetes Version: v1.31.1
  • Helm Version: v3.16.2
  • NGT Version: v2.2.4
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • Chores
    • Standardized build arguments for Docker images to improve consistency in version referencing.

Signed-off-by: vankichi <kyukawa315@gmail.com>
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the Makefile.d/docker.mk, specifically updating the build commands for Docker images. The HDF4_VERSION variable has been replaced with HDF5_VERSION in the build arguments for the loadtest, benchmark-job, and example-client images. This adjustment standardizes the naming convention for the version argument, ensuring consistent reference to the HDF5 version across these commands. The overall structure of the Makefile remains unchanged.

Changes

File Change Summary
Makefile.d/docker.mk Updated build commands to replace --build-arg HDF4_VERSION=$(HDF5_VERSION) with --build-arg HDF5_VERSION=$(HDF5_VERSION) for consistency in version naming.

Possibly related PRs

  • Bugfix vald-helm-operator build error #2610: This PR modifies the Makefile.d/docker.mk, specifically focusing on build commands, which is directly related to the changes made in the main PR regarding the HDF5_VERSION variable in the same file.
  • Fix format #2534: Although this PR primarily addresses formatting issues, it also involves the Dockerfile structure, which may have indirect relevance to the overall organization of Docker-related files, including Makefile.d/docker.mk.
  • Backport PR #2534 to release/v1.7 for Fix format #2540: This PR backports changes related to formatting in Dockerfiles, which may relate to the overall consistency and structure of Docker build processes, similar to the changes in the main PR.
  • fix: typo in index job #2708: This PR addresses a typo in the index job, which may not be directly related to the Makefile.d/docker.mk changes but indicates ongoing improvements in the codebase that could align with the standardization efforts seen in the main PR.

Suggested labels

type/refactoring, priority/low

Suggested reviewers

  • kmrmt
  • hlts2
  • 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.

@vankichi vankichi requested review from a team, kpango and datelier and removed request for a team October 25, 2024 05:21
@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

coderabbitai[bot]
coderabbitai bot previously requested changes Oct 25, 2024
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f0fd747 and be95514.

📒 Files selected for processing (1)
  • Makefile.d/docker.mk (3 hunks)
🔇 Additional comments (3)
Makefile.d/docker.mk (3)

375-375: LGTM! Correct HDF5 version reference for benchmark-job image.

The build argument now correctly references HDF5_VERSION instead of HDF4_VERSION.

Let's verify the corresponding Dockerfile uses this argument:

#!/bin/bash
# Check if the Dockerfile actually uses HDF5_VERSION
rg -l 'ARG HDF5_VERSION' dockers/tools/benchmark/job/

398-398: LGTM! Correct HDF5 version reference for example-client image.

The build argument now correctly references HDF5_VERSION instead of HDF4_VERSION.

Let's verify the corresponding Dockerfile uses this argument:

#!/bin/bash
# Check if the Dockerfile actually uses HDF5_VERSION
rg -l 'ARG HDF5_VERSION' dockers/example/client/

Line range hint 307-398: Verify HDF5_VERSION variable is defined.

The changes look good, but we should ensure the HDF5_VERSION variable is properly defined.

Let's check if HDF5_VERSION is defined in the Makefile:

#!/bin/bash
# Check where HDF5_VERSION is defined
rg 'HDF5_VERSION[:=]' Makefile.d/

@@ -304,7 +304,7 @@ docker/name/loadtest:
## build loadtest image
docker/build/loadtest:
@make DOCKERFILE="$(ROOTDIR)/dockers/tools/cli/loadtest/Dockerfile" \
DOCKER_OPTS="$${DOCKER_OPTS:+$${DOCKER_OPTS}} --build-arg ZLIB_VERSION=$(ZLIB_VERSION) --build-arg HDF4_VERSION=$(HDF5_VERSION)" \
DOCKER_OPTS="$${DOCKER_OPTS:+$${DOCKER_OPTS}} --build-arg ZLIB_VERSION=$(ZLIB_VERSION) --build-arg HDF5_VERSION=$(HDF5_VERSION)" \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Warning: HDF5_VERSION build argument is not used in the Dockerfile

The Dockerfile for the loadtest image does not use the HDF5_VERSION build argument that's being passed in the Makefile. Instead, it installs HDF5 using make hdf5/install without referencing the version argument. This suggests a potential issue where the build argument is being passed but not utilized.

  • dockers/tools/cli/loadtest/Dockerfile: Uses make hdf5/install without version specification
  • Makefile.d/docker.mk:307: Passes unused --build-arg HDF5_VERSION=$(HDF5_VERSION)
🔗 Analysis chain

LGTM! Correct HDF5 version reference for loadtest image.

The build argument now correctly references HDF5_VERSION instead of HDF4_VERSION.

Let's verify the corresponding Dockerfile uses this argument:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the Dockerfile actually uses HDF5_VERSION
rg -l 'ARG HDF5_VERSION' dockers/tools/cli/loadtest/

Length of output: 591


Script:

#!/bin/bash
# Let's try to find the Dockerfile for loadtest and check its content
fd Dockerfile dockers/tools/cli/loadtest/

# Also search for any Dockerfile that uses HDF5_VERSION
fd Dockerfile | xargs rg "ARG HDF5_VERSION"

Length of output: 127


Script:

#!/bin/bash
# Let's examine the content of the loadtest Dockerfile
cat dockers/tools/cli/loadtest/Dockerfile

Length of output: 3562

@kmrmt kmrmt merged commit 8e61649 into main Oct 25, 2024
179 checks passed
@kmrmt kmrmt deleted the bugfix/makefile/fix-typo branch October 25, 2024 06:35
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
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