Skip to content

#### Flow diagram for CI job dependencies in node.js.yml #18

@Dargon789

Description

@Dargon789

Reviewer's Guide

Introduces a new GitHub Actions workflow to set up a CI pipeline with dependency installation, Solidity linting, and Foundry tests, and includes a commented-out coverage job for future use.

Flow diagram for CI job dependencies in node.js.yml

flowchart TD
  install["Install dependencies job"] --> lint_sol["Solidity lint job"]
  install --> foundry_tests["Foundry tests job"]
Loading

File-Level Changes

Change Details Files
Add install job with dependency caching
  • Checkout repository with submodules
  • Setup Node.js v18
  • Cache node_modules based on package.json and yarn.lock
  • Install dependencies with yarn
.github/workflows/node.js.yml
Add Solidity lint job
  • Checkout repository and setup Node.js v18
  • Reuse cache for node_modules
  • Install Foundry nightly
  • Run yarn lint:sol
.github/workflows/node.js.yml
Add Foundry tests job
  • Checkout repository and setup Node.js v18
  • Reuse cache for node_modules
  • Install Foundry nightly
  • Run forge tests with FOUNDRY_FUZZ_RUNS=1024
.github/workflows/node.js.yml
Include commented-out coverage job
  • Provide template for a coverage step using yarn coverage
  • Configure Coveralls upload with GitHub token
.github/workflows/node.js.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #17 (comment)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomers

Projects

Status

Backlog

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions