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

platform bump [SLT-452] #3365

Merged
merged 5 commits into from
Nov 2, 2024
Merged

platform bump [SLT-452] #3365

merged 5 commits into from
Nov 2, 2024

Conversation

trajan0x
Copy link
Contributor

@trajan0x trajan0x commented Nov 2, 2024

Description

specify platform

Summary by CodeRabbit

  • Documentation

    • Updated CONTRIBUTING.md to provide clearer guidelines for contributors, including Notion ID usage, code coverage, and merging practices.
    • Enhanced README.md for tools/abigen with compatibility notes for macOS users and future work items for tool improvements.
  • Bug Fixes

    • Adjusted Docker command in the abigen tool to ensure compatibility with macOS Apple Silicon.

Copy link
Contributor

coderabbitai bot commented Nov 2, 2024

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 496c228 and e8ad50f.

Walkthrough

The pull request introduces several updates to the documentation and functionality of the project. The CONTRIBUTING.md file has been revised to clarify the contribution process, including guidelines for Notion ID inclusion, code coverage comments, and handling suggestions from the CodeRabbit tool. Additionally, it provides instructions for dependency management labels and merging practices. The README.md for tools/abigen has been enhanced with troubleshooting notes for macOS users and future work items. Lastly, a modification in generate.go specifies the Docker platform for running the Solidity compiler.

Changes

File Change Summary
CONTRIBUTING.md Updated to clarify contribution process: Notion ID inclusion, code coverage comments, CodeRabbit tool suggestions, dependency management labels, squash and merge guidelines, macOS Docker issues, and best practices restructuring.
tools/abigen/README.md Added notes on macOS compatibility issues with Docker, installation instructions for Rosetta, and future work items for improving the abigen tool.
tools/abigen/internal/generate.go Modified createRunFile function to include --platform linux/amd64 in the Docker command for running the Solidity compiler.

Sequence Diagram(s)

sequenceDiagram
    participant Contributor
    participant Repository
    participant CodeRabbitTool
    participant Docker

    Contributor->>Repository: Create Pull Request
    Repository->>Contributor: Request Notion ID
    Contributor->>Repository: Add Notion ID
    Contributor->>CodeRabbitTool: Run automated review
    CodeRabbitTool->>Contributor: Provide suggestions
    Contributor->>Repository: Address suggestions
    Contributor->>Repository: Merge PR with Squash and Merge
    Repository->>Docker: Run Solidity compiler with specified platform
Loading

🐰 "In the garden where ideas bloom,
Contributions grow, dispelling gloom.
With Notion IDs and coverage clear,
We hop along, spreading cheer!
Docker runs smooth on every ground,
In CodeRabbit's burrow, joy is found!" 🐇


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.

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.

@github-actions github-actions bot added go Pull requests that update Go code size/xs labels Nov 2, 2024
Copy link

codecov bot commented Nov 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 32.53226%. Comparing base (496c228) to head (0407bf0).

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #3365         +/-   ##
===================================================
- Coverage   33.74484%   32.53226%   -1.21259%     
===================================================
  Files            423         443         +20     
  Lines          27379       28670       +1291     
  Branches          82          82                 
===================================================
+ Hits            9239        9327         +88     
- Misses         17385       18585       +1200     
- Partials         755         758          +3     
Flag Coverage Δ
cctp-relayer 31.97848% <ø> (ø)
opbot 0.48870% <ø> (ø)
promexporter 6.81642% <ø> (?)
tools 30.55118% <100.00000%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0407bf0
Status: ✅  Deploy successful!
Preview URL: https://6bfe90a6.sanguine-fe.pages.dev
Branch Preview URL: https://fix-platform.sanguine-fe.pages.dev

View logs

@trajan0x trajan0x merged commit bd67b1b into master Nov 2, 2024
1 check passed
@trajan0x trajan0x deleted the fix/platform branch November 2, 2024 17:01
trajan0x added a commit that referenced this pull request Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Pull requests that update Go code needs-go-generate-services/rfq size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant