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 #2703 to release/v1.7 for update versions/BUF_VERSION #2704

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Oct 16, 2024

Description

Due to the current buf version, we cannot execute the make license format completely, so I have updated the buf version.
( buf@v2 can be used over 1.32.0 )

Note:
After updating the buf version, I executed make license format and observed that 2 docker files had changed the ENV order.

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

  • New Features

    • Added environment variable RUSTUP_HOME to enhance Rust tool configurations in Docker containers.
  • Version Update

    • Updated application version from v1.28.1 to v1.45.0.

Copy link

cloudflare-workers-and-pages bot commented Oct 16, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0067505
Status: ✅  Deploy successful!
Preview URL: https://bdba848f.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-deps-v.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

📝 Walkthrough

Walkthrough

The pull request includes modifications to two Dockerfiles and an update to a version file. Both Dockerfiles (dockers/agent/core/agent/Dockerfile and dockers/ci/base/Dockerfile) have had the RUSTUP_HOME environment variable added, improving the configuration for Rust tools. The installation processes remain largely unchanged, maintaining multi-stage builds and the use of specific entry points. Additionally, the version number in versions/BUF_VERSION has been updated from v1.28.1 to v1.45.0.

Changes

File Change Summary
dockers/agent/core/agent/Dockerfile Added ENV RUSTUP_HOME=${RUST_HOME}/rustup; installation process and multi-stage build structure unchanged.
dockers/ci/base/Dockerfile Added ENV RUSTUP_HOME=${RUST_HOME}/rustup; streamlined installation commands while retaining cleanup commands.
versions/BUF_VERSION Updated version from v1.28.1 to v1.45.0.

Possibly related PRs

Suggested labels

priority/low, size/S, area/makefile, area/helm, area/internal, actions/backport/release/v1.7

Suggested reviewers

  • vankichi
  • kpango

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)
dockers/ci/base/Dockerfile (2)

48-48: LGTM! Consider adding a comment for clarity.

The addition of the RUSTUP_HOME environment variable is a good practice for Rust development environments. It correctly sets the Rustup home directory as a subdirectory of RUST_HOME.

For improved readability, consider adding a comment explaining the purpose of this variable:

+# Set Rustup home directory
ENV RUSTUP_HOME=${RUST_HOME}/rustup

Line range hint 52-116: LGTM! Consider adding version pinning documentation.

The installation process is well-structured, using multi-stage builds and caching mechanisms for efficiency. The use of Makefile targets for installations is a good practice for maintainability.

To improve long-term maintainability, consider adding a comment or separate documentation file that lists the specific versions of major tools being installed. This would make it easier to track and update versions in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dee4c3f and 0067505.

📒 Files selected for processing (3)
  • dockers/agent/core/agent/Dockerfile (1 hunks)
  • dockers/ci/base/Dockerfile (1 hunks)
  • versions/BUF_VERSION (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • versions/BUF_VERSION
🧰 Additional context used
🔇 Additional comments (3)
dockers/agent/core/agent/Dockerfile (1)

43-43: LGTM: Addition of RUSTUP_HOME enhances Rust environment configuration

The addition of the RUSTUP_HOME environment variable is a positive change that aligns with Rust's best practices. It explicitly defines the home directory for Rustup, Rust's toolchain installer and version management tool. This change complements the existing CARGO_HOME variable and ensures a more complete and well-defined Rust development environment.

The placement and order of this variable in relation to other Rust-related environment variables are logical and maintain good readability. This addition should improve consistency and potentially ease troubleshooting of Rust-related issues in the build process.

dockers/ci/base/Dockerfile (2)

49-49: LGTM! PATH updated correctly.

The PATH environment variable has been correctly updated to include the Rustup binaries directory. This ensures that Rust tools installed via Rustup are accessible throughout the container.


Line range hint 1-121: Overall, the changes look good and align with the PR objectives.

The modifications to this Dockerfile improve the Rust development environment setup by properly configuring the RUSTUP_HOME variable and updating the PATH. These changes support the PR's goal of updating the buf version and enhancing the build environment.

The Dockerfile maintains good practices such as:

  1. Using multi-stage builds and caching for efficiency
  2. Employing Makefile targets for consistent installations
  3. Maintaining a clear structure with logical grouping of commands

No security vulnerabilities or major issues were identified in this review.

@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

@vankichi vankichi merged commit 26098a4 into release/v1.7 Oct 16, 2024
38 of 39 checks passed
@vankichi vankichi deleted the backport/release/v1.7/deps/versions/update-buf-version-for-v2 branch October 16, 2024 07:46
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 2024
2 tasks
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.

2 participants