Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore: update to foundry v1.0.0 #523

Merged
merged 2 commits into from
Feb 19, 2025
Merged

chore: update to foundry v1.0.0 #523

merged 2 commits into from
Feb 19, 2025

Conversation

fbac
Copy link
Collaborator

@fbac fbac commented Feb 19, 2025

Update project to foundry v1.0.0:

  • Pin forge versions, and require them at v1.0.0
  • Minor changes to forge inspect.

Closes #493

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores

    • Updated the build and deployment workflows to require the latest Foundry (v1.0.0), ensuring consistency and clearer error messaging.
    • Enhanced the ABI generation process by providing JSON formatted outputs.
    • Updated the Dockerfile to install Foundry version 1.0.0.
  • Tests

    • Streamlined testing by removing unnecessary debug logging for a cleaner output during test execution.

@fbac fbac requested a review from a team as a code owner February 19, 2025 12:47
Copy link

coderabbitai bot commented Feb 19, 2025

Walkthrough

This pull request updates the configuration for Solidity projects by upgrading the Foundry toolchain from version v0.3.0 to v1.0.0 in the GitHub Actions workflow and the associated deployment script. It modifies the ABI generation command to include the --json flag and removes unused console imports from multiple Solidity test files. Enhanced error handling is introduced in the deployment script to ensure the correct version of Foundry is installed, while the overall control flow remains unchanged.

Changes

File(s) Change Summary
.github/workflows/solidity.yml Updated Foundry version from v0.3.0 to v1.0.0 in the "Install Foundry" step.
.github/workflows/test.yml Changed Foundry version from a nightly version to v1.0.0.
contracts/dev/generate Added --json flag to forge inspect command for ABI generation.
contracts/test/GroupMessage.t.sol,
contracts/test/IdentityUpdates.t.sol,
contracts/test/Nodes.sol
Removed console imports to eliminate unused debugging functionality.
dev/up Enhanced error handling to check for the presence and correct version (1.0.0) of Foundry, with updated error messages.
dev/baked/Dockerfile Updated FOUNDRY_VERSION argument from 0.3.0 to 1.0.0.

Possibly related PRs

  • ci: slither and soldeer #310: The changes in the main PR, which update the Foundry toolchain version in the GitHub Actions workflow, are related to the modifications in the retrieved PR that also involve the installation and usage of the Foundry toolchain, specifically in the context of continuous integration workflows.

Suggested reviewers

  • mkysel
  • neekolas

📜 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 f933d18 and 8ede17b.

📒 Files selected for processing (2)
  • .github/workflows/test.yml (1 hunks)
  • dev/baked/Dockerfile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test (Node)
  • GitHub Check: Build pre-baked anvil-xmtpd
🔇 Additional comments (3)
.github/workflows/test.yml (1)

33-33: Foundry Version Update in Workflow
The Foundry version is now pinned to v1.0.0, which aligns perfectly with the PR objectives. Please verify that this version update does not introduce any unexpected issues in the testing environment.

dev/baked/Dockerfile (2)

3-3: Update Foundry Build Argument
The ARG FOUNDRY_VERSION has been updated to 1.0.0, ensuring consistency with the overall upgrade. This change appears correct and in-line with the PR objectives.


15-18: Verify Installation Command Consistency
The installation command using foundryup -i "${FOUNDRY_VERSION}" should now install Foundry v1.0.0. Please double-check that the installation process and any downstream commands or scripts are fully compatible with the new version.


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
Collaborator

@mkysel mkysel left a comment

Choose a reason for hiding this comment

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

can you also pin the correct version in the pre-baked docker image? And in nightly tests.

@fbac fbac requested a review from mkysel February 19, 2025 17:04
@fbac fbac merged commit 92fc298 into main Feb 19, 2025
14 checks passed
@fbac fbac deleted the tools/foundry-v1.0.0 branch February 19, 2025 19:36
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate to foundry v1.0.0
2 participants