Starting with a draft PR to test out the documentation build step.
Expected Differences
[x] Do these changes modify the system output in any way? [No]
If yes, please describe:
Pull Request Testing
[x] Describe testing already performed for these changes:
This GHA run was triggered by this PR and it passed.
This GHA run demonstrates that a warning (intentionally added) does result in a failure:
/home/runner/work/wrfcloud/wrfcloud/docs/index.rst:8: WARNING: image file not readable: _static/wrfcloud_banner_photo_web.BADPATH.jpeg
...
Error: Process completed with exit code 1.
[x] Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
Confirm that you see red X for this GHA run but a green checkmark for that most recent GHA run.
[x] Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [No]
Made no actual docs updates. We do not document our CI process anywhere, at least not yet.
[x] Do these changes include sufficient testing updates? [Yes]
That's what this is!
[x] Will this PR result in changes to the test suite? [No]
If yes, describe the new output and/or changes to the existing output:
[ ] Please complete this pull request review by [???].
Pull Request Checklist
[x] Review the source issue metadata (labels, project, and milestone).
[x] Complete the PR definition above.
[x] Ensure the PR title matches the feature or bugfix branch name.
[x] Define the PR metadata, as permissions allow.
Select: Reviewer(s)
Select: Project
Select: Milestone as the version that will include these changes
Select: Development to link to the original development issue.
[ ] After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
[ ] Close the linked issue and delete your feature or bugfix branch from GitHub.
@fossell I'd like to proceed with this small change of checking for doc build warnings via GHA. I worked on the AWS codebuild part today but am stuck with permissions right now.
Starting with a draft PR to test out the documentation build step.
Expected Differences
Pull Request Testing
[x] Describe testing already performed for these changes:
[x] Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions: Confirm that you see red X for this GHA run but a green checkmark for that most recent GHA run.
[x] Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [No] Made no actual docs updates. We do not document our CI process anywhere, at least not yet.
[x] Do these changes include sufficient testing updates? [Yes] That's what this is!
[x] Will this PR result in changes to the test suite? [No] If yes, describe the new output and/or changes to the existing output:
[ ] Please complete this pull request review by [???].
Pull Request Checklist