Skip to content

Commit

Permalink
Minor improvements to CI page
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby committed Mar 25, 2024
1 parent 01dd7b2 commit f9a911e
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/pages/ci.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CI
title: Continuous integration
layout: default
---

Expand All @@ -15,19 +15,21 @@ layout: default

<details>
<summary> 🟢 explanation</summary>
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).
</details>

# 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). | 🟢 |

<details>
<summary> 🟢 explanation</summary>
Both services are similar, so both 🟢.
</details>

0 comments on commit f9a911e

Please sign in to comment.