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.

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

Minor improvements to CI page #335

Merged
merged 3 commits into from
Mar 25, 2024
Merged

Minor improvements to CI page #335

merged 3 commits into from
Mar 25, 2024

Conversation

dstansby
Copy link
Member

  • Don't put an acronym in table of contents
  • Note that GH Actions also available for private repos for free
  • Link to testing page for test coverage collection recommendation
  • Add a details box explaining why there are two 🟢 coverage hosting tools

@samcunliffe samcunliffe enabled auto-merge (squash) March 25, 2024 17:26
@@ -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

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

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

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

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

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

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

@samcunliffe samcunliffe merged commit 30148ad into main Mar 25, 2024
15 checks passed
@samcunliffe samcunliffe deleted the ci branch March 25, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants