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

chore: pin abigen version #353

Merged
merged 1 commit into from
Dec 23, 2024
Merged

chore: pin abigen version #353

merged 1 commit into from
Dec 23, 2024

Conversation

fbac
Copy link
Collaborator

@fbac fbac commented Dec 23, 2024

Pin the abigen version, so generated golang code is deterministically generated.
Different versions could introduce changes, and we should avoid pushing generated code with different versions.

Summary by CodeRabbit

  • New Features

    • Introduced version pinning for the abigen tool to ensure consistent installation.
    • Added a version check for abigen to verify installation integrity.
  • Bug Fixes

    • Removed the installation command for the abigen tool from the script, streamlining the installation process.

@fbac fbac requested a review from a team as a code owner December 23, 2024 12:56
Copy link

coderabbitai bot commented Dec 23, 2024

Warning

Rate limit exceeded

@fbac has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 29 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 2adcd51 and dfc104d.

📒 Files selected for processing (2)
  • dev/up (1 hunks)
  • dev/update-tools (0 hunks)

Walkthrough

The changes involve modifications to two scripts: dev/up and dev/update-tools. In the dev/up script, a version-specific installation of the abigen tool is implemented, with a strict version check for v1.14.12-stable. The dev/update-tools script has removed the previous abigen installation command, indicating a change in how this tool is managed within the development environment.

Changes

File Change Summary
dev/up Added version-specific abigen installation and version verification
dev/update-tools Removed go install github.com/ethereum/go-ethereum/cmd/abigen command

Sequence Diagram

sequenceDiagram
    participant Script as dev/up
    participant AbigenTool as Abigen Tool
    
    Script->>AbigenTool: Install abigen v1.14.12
    Script->>AbigenTool: Verify version is 1.14.12-stable
    alt Version Matches
        Script->>Script: Continue Execution
    else Version Mismatch
        Script-->>Script: Exit with Error (Status 1)
    end
Loading

The sequence diagram illustrates the new control flow for abigen installation and version verification in the dev/up script, showing the version check and potential script termination if the version does not match the expected 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

@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

🧹 Nitpick comments (1)
dev/up (1)

17-21: Clarify the comment text and unify version identifiers for abigen
The comment at line 17 is incomplete or somewhat unclear: "Pin abigen version at can introduce breaking changes…" – a word might be missing. Furthermore, the code installs abigen at version "v1.14.12," but the check below references "1.14.12-stable." Ensure these identifiers match so that the installed version aligns with the version check.

-# Pin abigen version at can introduce breaking changes between releases...
+# Pin abigen version as it can introduce breaking changes between releases...
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c48f822 and 2adcd51.

📒 Files selected for processing (2)
  • dev/up (1 hunks)
  • dev/update-tools (0 hunks)
💤 Files with no reviewable changes (1)
  • dev/update-tools

dev/up Show resolved Hide resolved
@fbac fbac force-pushed the chore/pin-abigen-version branch from 2adcd51 to dfc104d Compare December 23, 2024 13:05
@fbac fbac merged commit 39ea138 into main Dec 23, 2024
8 checks passed
@fbac fbac deleted the chore/pin-abigen-version branch December 23, 2024 13:06
@neekolas
Copy link
Contributor

The abigen version is set in the go.mod file. This shouldn't be necessary.

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.

3 participants