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: Update pre-commit and streamline openapi build process #39

Merged
merged 2 commits into from
Jan 23, 2025

Conversation

flemzord
Copy link
Member

Add 'openapi' to pre-commit tasks and simplify the Earthfile openapi target by reusing the base image and modifying artifact handling. Removed redundant commands for merging and YAML conversion for increased clarity and efficiency in the build setup.

Add 'openapi' to pre-commit tasks and simplify the Earthfile openapi target by reusing the base image and modifying artifact handling. Removed redundant commands for merging and YAML conversion for increased clarity and efficiency in the build setup.
Copy link

coderabbitai bot commented Jan 23, 2025

Walkthrough

The pull request introduces modifications to the project's build and development workflow. The changes primarily affect the Earthfile, Justfile, and flake.nix. The Earthfile has been simplified by removing the tidy and release sections, while the openapi section now uses a different base image and directly handles the OpenAPI specification. The Justfile has been updated to include the openapi target in the pre-commit workflow, ensuring OpenAPI specification generation is part of the pre-commit checks. Additionally, yq-go has been added as a dependency in the flake.nix.

Changes

File Changes
Earthfile - Removed tidy section
- Removed release section
- Modified openapi section to use core+base-image
- Simplified OpenAPI specification handling
Justfile - Updated pre-commit target to include openapi
flake.nix - Added yq-go to devShells for all supported systems

Poem

🐰 Hopping through code with glee,
OpenAPI now flows free!
Earthfile trimmed, workflow neat,
Pre-commit checks now complete.
A rabbit's build, swift and light! 🚀


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@flemzord flemzord changed the title Update pre-commit and streamline openapi build process Update pre-commit and streamline openapi builfix: d process Jan 23, 2025
@flemzord flemzord changed the title Update pre-commit and streamline openapi builfix: d process fix: Update pre-commit and streamline openapi build process Jan 23, 2025
The `openapi.yaml` file has been deleted from the repository. This file contained the OpenAPI specification for the orchestration service API but is no longer needed. Removing it helps clean up obsolete or unused resources.
@flemzord flemzord enabled auto-merge January 23, 2025 11:19
Copy link

@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

🧹 Nitpick comments (1)
flake.nix (1)

100-100: LGTM! Consider version pinning and documentation.

The addition of yq-go aligns well with the OpenAPI build process streamlining. However, consider:

  1. Pinning the version for consistency across development environments
  2. Adding a comment to document its role in the OpenAPI workflow

Apply this diff to add version pinning and documentation:

-              yq-go
+              # Required for OpenAPI YAML processing in pre-commit checks
+              yq-go-0_4_51
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc41c8a and 04f7e60.

📒 Files selected for processing (1)
  • flake.nix (1 hunks)

@flemzord flemzord merged commit dad82a7 into main Jan 23, 2025
7 checks passed
@flemzord flemzord deleted the fix/nix-config branch January 23, 2025 11:20
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.

2 participants