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: enable codecov for code coverage #186

Merged
merged 5 commits into from
Jun 27, 2024
Merged

ci: enable codecov for code coverage #186

merged 5 commits into from
Jun 27, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Jun 27, 2024

Note: keeping a different action for regular test, and coverage, there is currently a non-blocking issue with ZetaConsumerEVM contract, where the regular test passes but not the coverage command. This keep test check and uploading coverage as two separate concerns.

Summary by CodeRabbit

  • New Features

    • Introduced GitHub Actions workflow for running tests and uploading coverage reports to Codecov.
    • Added configuration for testing and compiling Solidity contracts.
  • Chores

    • Updated GitHub Actions workflows to refine triggers and commands.
    • Updated solidity-coverage version and adjusted related scripts in package.json.

Copy link
Contributor

coderabbitai bot commented Jun 27, 2024

Walkthrough

The changes introduce a new GitHub Actions workflow for test coverage reporting and adjust existing workflows by altering triggers and dependencies. Specifically highlighted are updates for Solidity testing configurations and enhancements to the package.json scripts to improve coverage reporting and linting processes.

Changes

Files Change Summary
.github/workflows/coverage.yaml Introduces a workflow that sets up Node.js, runs tests with coverage, and uploads reports to Codecov.
.github/workflows/semantic-pr.yaml Removes the push trigger, retaining only the pull_request trigger.
.github/workflows/test.yaml Adds a new line under the run: yarn test command in the Test job.
.solcover.js Adds configuration for Solidity contract testing and compiling, including test and compile commands and provider options.
package.json Updates solidity-coverage version, adds new options to the coverage script, and modifies lint:fix to exclude coverage files.

Sequence Diagram(s)

Not applicable for these changes.

Poem

Amidst the code in the night so still,
Github workflows align with will.
Tests with coverage rise anew,
Solidity contracts compile true.
Linting whispers in the air,
Code is clean, beyond compare.
Oh code, you shine without despair!


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 Configration 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.

@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@lumtis lumtis marked this pull request as ready for review June 27, 2024 10:38
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 50254ed and 2d94577.

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
Files selected for processing (5)
  • .github/workflows/coverage.yaml (1 hunks)
  • .github/workflows/semantic-pr.yaml (1 hunks)
  • .github/workflows/test.yaml (1 hunks)
  • .solcover.js (1 hunks)
  • package.json (2 hunks)
Files skipped from review due to trivial changes (4)
  • .github/workflows/coverage.yaml
  • .github/workflows/semantic-pr.yaml
  • .github/workflows/test.yaml
  • .solcover.js
Additional comments not posted (2)
package.json (2)

52-52: Version update for solidity-coverage approved.

Ensure to verify compatibility with other dependencies and existing project setups.


76-76: Enhancement to coverage script looks good.

Ensure the new --temp option functions as expected by running the coverage script.

@lumtis lumtis merged commit 9d0791e into main Jun 27, 2024
11 of 13 checks passed
@lumtis lumtis deleted the ci/codecov branch June 27, 2024 10:50
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.

4 participants