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: add go version comparison to rollkit install script #525

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Dec 3, 2024

Overview

This resolves the underlying issue from #523 where the user's go version was lower than the required version.

The script now explicitly checks the go version in the go.mod of rollkit and compares against the local version.

Example output now
Screenshot 2024-12-04 at 9 17 04 AM

Summary by CodeRabbit

  • New Features

    • Enhanced installation script with improved user feedback and error handling.
    • Introduced color-coded messages for different severity levels during installation.
    • Dynamic retrieval of required Go version from go.mod for better version management.
    • Added validation for installed Go version with detailed comparison messages.
  • Bug Fixes

    • Improved error handling for Go version extraction and installation checks.
  • Documentation

    • Updated user notifications to provide clearer information during the installation process.

@MSevey MSevey self-assigned this Dec 3, 2024
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The install.sh script has been significantly updated to enhance its functionality and user interaction during the installation process. New functions for printing messages with varying severity levels have been added, improving visibility through color coding. The script now includes a colored header for the download process, better error handling, and dynamic retrieval of the required Go version from go.mod. Additionally, the cleanup process has been improved with appropriate messaging, resulting in a more robust and user-friendly installation experience.

Changes

File Change Summary
public/install.sh - Added functions: print_header, print_success, print_warning, print_error, compare_versions.
- Replaced plain echo statements with new functions for improved messaging.
- Enhanced Go version extraction and validation with error handling and dynamic retrieval from go.mod.
- Updated cleanup process with header and success messages.

Possibly related PRs

Suggested reviewers

  • tuxcanfly
  • yarikbratashchuk
  • gupadhyaya
  • jcstein

🐇 "In the meadow, we hop with glee,
Our script now sings, as bright as can be!
With colors and headers, it guides our way,
Installation's a breeze, come join the play!
Errors are caught, and warnings are clear,
A joyful install, let's give a cheer!" 🌼


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

github-actions bot commented Dec 3, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-525/
on branch main at 2024-12-04 14:19 UTC

@MSevey MSevey marked this pull request as ready for review December 4, 2024 14:18
@MSevey MSevey enabled auto-merge (squash) December 4, 2024 14:18
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

🧹 Outside diff range and nitpick comments (3)
public/install.sh (3)

32-42: Consider enhancing version comparison robustness

The version comparison function works correctly for standard version formats, but could be more robust against edge cases.

Consider adding input validation:

 compare_versions() {
+    # Validate version string format
+    if ! [[ $1 =~ ^[0-9]+\.[0-9]+(\.[0-9]+)?$ ]] || ! [[ $2 =~ ^[0-9]+\.[0-9]+(\.[0-9]+)?$ ]]; then
+        print_error "Invalid version format. Expected format: X.Y[.Z]"
+        return 3
+    fi
     if [ "$(printf '%s\n' "$1" "$2" | sort -V | head -n1)" = "$1" ]; then

50-58: Enhance Go version extraction robustness

The Go version extraction could be more robust against malformed go.mod files.

Consider using a more precise grep pattern:

-go_mod_version=$(grep "^go " go.mod | cut -d' ' -f2)
+go_mod_version=$(grep -E "^go [0-9]+\.[0-9]+(\.[0-9]+)?$" go.mod | cut -d' ' -f2)

48-48: Add timeout for git clone operation

Long-running git operations could hang indefinitely.

Consider adding a timeout:

-cd rollkit || { print_error "Failed to find the downloaded repository."; exit 1; }
+if ! timeout 300 cd rollkit 2>/dev/null; then
+    print_error "Failed to find the downloaded repository or operation timed out"
+    exit 1
+fi
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0ea3d02 and 9ca90c8.

📒 Files selected for processing (1)
  • public/install.sh (1 hunks)

public/install.sh Show resolved Hide resolved
public/install.sh Show resolved Hide resolved
public/install.sh Show resolved Hide resolved
public/install.sh Show resolved Hide resolved
Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@MSevey MSevey merged commit 947489f into main Dec 4, 2024
10 checks passed
@MSevey MSevey deleted the check-go branch December 4, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants