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 foundry version check #534

Merged
merged 1 commit into from
Feb 24, 2025
Merged

Fix foundry version check #534

merged 1 commit into from
Feb 24, 2025

Conversation

neekolas
Copy link
Contributor

@neekolas neekolas commented Feb 21, 2025

tl;dr

Foundry seems to have updated the way they display versions from v1.0.0 to 1.0.0-stable, which breaks our Foundry check

Summary by CodeRabbit

  • Chores
    • Refined the version verification logic for a key dependency to ensure compatibility, so users receive the correct prompt if the required version isn’t installed.

Copy link

coderabbitai bot commented Feb 21, 2025

Walkthrough

The pull request updates the version verification for the Foundry tool within a shell script. The conditional check that previously looked for the string "v1.0.0" now checks for "1.0.0" without the "v" prefix. The change preserves the existing error message and overall control flow within the script.

Changes

File(s) Changed Change Summary
dev/up (shell script) Updated the Foundry version check by removing the "v" prefix, changing the check from "v1.0.0" to "1.0.0".

Possibly related PRs

  • chore: update to foundry v1.0.0 #523: Addresses a similar update in the Foundry version check by modifying the version from "v0.3.0" to "v1.0.0", indicating closely related code-level changes.

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 Author

neekolas commented Feb 21, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@neekolas neekolas marked this pull request as ready for review February 21, 2025 19:04
@neekolas neekolas requested a review from a team as a code owner February 21, 2025 19:04
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 15a8b8d and 4e86897.

📒 Files selected for processing (1)
  • dev/up (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test (Node)
  • GitHub Check: Build pre-baked anvil-xmtpd

@@ -2,7 +2,7 @@
set -e

if ! which forge &>/dev/null; then echo "ERROR: Missing foundry binaries. Run 'curl -L https://foundry.paradigm.xyz | bash' and follow the instructions to install foundry 1.0.0" && exit 1; fi
if ! forge --version | grep -q "v1.0.0"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi
if ! forge --version | grep -q "1.0.0"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Verify Foundry version output format and improve version check precision.

While removing the "v" prefix aligns with Foundry's version output, the current grep check could be too permissive. It might match "1.0.0" within other version strings (e.g., "11.0.0" or "1.0.01").

Let's verify the Foundry version output format and check for potential version mismatches:

Consider using a more precise version check:

-if ! forge --version | grep -q "1.0.0"; then
+if ! forge --version | grep -q "^forge 1\.0\.0\b"; then

This ensures:

  1. The version string starts with "forge "
  2. Exactly matches "1.0.0"
  3. Prevents partial matches within other version numbers

🏁 Script executed:

#!/bin/bash
# Description: Check Foundry version output format and test version string matching

# Get Foundry version output format
forge --version

# Test if the current grep would incorrectly match these versions
echo "forge 11.0.0" | grep -q "1.0.0" && echo "WARNING: Would incorrectly match 11.0.0"
echo "forge 1.0.01" | grep -q "1.0.0" && echo "WARNING: Would incorrectly match 1.0.01"

Length of output: 367


Action Required: Refine the Foundry version check for precise matching.

  • The current grep check with "1.0.0" is too permissive and incorrectly matches version strings such as 11.0.0 and 1.0.01.
  • Verification via test commands confirms that these false positives occur.
  • It is recommended to use a regex that anchors to the start of the version string and enforces exact matching.

Consider updating the version check in dev/up as follows:

-if ! forge --version | grep -q "1.0.0"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi
+if ! forge --version | grep -q "^forge 1\.0\.0\b"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if ! forge --version | grep -q "1.0.0"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi
if ! forge --version | grep -q "^forge 1\.0\.0\b"; then echo "ERROR: Foundry version is not 1.0.0. Please install the correct version." && exit 1; fi

@neekolas neekolas merged commit 1f8192f into main Feb 24, 2025
9 checks passed
@neekolas neekolas deleted the 02-21-fix_foundry_version_check branch February 24, 2025 15:48
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