ryansurf / cli-surf

Get surf and ocean data from the command line interface
MIT License
18 stars 30 forks source link

pytest coverage badge! #127

Closed ryansurf closed 3 months ago

ryansurf commented 3 months ago

General:

Code:

  1. [x] Does your submission pass tests?
  2. [x] Have you run the linter/formatter on your code locally before submission?
  3. [x] Have you updated the documentation/README to reflect your changes, as applicable?
  4. [x] Have you added an explanation of what your changes do?
  5. [x] Have you written new tests for your changes, as applicable?

Summary by Sourcery

Integrate Codecov into the CI workflow to track test coverage and update the README with a Codecov badge.

New Features:

Enhancements:

CI:

Documentation:

sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request integrates Codecov into the CI workflow to report test coverage and adds a Codecov badge to the README. The main changes involve modifying the GitHub Actions workflow file to include Codecov for test coverage reporting and updating the README to display the coverage status.

File-Level Changes

Files Changes
.github/workflows/pytest.yml Refactored the CI workflow to improve clarity and organization of steps
.github/workflows/pytest.yml Updated the test running step to use pytest with coverage reporting in XML format
.github/workflows/pytest.yml Added a step to upload test coverage results to Codecov
.github/workflows/pytest.yml Commented out the previous pytest coverage comment step
README.md Added a Codecov badge to display test coverage status

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
codecov[bot] commented 3 months ago

Welcome to Codecov :tada:

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.

:information_source: You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered :open_umbrella: