Integration of Code Coverage Checks with Codecov

[benyissa]

Changes Made

• Integrated code coverage checks into the workflow using Codecov.

---

Added Value

This enhancement introduces several benefits to the project:

1. Automated Code Coverage Reporting:

   • A bot will automatically provide a code coverage percentage for each new PR.
   • Example:
     

2. Detailed Annotations:

   • New annotations on PRs to highlight coverage details.
   • Example:
     

3. Additional Checks:

   • Two extra checks will be added to each new PR:
     • Project Check: Ensures the overall codebase coverage percentage is maintained by comparing with the main branch.
     • Patch Check: Assesses the coverage of the current changes in the PR.
   • Example:
     

---

Handling Failed Codecov Checks

• Optional Merges: Codecov checks are optional for merging a PR. This is because sometimes the Codecov API can fail, and we don't want to block the entire workflow. In such cases, we can rely on the local pytest coverage from the author.
• Improving Coverage: If the checks are present and Codecov is working fine, we should aim to increase coverage by reviewing and addressing missing lines, either through the Codecov dashboard or the review tab in GitHub.

Action Steps for Missing Checks

• If Codecov checks do not appear after the pytest workflow finishes:
  • Review the Codecov step logs.
  • If any 5xx errors are noticed, manually rerun the checks.

---

Additional Information

For more details, visit the Codecov Website.

[codecov]

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 ☂️