Skip to content

Minor improvements to CI page #335

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

Merged
samcunliffe merged 3 commits into from
Mar 25, 2024
Merged

Minor improvements to CI page #335

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9a911e
Minor improvements to CI page
dstansby Mar 25, 2024
bf7d51b
Fix internal link
dstansby Mar 25, 2024
691067e
Add CI acronym to title
dstansby Mar 25, 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
20 changes: 11 additions & 9 deletions docs/pages/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: CI
title: Continuous integration
layout: default
---

# Continuous integration
# Continuous integration (CI)

| Name | Short description | 🚦 |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | :-: |
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).
Copy link
Member

@paddyroddy paddyroddy Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seeing as this is the first time we are using CI, should we define it?

Suggested change
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).
We have many projects using GitHub continuous integration (CI) and, it has good integration with GitHub itself, and is free for public repositories (with limited free monthly minutes for private repositories).

Copy link
Member

@paddyroddy paddyroddy Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice if this page could be wrapped to 80 chars, in keeping with other pages

Copy link
Member Author

@dstansby dstansby Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if we want to enforce wrap to 80 it would be best to do via a pre-commit hook instead of having to manually edit?

Copy link
Member Author

@dstansby dstansby Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching the acronym - I edited the title of this section instead since CI is such a common acronym.

Copy link
Member

@paddyroddy paddyroddy Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, it's slightly tricky though as links can go over - and tables. I like markdownlint.

Copy link
Member Author

@dstansby dstansby Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For wrapping I opened a new issue at #337

</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) 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>