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 #2595 to release/v1.7 for automatically generate workflows #2603

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Sep 10, 2024

  • write a go flie that automatically generates workflows for building docker images

Description

  • write hack/actions/gen/main.go
  • add a workflow recipe to Makefile to run hack/actions/gen/main.go

Related Issue

Versions

  • Vald Version: v1.7.13
  • Go Version: v1.23.0
  • Rust Version: v1.80.0
  • Docker Version: v27.1.1
  • Kubernetes Version: v1.30.3
  • Helm Version: v3.15.3
  • NGT Version: v2.2.4
  • Faiss Version: v1.8.0

Checklist

Special notes for your reviewer

  • considering whether to unify the Name field and the AppName field in Data type
    • the role is the same, but the naming rule is a little different
  • does it matter that failing actions test in Run formatter / check-format-diff?
  • not confident if the naming workflow or actions are appropriate
    • implemented an auto generation file of workflows for ONLY building docker image
  • decided not to do the followings:
    • extract map data of components in a single source file
    • implement the logic of judging if each component is depends on internal/k8s/**
      • in this PR, that is judged by manually adding components name to conditions of case sentence

Summary by CodeRabbit

  • New Features

    • Introduced multiple new workflows for building Docker images for various components (e.g., agent, benchmark job, index creation).
    • Enhanced automation for generating GitHub Actions workflow files.
  • Improvements

    • Expanded trigger paths for pull requests and pushes across several workflows, improving responsiveness to relevant changes.
    • Reformatted branch and tag patterns for consistency and clarity in workflow configurations.
  • Chores

    • Added a new target in the Makefile for generating workflows, streamlining development tasks.

* chore: add an actions/gen folder to hack

* feat: add a generator of docker image building workflows

---------

Co-authored-by: Hiroto Funakoshi <[email protected]>
Copy link

cloudflare-workers-and-pages bot commented Sep 10, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 10aafe1
Status: ✅  Deploy successful!
Preview URL: https://c56c3691.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-featur-tnnn.vald.pages.dev

View logs

@CLAassistant
Copy link

CLAassistant commented Sep 10, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ vankichi
❌ smorihira
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

coderabbitai bot commented Sep 10, 2024

Walkthrough

Walkthrough

This pull request introduces a series of new GitHub Actions workflows for building Docker images for various components of the project, including "agent-faiss," "agent," "agent-ngt," "agent-sidecar," and others. Each workflow is triggered by specific events such as pushes, pull requests, and tag creations, and utilizes a reusable workflow defined in a common YAML file. Additionally, modifications are made to existing workflows to refine their triggering conditions and paths.

Changes

Files Change Summary
.github/workflows/dockers-agent-faiss-image.yaml Added workflow for building Docker image for "agent-faiss."
.github/workflows/dockers-agent-image.yaml Added workflow for building Docker image for "agent."
.github/workflows/dockers-agent-ngt-image.yaml Added workflow for building Docker image for "agent-ngt."
.github/workflows/dockers-agent-sidecar-image.yaml Added workflow for building Docker image for "agent-sidecar."
.github/workflows/dockers-benchmark-job-image.yaml Added workflow for building Docker image for "benchmark-job."
.github/workflows/dockers-benchmark-operator-image.yaml Modified triggering conditions for the benchmark operator workflow.
.github/workflows/dockers-binfmt-image.yaml Modified triggering conditions and paths for the "binfmt" workflow.
.github/workflows/dockers-buildbase-image.yaml Added workflow for building Docker image for "buildbase."
.github/workflows/dockers-buildkit-image.yaml Modified triggering conditions for the "buildkit" workflow.
.github/workflows/dockers-buildkit-syft-scanner-image.yaml Modified triggering conditions and paths for the "buildkit-syft-scanner" workflow.
.github/workflows/dockers-ci-container-image.yaml Added workflow for building Docker image for "ci-container."
.github/workflows/dockers-dev-container-image.yaml Added workflow for building Docker image for "dev-container."
.github/workflows/dockers-discoverer-k8s-image.yaml Added workflow for building Docker image for "discoverer-k8s."
.github/workflows/dockers-gateway-filter-image.yaml Added workflow for building Docker image for "gateway-filter."
.github/workflows/dockers-gateway-lb-image.yaml Added workflow for building Docker image for "gateway-lb."
.github/workflows/dockers-gateway-mirror-image.yaml Modified triggering conditions and paths for the "gateway-mirror" workflow.
.github/workflows/dockers-helm-operator-image.yaml Added workflow for building Docker image for "helm-operator."
.github/workflows/dockers-index-correction-image.yaml Added workflow for building Docker image for "index-correction."
.github/workflows/dockers-index-creation-image.yaml Added workflow for building Docker image for "index-creation."
.github/workflows/dockers-index-operator-image.yaml Added workflow for building Docker image for "index-operator."
.github/workflows/dockers-index-save-image.yaml Added workflow for building Docker image for "index-save."
.github/workflows/dockers-loadtest-image.yaml Added workflow for building Docker image for "loadtest."
.github/workflows/dockers-manager-index-image.yaml Added workflow for building Docker image for "manager-index."
.github/workflows/dockers-readreplica-rotate-image.yaml Added workflow for building Docker image for "readreplica-rotate."
Makefile Added a new target for generating workflows.
Makefile.d/functions.mk Introduced a new function for generating Docker workflows.
hack/actions/gen/main.go Added a command-line tool for automating the generation of GitHub Actions workflow files.

Possibly related PRs

Suggested labels

type/feature, priority/medium, type/ci, size/XL, area/makefile


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

@vankichi vankichi merged commit 97dc524 into release/v1.7 Sep 11, 2024
146 of 153 checks passed
@vankichi vankichi deleted the backport/release/v1.7/feature/hack/autobuilding-workflows branch September 11, 2024 03:24
@kpango kpango mentioned this pull request Oct 11, 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