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.

Sign up for GitHub

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

Coveralls promoted to green, expand on what coverage reporting *is*. #288

Merged
merged 4 commits into from
Feb 6, 2024
+11 −4
Merged

Coveralls promoted to green, expand on what coverage reporting *is*. #288

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ada9dac
Fixes #254.
samcunliffe Jan 24, 2024
a518189
More details from thread in #288.
samcunliffe Jan 25, 2024
7e5b4ce
Both go green.
samcunliffe Feb 6, 2024
d30df5e
Make prettier happy.
samcunliffe Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docs/pages/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ We have many projects using github CI, it's both convenient and works well. It's

# Coverage monitoring

| Name | Short description | 🚦 |
| ---------------------------------------- | ----------------------------------------------- | :-: |
| [Codecov](https://docs.codecov.com/docs) | Hosted service to report code coverage metrics. | 🟢 |
| [Coveralls](https://docs.coveralls.io/) | Hosted service to report code coverage metrics. | 🟠 |
You can check coverage simply in the terminal with the
[pytest-cov](https://pypi.org/project/pytest-cov/) plugin. However you might
consider a third-party code coverage analytics and reporting service. There are
two that we've used and they're both rather similar. They render the code with
highlighting to show which lines are not executed but the tests, and can track
test coverage over time.

| Name | Short description | 🚦 |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: |
| [Codecov](https://docs.codecov.com/docs) | Hosted service to report code coverage metrics. Occasionally slow to update after a report is updated, can be configured to add extra CI checks. This service is probably more widely used and is [free for both open-source and private projects](https://about.codecov.io/pricing/). | 🟢 |
| [Coveralls](https://docs.coveralls.io/) | Hosted service to report code coverage metrics. Very similar to codecov and we don't strongly recommend one over the other. This service is only [free for open-source projects](https://coveralls.io/pricing). | 🟢 |