Skip to content

[MINOR][INFRA] Ensure that docs build successfully with SKIP_API=1 #44627

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.

Sign up for GitHub

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

Closed
nchammas wants to merge 7 commits into from
Closed

[MINOR][INFRA] Ensure that docs build successfully with SKIP_API=1 #44627

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
99fb443
build docs first with SKIP_API
nchammas Jan 8, 2024
1fa62c5
try to get docs build to fail
nchammas Jan 8, 2024
bd2e46e
Trigger Build
nchammas Jan 8, 2024
4b87d5a
make sure we are in docs dir
nchammas Jan 8, 2024
8042abc
the containers don't have pushd and popd
nchammas Jan 8, 2024
93b6f21
unbreak docs build
nchammas Jan 8, 2024
f3ff166
Merge branch 'master' into skip-api-docs-build
nchammas Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build_and_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ..
Copy link
Member

@HyukjinKwon HyukjinKwon Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but just to confirm this doesn't take a lot of time right?

Copy link
Contributor Author

@nchammas nchammas Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. This adds around 5 seconds to the "Run documentation build" step.

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')))"`
Copy link
Member

@HyukjinKwon HyukjinKwon Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or wonder if we should set SKIP_SCALADOC=1 together with if [ ./dev/is-changed.py -m ...` condition. That might be better.

Copy link
Contributor Author

@nchammas nchammas Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, could you elaborate a little bit on this? How would this prevent yesterday's scenario?

Copy link
Member

@HyukjinKwon HyukjinKwon Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually let's just merge this. 5 secs won't affect the elapsed time much anyway.

Expand Down