Skip to content

Commit

Permalink
feat(img): add failing CI image(#87)
Browse files Browse the repository at this point in the history
* Update README.md

clarified governance to be governance handbook, and corrected the link to point to the new handbook URL (was pointing to /governance)

* adding ci images

* added in-line image for failing CI

* updated image formatting to include alt text and caption

* typo!

* removed unused image

* Delete maintainer-approve-workflow.png

* Create maintainer-approve-workflow.png

re-added file

* Delete maintainer-approve-workflow.png

should fix merge conflict
  • Loading branch information
kierisi authored Sep 16, 2024
1 parent 54e33b0 commit 79a6eb7
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions community/github/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ checks:
can be merged. The issues could be related to code style, formatting, tests,
or other criteria specified by the CI configuration.

```{figure} /images/ci-images/contributor-ci-fail.png
:alt: A screenshot of the GitHub CI notifications for a sample pyOpenSci repository. There are four rows of information. The first row reads "1 workflow awaiting approval. This workflow requires approval from a maintainer. Learn more about approving workflows. 1 failing and 1 successful checks. To the far right of the row is linked text reading Hide all checks. The text Learn more about approving workflows is linked. The second row has a red x on the left, followed by the letter P in a gold square, and the text pre-commit.ci - pr -- checks completed with failures. To the far right is linked text reading Details. On the third row there is a green check mark followed by the Circle CI logo and the text ci/circleci: build_book -- Your tests passed on CircleCI! And to the far right there is linked text reading Details. The fourth and final row has a small white checkmark inside a large green circle with text reading This branch has no conflicts with the base branch. Only those with write access to this repository can merge pull requests. The text write access is linked.
When a CI check fails, you'll see a red 'X' next to the CI check that hasn't passed
```
#### If a CI check is red

1. **Click on "Details"** next to the failed check to get more information
Expand Down

0 comments on commit 79a6eb7

Please sign in to comment.