This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new eb111901608 [MINOR][INFRA] Ensure that docs build successfully with
SKIP_API=1
eb111901608 is described below
commit eb111901608884111195f3abc5b802f44ed9e53e
Author: Nicholas Chammas <nicholas.cham...@gmail.com>
AuthorDate: Wed Jan 10 09:48:39 2024 +0900
[MINOR][INFRA] Ensure that docs build successfully with SKIP_API=1
### What changes were proposed in this pull request?
This PR tweaks the docs build so that the general docs are first built with
`SKIP_API=1` to ensure that the docs build works without any language being
built beforehand.
### Why are the changes needed?
[Committers expect][1] docs to build with `SKIP_API=1` on a fresh checkout.
Yet, our CI build does not ensure this. This PR corrects this gap.
[1]: https://github.com/apache/spark/pull/44393/files#r1444169083
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Via test commits against this PR.
[The build now fails][f] if the docs reference an include that has not been
generated yet.
[f]:
https://github.com/nchammas/spark/actions/runs/7450949388/job/20271048581#step:30:29
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #44627 from nchammas/skip-api-docs-build.
Authored-by: Nicholas Chammas <nicholas.cham...@gmail.com>
Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
.github/workflows/build_and_test.yml | 3 +++
1 file changed, 3 insertions(+)
diff --git a/.github/workflows/build_and_test.yml
b/.github/workflows/build_and_test.yml
index a93a70e8616..012e7c8fe9e 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -761,6 +761,9 @@ jobs:
run: ./dev/lint-r
- name: Run documentation build
run: |
+ # Build docs first with SKIP_API to ensure they are buildable without
requiring any
+ # language docs to be built beforehand.
+ cd docs; SKIP_API=1 bundle exec jekyll build; cd ..
if [ -f "./dev/is-changed.py" ]; then
# Skip PySpark and SparkR docs while keeping Scala/Java/SQL docs
pyspark_modules=`cd dev && python3.9 -c "import
sparktestsupport.modules as m; print(','.join(m.name for m in m.all_modules if
m.name.startswith('pyspark')))"`
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
