From ada9dac0522436571cf4021c9af7cda2e27b9661 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 24 Jan 2024 15:24:57 +0000 Subject: [PATCH 1/4] Fixes #254. --- docs/pages/ci.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/pages/ci.md b/docs/pages/ci.md index a1dfd17b..bf4312aa 100644 --- a/docs/pages/ci.md +++ b/docs/pages/ci.md @@ -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. | 🟠 | +| [Coveralls](https://docs.coveralls.io/) | Hosted service to report code coverage metrics. Very similar to codecov we don't recommend one over the other. | 🟠 | From a5181894cc6e5a65b618127638101157493c2b63 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 25 Jan 2024 10:05:44 +0000 Subject: [PATCH 2/4] More details from thread in #288. --- docs/pages/ci.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/pages/ci.md b/docs/pages/ci.md index bf4312aa..c77c2a35 100644 --- a/docs/pages/ci.md +++ b/docs/pages/ci.md @@ -26,7 +26,7 @@ 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. | 🟠 | -| [Coveralls](https://docs.coveralls.io/) | Hosted service to report code coverage metrics. Very similar to codecov we don't recommend one over the other. | 🟠 | +| 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. ery 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). | 🟠 | From 7e5b4ce3380d78c073d269113e0bddd998b3a61d Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 6 Feb 2024 10:57:17 +0000 Subject: [PATCH 3/4] Both go green. Co-authored-by: David Stansby --- docs/pages/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/ci.md b/docs/pages/ci.md index c77c2a35..9e5eaae4 100644 --- a/docs/pages/ci.md +++ b/docs/pages/ci.md @@ -28,5 +28,5 @@ 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. ery 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). | 🟠 | +| [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). | 🟢 | From d30df5e515c6e933f986d614934837aa87a960b5 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Tue, 6 Feb 2024 11:04:10 +0000 Subject: [PATCH 4/4] Make prettier happy. --- docs/pages/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/ci.md b/docs/pages/ci.md index 9e5eaae4..9162a975 100644 --- a/docs/pages/ci.md +++ b/docs/pages/ci.md @@ -28,5 +28,5 @@ 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). | 🟢 | +| [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). | 🟢 |