Skip to content

tutorial on CI logs #245

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Draft

tutorial on CI logs #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 20 additions & 0 deletions content/how-tos/ci-logs.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "How do I access CI logs?"
---

{{< admonition warning >}}
This is a draft document.
{{< /admonition >}}

Most packages use _continuous integration_ (CIs) to ensure that new code contributions don't break existing functionality.
CIs do things like run code style checks, run unit tests on different operating systems or different dependency versions, and build documentation websites.
Frequently, when you contribute bugfixes, new features, or documentation changes to a packages, one or more of the CIs will fail.
Below, we show how to figure out _why_ they failed, and what to do to fix them.

<!-- TODO screenshots of CIs with the doc build broken (CircleCI) -->

<!-- TODO screenshots of CIs with the doc build broken (readthedocs) -->

<!-- TODO screenshots of CIs with a GitHub actions unit test broken -->

<!-- TODO screenshots of CIs with an azure-pipelines unit test broken -->