Enable code coverage via codecov.io #76
Conversation
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. ℹ️ 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 ☂️ |
There was a problem hiding this comment.
Excelent idea @cgohlke. I thought about something like this a while back I don't know if I mentioned it or not. It's a good idea to have a report on coverage since what I've been doing is see the reports from pytest but this is much better.
If I saw correctly, you set the coverage to be at least 99% right? I know you modified the contributing documentation but maybe add explicitly the percentage coverage we aim to be clearer, anyway that will be also in the report so not much trouble with that.
If I understood that 0.1% setting correctly, no new coverage report will be shown if the coverage changes are less than 0.1%. I did not set any code coverage threshold below which CI fails. There are cases which are/can not be tested, such as type annotation lines or large files, or exceptions for corrupted files. The coverage report is purely informational at the moment. |
|
You are right! I totally misunderstood the threshold parameter. Maybe we can discuss in the next meeting if it is needed or a good idea to add a minimun coverage to pass the tests, I think it is a good check, just in case we or other contributor overlook some case that is not tested. |
Description
This PR enables code coverage reports via Codecov for all pull requests and pushes to the main branch.
Code coverage reports were previously generated automatically during pytest runs, but I don't think they got much attention.
Release note
Summarize the changes in the code block below to be included in the
release notes:
Checklist