-
Notifications
You must be signed in to change notification settings - Fork 124
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.
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
Add CI check for warnings & errors when building docs #2287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tlylt
changed the title
Add CI checks to spot warnings when building docs
Add CI check to spot warnings when building docs
Apr 16, 2023
jovyntls
reviewed
Apr 16, 2023
Co-authored-by: Jovyn Tan <61113575+jovyntls@users.noreply.github.com>
tlylt
commented
Apr 16, 2023
tlylt
commented
Apr 16, 2023
tlylt
changed the title
Add CI check to spot warnings when building docs
Add CI check for warnings & errors when building docs
Apr 16, 2023
jovyntls
approved these changes
Apr 16, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks @tlylt, this is a useful feature & good idea that would have caught lots of our previous bugs :)
tlylt
commented
Apr 17, 2023
tlylt
commented
Apr 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
Related to #2140
Add a step to check if there are any warnings/errors when building our documentation (UG + DG), which is deployed at
markbind-master
. This helps to ensure that we are not accidentally pushing any broken links and any sort of other issues reflected in our documentation unexpectedly.So far our documentation does not contain any warning (and error) unless there's a problem. Hence, this CI check is made to fail when it detects a warning, effectively forcing the developer to investigate and eliminate the warning.
Anything you'd like to highlight/discuss:
nil
Testing instructions:
See the following screenshot when there is a warning (for details, check the past CI runs https://github.com/MarkBind/markbind/actions/runs/4711997883/jobs/8356766412).
Proposed commit message: (wrap lines at 72 characters)
Add CI check for warnings & errors when building docs
Checklist: ☑️