Add CI check for documentation deploy errors #2378
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request?
Overview of changes:
Fixes #2335
Anything you'd like to highlight/discuss:
Did no include a check for deployment warnings because it will also capture false positives (when building UG and DG separately there are unavoidable warnings for broken links)
Testing instructions:
I tested the bash script locally, by
cd docs
markbind serve -d
to serve the documentation site and also let it generate a log file indocs/_markbind/logs
test.sh
bash test.sh
, should observe nothing in the command line.... - info
to.... - error
bash test.sh
, should observe something like:Proposed commit message: (wrap lines at 72 characters)
Add CI check for documentation deploy errors
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major
,r.Minor
,r.Patch
.Breaking change release note preparation (if applicable):