Skip to content
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
merged 10 commits into from
Apr 17, 2023

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Apr 16, 2023

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

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).

  • When there's no warning, the check will pass
  • When there's a warning:
    image
    image
  • The developer can then check the step before to see the details
    image

Proposed commit message: (wrap lines at 72 characters)
Add CI check for warnings & errors when building docs


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt marked this pull request as ready for review April 16, 2023 07:17
@tlylt 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
.github/workflows/ci.yml Outdated Show resolved Hide resolved
Co-authored-by: Jovyn Tan <61113575+jovyntls@users.noreply.github.com>
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
@tlylt tlylt marked this pull request as draft April 16, 2023 14:27
.github/workflows/ci.yml Outdated Show resolved Hide resolved
@tlylt 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
@tlylt tlylt marked this pull request as ready for review April 16, 2023 14:39
Copy link
Contributor

@jovyntls jovyntls left a 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 :)

.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
@tlylt tlylt merged commit 176861c into MarkBind:master Apr 17, 2023
@tlylt tlylt added this to the v4.1.1 milestone Apr 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants