Skip to content

Commit

Permalink
Per #675, added images of screenshots from GHA
Browse files Browse the repository at this point in the history
  • Loading branch information
georgemccabe committed Jan 19, 2022
1 parent e77644d commit 41bd571
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/Contributors_Guide/continuous_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,17 @@ The Makefile that runs sphinx-build was modified to write warnings and errors
to a file called warnings.log using the -w argument. This file will be empty
if no errors or warnings have occurred in the building of the documentation.
If it is not empty, the script called by this workflow will exit with a
non-zero value so that the workflow reports a failure. A summary of the lines
that contain WARNING or ERROR are output in the GitHub Actions log for easy
access. The warnings.log file is also made available as a GitHub Actions
artifact so it can be downloaded and reviewed.
non-zero value so that the workflow reports a failure.

.. figure:: figure/ci-doc-error.png

A summary of the lines that contain WARNING or ERROR are output in the
GitHub Actions log for easy access.
The warnings.log file is also made available as a GitHub Actions
artifact so it can be downloaded and reviewed. Artifacts can be found
at the bottom of the workflow summary page when the workflow has completed.

.. figure:: figure/ci-doc-artifacts.png


Release Published (release_published.yml)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Contributors_Guide/figure/ci-doc-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41bd571

Please sign in to comment.