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

feat: justfile works with Linux now #177

Merged
merged 10 commits into from
Dec 18, 2024

Conversation

smuu
Copy link
Contributor

@smuu smuu commented Dec 17, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced cross-platform compatibility for Docker commands based on the operating system.
    • Improved dependency checks and installations for essential packages on Linux.
  • Bug Fixes

    • Updated checks for the cargo prove command to enhance reliability.

@smuu smuu requested a review from distractedm1nd December 17, 2024 08:24
Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request modifies the justfile to improve cross-platform compatibility, particularly for Docker commands and dependency management. The changes introduce a helper function to determine the appropriate Docker command based on the operating system, replacing direct calls to docker-compose with a command variable. The install-deps target now includes checks for essential packages on Linux, and the verification for the cargo prove command has been updated to use version checks instead of simple existence checks.

Changes

File Change Summary
justfile Added OS-specific conditional logic for Docker commands (celestia-up, celestia-down, celestia-logs)
justfile Enhanced Linux package installation checks in install-deps target
justfile Updated cargo prove command verification to use version checks

Possibly related PRs

Suggested reviewers

  • distractedm1nd

Poem

🐰 A Justfile's Cross-Platform Dance
Docker commands, Linux or Mac,
Compose or hyphen, we're on the right track!
Packages checked with a rabbit's keen eye,
Compatibility soaring, no system too shy!
Just a script, but oh so smart! 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e90f3af and eb5505d.

📒 Files selected for processing (1)
  • justfile (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • justfile

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.

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

🧹 Nitpick comments (1)
justfile (1)

153-164: Improve Linux package management robustness

The current implementation has several limitations:

  1. Only supports Debian/Ubuntu based systems
  2. Doesn't verify package versions
  3. Lacks error handling for failed installations

Consider enhancing the Linux package installation:

 if [ "$OS" = "Linux" ]; then \
+  # Detect package manager
+  if command -v apt > /dev/null; then \
+    PKG_MANAGER="apt"
+  elif command -v dnf > /dev/null; then \
+    PKG_MANAGER="dnf"
+  else \
+    echo "Unsupported Linux distribution. Please install dependencies manually."
+    exit 1
+  fi
+
   for package in build-essential pkg-config libssl-dev libclang-dev clang; do \
-    if ! dpkg -s $package > /dev/null 2>&1; then \
+    if ! command -v $package > /dev/null 2>&1; then \
       echo "Installing $package..."; \
-      sudo apt update; \
-      sudo apt install $package -y; \
+      if [ "$PKG_MANAGER" = "apt" ]; then \
+        sudo apt update || { echo "Failed to update package list"; exit 1; }
+        sudo apt install $package -y || { echo "Failed to install $package"; exit 1; }
+      elif [ "$PKG_MANAGER" = "dnf" ]; then \
+        sudo dnf install $package -y || { echo "Failed to install $package"; exit 1; }
+      fi
     else \
       echo "$package is already installed."; \
     fi; \
   done; \
 fi
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 987b01c and e90f3af.

📒 Files selected for processing (1)
  • justfile (5 hunks)

justfile Outdated Show resolved Hide resolved
justfile Show resolved Hide resolved
@distractedm1nd distractedm1nd merged commit 34876ff into main Dec 18, 2024
5 checks passed
@smuu smuu deleted the smuu/20241214-justfile-on-linux branch December 19, 2024 11:53
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