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

ci: run slither only for v2 contracts #230

Merged
merged 2 commits into from
Jul 17, 2024
Merged

ci: run slither only for v2 contracts #230

merged 2 commits into from
Jul 17, 2024

Conversation

fbac
Copy link
Contributor

@fbac fbac commented Jul 16, 2024

Closes #228

Summary by CodeRabbit

  • Chores
    • Updated Slither workflow to include new configuration parameter to target specific contracts.
    • Expanded the scope of filtered paths in the Slither configuration for more comprehensive analysis.

Copy link
Contributor

coderabbitai bot commented Jul 16, 2024

Walkthrough

The changes optimize the Slither analysis by targeting it solely on v2 contracts located in the contracts/prototypes directory and excluding legacy contracts in the contracts/evm and contracts/zevm directories. This adjustment ensures Slither is run only where needed, enhancing efficiency.

Changes

File Change Summary
.github/workflows/slither.yaml Added target: contracts/prototypes to the Slither workflow configuration.
slither.config.json Updated filter_paths to include contracts/evm and contracts/zevm, excluding them from analysis.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Run Slither only for v2 contracts (#228)
Skip running Slither for legacy contracts (#228)

Poem

In the land where code does spring,
Slither now has found its ring.
For v2 it casts its gaze,
Ignoring the old in its maze.
Efficiency blooms, the new it scans,
Hopping forward with its plans.
🌟🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@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: 0

Outside diff range, codebase verification and nitpick comments (1)
.github/workflows/slither.yaml (1)

Line range hint 1-47: Review of the general workflow setup.

The workflow is triggered on various events (push and pull_request), which is standard for CI processes. The use of actions/checkout@v3 with recursive submodules, actions/setup-node@v2 with Node.js 18, and foundry-rs/foundry-toolchain@v1 for smart contract compilation are appropriate choices.

  • Security: Permissions are correctly scoped to contents: read and security-events: write, which minimizes potential security risks.
  • Efficiency: The workflow steps are logically ordered and should execute without unnecessary delays.

Consider verifying if yarn build optimally configures for production environments, especially in terms of minimizing build artifacts and optimizing performance.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 180b8c8 and 5435ddc.

Files selected for processing (1)
  • .github/workflows/slither.yaml (1 hunks)
Additional comments not posted (1)
.github/workflows/slither.yaml (1)

48-48: Ensure correct targeting for Slither analysis.

The configuration change to target contracts/prototypes for Slither analysis aligns with the PR objectives and issue #228. This should effectively focus the static analysis on the v2 contracts as intended.

Signed-off-by: Francisco de Borja Aranda Castillejo <[email protected]>
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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5435ddc and 0ce2bd8.

Files selected for processing (1)
  • slither.config.json (1 hunks)
Additional comments not posted (1)
slither.config.json (1)

3-3: Configuration update to exclude legacy contracts paths is correct.

The update to the filter_paths field correctly includes the paths contracts/evm and contracts/zevm to be excluded from Slither analysis. This change aligns with the PR objectives and optimizes the analysis process by focusing on the relevant v2 contracts.

@lumtis
Copy link
Member

lumtis commented Jul 17, 2024

@skosito can you check this one sometime?

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.29%. Comparing base (2bbd352) to head (df1eb0f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #230   +/-   ##
=======================================
  Coverage   58.29%   58.29%           
=======================================
  Files          11       11           
  Lines         235      235           
  Branches       61       61           
=======================================
  Hits          137      137           
  Misses         98       98           

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

@fbac fbac merged commit d8724e0 into main Jul 17, 2024
10 of 11 checks passed
@fbac fbac deleted the slither-only-v2 branch July 17, 2024 16:53
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.

Run Slither only for v2 contracts
4 participants