Skip to content

Commit f5c357c

Browse files
committed
ci: doc-build: add new check time-incremental-build
The ability to make a one-line .rst change and quickly regenerate the docs has been broken at least three times in the past: #13159, #36033 and #57624. Add a small, final check to make sure this can't happen again. Signed-off-by: Marc Herbert <[email protected]>
1 parent 91ffb72 commit f5c357c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

.github/workflows/doc-build.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,18 @@ jobs:
114114
name: pr_num
115115
path: pr_num
116116

117+
# Keep this last not to break upload and other "functional" tests above.
118+
- name: time-incremental-build
119+
if: github.event_name == 'pull_request'
120+
run: |
121+
# Catch major incremental build time regressions like the ones
122+
# fixed by commits 52842317505f, a140a249b33b and 9d119431945f.
123+
sed -i -e 's/Zephyr /Xephyr /' doc/index.rst # make a small .rst change
124+
export DOC_TAG=development SPHINXOPTS='-j auto -t publish' # as above
125+
time timeout 35 make -C doc/ html-fast # ${DOC_TARGET} as above
126+
git checkout HEAD -- doc/index.rst # restore to be safe
127+
128+
117129
doc-build-pdf:
118130
name: "Documentation Build (PDF)"
119131
if: github.event_name != 'pull_request'

0 commit comments

Comments
 (0)