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

Enhance CI Workflow and Update Protobuf Generation #126

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

naveensrinivasan
Copy link
Member

@naveensrinivasan naveensrinivasan commented Nov 12, 2024

Description:

  • CI Workflow Enhancements:

    • Updated the GitHub Actions workflow to include a new buf-generate target in the git-porcelain task. This ensures that protobuf files are generated as part of the CI checks.
    • Added a conditional installation of buf in the CI environment. If buf is not installed, it will be automatically downloaded and installed during CI runs. This prevents build failures due to missing dependencies in CI environments.
  • Makefile Updates:

    • Introduced a new buf-generate target in the Makefile, which depends on the install-buf target. This target runs buf generate to regenerate protobuf files.
    • Added install-buf target to conditionally install buf only in CI environments. This ensures that local development environments are not affected if buf is not installed.
    • Updated the all target to include buf-generate, ensuring that all necessary build steps are executed.
  • Protobuf File Update:

    • Updated the gen/api/v1/service.pb.go file to reflect changes in the protobuf generation. This includes minor changes in the file descriptor bytes, likely due to updates in the source .proto files or the buf tool version.

Impact:

  • These changes improve the robustness of the CI pipeline by ensuring all necessary tools and steps are included.
  • The updates to the protobuf files ensure that the generated code is up-to-date with the latest .proto definitions.

Notes:

  • Developers should ensure buf is installed locally if they wish to run buf-generate outside of CI.
  • The changes in the protobuf file are automatically generated and should be reviewed to ensure compatibility with existing code.

Summary by CodeRabbit

  • New Features

    • Introduced a new target for generating necessary tools in CI environments.
    • Enhanced the default build process to include the new tool generation step.
  • Improvements

    • Streamlined the build and test processes for better efficiency and clarity.
    • Updated the organization of build targets for improved dependency management.

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Warning

Rate limit exceeded

@naveensrinivasan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 22 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between be3978b and 229252d.

Walkthrough

The changes in this pull request focus on modifications to the Makefile to improve its functionality and organization. Key updates include the addition of new targets such as buf-generate and install-buf, along with dependencies for the git-porcelain target. The all target has been expanded to include buf-generate, and the .PHONY declarations have been updated accordingly. These changes streamline the build and test processes and enhance the management of dependencies and installation of tools.

Changes

File Change Summary
Makefile - Added targets: buf-generate, install-buf
- Updated target signatures for git-porcelain and all to include new dependencies
- Updated .PHONY declaration to include buf-generate and install-buf

Possibly related PRs

  • Adding Offline OSV data support, and ConnectRPC #92: The Makefile in this PR has been updated to include a new target test-e2e, which is related to the modifications made in the main PR that also involve changes to the Makefile structure and target management.

🐇 In the garden where we play,
New targets hop in every way.
buf-generate joins the fun,
With install-buf, our work is done!
A streamlined path, so clear and bright,
Building dreams from day to night. 🌼


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.

@naveensrinivasan naveensrinivasan changed the title **Title: Enhance CI Workflow and Update Protobuf Generation** Enhance CI Workflow and Update Protobuf Generation Nov 12, 2024
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Reviewing files that changed from the base of the PR and between 03dd130 and be3978b.

⛔ Files ignored due to path filters (1)
  • gen/api/v1/service.pb.go is excluded by !**/*.pb.go, !**/gen/**
📒 Files selected for processing (1)
  • Makefile (1 hunks)
🔇 Additional comments (4)
Makefile (4)

40-40: LGTM: Appropriate dependency chain for git-porcelain

The addition of buf-generate to the git-porcelain target ensures that protobuf files are generated before checking for uncommitted changes, which helps catch any protobuf-related modifications early in the CI process.


43-45: LGTM: Clear separation of generation and installation concerns

The buf-generate target appropriately depends on install-buf, ensuring the tool is available before attempting generation.


66-66: LGTM: Appropriate addition to default target

Adding buf-generate to the all target ensures protobuf files are generated during standard build processes, maintaining consistency between proto definitions and generated code.


68-68: LGTM: Proper .PHONY declaration

The .PHONY declaration has been appropriately updated to include the new targets, ensuring make correctly handles these targets as commands rather than files.

Makefile Outdated Show resolved Hide resolved
**Description:**

- **CI Workflow Enhancements:**
  - Updated the GitHub Actions workflow to include a new `buf-generate` target in the `git-porcelain` task. This ensures that protobuf files are generated as part of the CI checks.
  - Added a conditional installation of `buf` in the CI environment. If `buf` is not installed, it will be automatically downloaded and installed during CI runs. This prevents build failures due to missing dependencies in CI environments.

- **Makefile Updates:**
  - Introduced a new `buf-generate` target in the Makefile, which depends on the `install-buf` target. This target runs `buf generate` to regenerate protobuf files.
  - Added `install-buf` target to conditionally install `buf` only in CI environments. This ensures that local development environments are not affected if `buf` is not installed.
  - Updated the `all` target to include `buf-generate`, ensuring that all necessary build steps are executed.

- **Protobuf File Update:**
  - Updated the `gen/api/v1/service.pb.go` file to reflect changes in the protobuf generation. This includes minor changes in the file descriptor bytes, likely due to updates in the source `.proto` files or the `buf` tool version.

**Impact:**
- These changes improve the robustness of the CI pipeline by ensuring all necessary tools and steps are included.
- The updates to the protobuf files ensure that the generated code is up-to-date with the latest `.proto` definitions.

**Notes:**
- Developers should ensure `buf` is installed locally if they wish to run `buf-generate` outside of CI.
- The changes in the protobuf file are automatically generated and should be reviewed to ensure compatibility with existing code.

Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com>
@naveensrinivasan naveensrinivasan merged commit 4c6c3d1 into main Nov 12, 2024
9 checks passed
@naveensrinivasan naveensrinivasan deleted the naveen/buf branch November 12, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant