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 #2707 to release/v1.7 for Add auto deps version update workflow #2717

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Oct 24, 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

  • New Features

    • Enhanced GitHub Actions workflow for updating dependencies with a broader scope and more descriptive naming.
    • Introduced new commands for managing dependencies and improving code quality, including formatting and linting enhancements.
    • Added automated update targets for the buf and usearch tools.
  • Chores

    • Updated the Makefile to streamline dependency management and installation procedures, ensuring better organization and usability.
    • Expanded the update process to include example Go project dependencies and improved the handling of empty files during formatting.

* 💚 Add auto deps version update workflow

Signed-off-by: vankichi <[email protected]>

* 💚 Update make commands

Signed-off-by: vankichi <[email protected]>

* 💚 Fix

Signed-off-by: vankichi <[email protected]>

* 💚 Add make permission

Signed-off-by: vankichi <[email protected]>

* 💚 Add labels

Signed-off-by: vankichi <[email protected]>

* 💚 Fix

Signed-off-by: vankichi <[email protected]>

---------

Signed-off-by: vankichi <[email protected]>
Copy link

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

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: cdb3505
Status: ✅  Deploy successful!
Preview URL: https://2dc78ed8.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-ci-mak-ho77.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve modifications to a GitHub Actions workflow and updates to the Makefile and its dependencies. The workflow's name and pull request details have been updated to reflect a focus on dependency management rather than Actions. The Makefile has been enhanced to include new targets for managing Go project dependencies and formatting tools, while the dependencies.mk file has introduced targets for updating specific tools. These changes collectively improve the project's dependency management and build processes.

Changes

File Change Summary
.github/workflows/update-deps.yaml Updated workflow name, pull request title, and body; modified steps to include new commands and a new label-checking step.
Makefile Expanded update target to include go/example/deps; updated format target to remove empty files and added formatting tools.
Makefile.d/dependencies.mk Added .PHONY targets for update/buf and update/usearch to fetch the latest versions of these tools.

Possibly related PRs

Suggested labels

priority/low, type/ci, size/XXXL, area/makefile, actions/backport/release/v1.7

Suggested reviewers

  • vankichi
  • 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.

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: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c845e81 and cdb3505.

📒 Files selected for processing (3)
  • .github/workflows/update-deps.yaml (4 hunks)
  • Makefile (1 hunks)
  • Makefile.d/dependencies.mk (4 hunks)
🧰 Additional context used
🪛 actionlint
.github/workflows/update-deps.yaml

67-67: shellcheck reported issue in this script: SC2086:info:3:39: Double quote to prevent globbing and word splitting

(shellcheck)


67-67: shellcheck reported issue in this script: SC2086:info:5:18: Double quote to prevent globbing and word splitting

(shellcheck)


67-67: shellcheck reported issue in this script: SC2086:info:6:76: Double quote to prevent globbing and word splitting

(shellcheck)

🔇 Additional comments (6)
.github/workflows/update-deps.yaml (2)

85-87: Verify PR title format consistency

Let's ensure the PR title format matches other dependency update PRs in the project.

#!/bin/bash
# Check format of other dependency update PR titles
gh pr list --repo vdaas/vald --search "Update libs dependency in:title" --json title --limit 5

Line range hint 16-21: Verify cron schedule for backported branch

Since this is a backport to the release/v1.7 branch, please verify if running daily dependency updates ("0 0 * * *") is appropriate for a release branch. Release branches typically have more controlled update cycles.

✅ Verification successful

Let me try another search strategy to gather more information about dependency update workflows across branches.

This will help us understand:

  1. All workflow files related to dependency/version updates
  2. Their respective scheduling patterns across different workflow files

Let me generate the final response based on the gathered information.

Daily dependency updates are consistent with project practices

The daily cron schedule ("0 0 * * *") for dependency updates is appropriate even for the release branch because:

  1. The repository shows a consistent pattern of daily or hourly scheduled maintenance tasks:
    • Security scans run daily ("0 1 * * *" for CodeQL and Docker image scans)
    • Build-related tasks run hourly for critical infrastructure (buildkit, buildbase, etc.)
  2. Having automated dependency updates on release branches helps identify potential security fixes and critical updates promptly, which can then be reviewed before merging.

The workflow allows manual triggering (workflow_dispatch), so the team can still control when to actually merge the updates, making it safe for release branches.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if other release branches have different update schedules
rg -U "cron:.*0 0 \* \* \*" .github/workflows/ -A 5 -B 5

Length of output: 99


Script:

#!/bin/bash
# Search for any workflow files with dependency or version updates
fd -e yaml -e yml . .github/workflows/ --exec grep -l -i "update.*dep\|update.*version" {} \;

# For each found file, show their cron schedules
echo "=== Cron schedules in found files ==="
fd -e yaml -e yml . .github/workflows/ --exec sh -c 'echo "File: {}"; grep -A 2 "schedule:" {} || true; echo' \;

Length of output: 3958

Makefile.d/dependencies.mk (1)

20-20: LGTM: New dependencies properly added to update/libs target

The new dependencies update/buf and update/usearch are correctly added to the list while maintaining alphabetical order.

Also applies to: 42-42

Makefile (3)

499-499: LGTM: Addition of go/example/deps to update target

The addition of go/example/deps to the update target ensures that example code dependencies are also updated during the update process.


Line range hint 500-503: LGTM: New format target with empty file removal

The format target now includes remove/empty/file, which helps maintain a cleaner codebase by removing empty files. The implementation correctly preserves .gitkeep files and checks for truly empty files (only whitespace/newlines).


Line range hint 505-507: LGTM: Well-implemented empty file removal

The remove/empty/file target implementation:

  • Correctly uses find with proper filters
  • Preserves .gitkeep files
  • Uses parallel processing with xargs
  • Properly checks for truly empty files using grep

.github/workflows/update-deps.yaml Show resolved Hide resolved
.github/workflows/update-deps.yaml Show resolved Hide resolved
Makefile.d/dependencies.mk Show resolved Hide resolved
Makefile.d/dependencies.mk Show resolved Hide resolved
@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 1dd93e8 into release/v1.7 Oct 25, 2024
150 of 151 checks passed
@vankichi vankichi deleted the backport/release/v1.7/ci/makefile-github/add-auto-dependencies-update branch October 25, 2024 04:53
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