From f9a911e49be3b7150e9c0f6bd56a234e4eedf6d1 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 25 Mar 2024 17:22:41 +0000 Subject: [PATCH] Minor improvements to CI page --- docs/pages/ci.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/pages/ci.md b/docs/pages/ci.md index 8aee5f37..f4420af5 100644 --- a/docs/pages/ci.md +++ b/docs/pages/ci.md @@ -1,5 +1,5 @@ --- -title: CI +title: Continuous integration layout: default --- @@ -15,19 +15,21 @@ layout: default
🟢 explanation -We have many projects using github CI, it's both convenient and works well. It's become the standard. Also, note that it's free for public repos. +We have many projects using GitHub CI and, it has good integration with GitHub itself, and is free for public repositories (with limited free monthly minutes for private repositories).
# Coverage monitoring -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. +These services report and track test code coverage over time. +They render the code with highlighting to show which lines are not executed by tests. +See [testing](testing.md) for our recommendations on packages to generate code coverage during tests. | 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). | 🟢 | + +
+ 🟢 explanation +Both services are similar, so both 🟢. +