Skip to content

[SPARK-57938][DOCS] Print active SKIP_ flags when Ruby doc build script runs #58526

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

Open
nchammas wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −6
Open

[SPARK-57938][DOCS] Print active SKIP_ flags when Ruby doc build script runs #58526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 0 additions & 6 deletions .github/workflows/build_and_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,12 +1152,6 @@ jobs:
if [ `./dev/is-changed.py -m $pyspark_modules` = false ]; then export SKIP_PYTHONDOC=1; fi
if [ `./dev/is-changed.py -m sparkr` = false ]; then export SKIP_RDOC=1; fi
fi
# Print the values of environment variables `SKIP_ERRORDOC`, `SKIP_SCALADOC`, `SKIP_PYTHONDOC`, `SKIP_RDOC` and `SKIP_SQLDOC`
echo "SKIP_ERRORDOC: $SKIP_ERRORDOC"
echo "SKIP_SCALADOC: $SKIP_SCALADOC"
echo "SKIP_PYTHONDOC: $SKIP_PYTHONDOC"
echo "SKIP_RDOC: $SKIP_RDOC"
echo "SKIP_SQLDOC: $SKIP_SQLDOC"
cd docs
bundle exec jekyll build
- name: Tar documentation
Expand Down
12 changes: 12 additions & 0 deletions docs/_plugins/build_api_docs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ def print_header(text)
puts banner_bar
end

def print_skip_flags
print_header "Skip flags enabled"
skip_flags = ENV.select { |name, value| name.start_with?('SKIP_') && value == '1' }.sort
if skip_flags.empty?
puts "None"
else
skip_flags.each { |name, value| puts "#{name}" }
end
end

def build_spark_if_necessary
# If spark has already been compiled on the host, skip here.
if ENV['SPARK_DOCS_IS_BUILT_ON_HOST'] == '1'
Expand Down Expand Up @@ -356,6 +366,8 @@ def build_error_docs
|| raise("Error doc generation failed")
end

print_skip_flags

if not (ENV['SKIP_ERRORDOC'] == '1')
build_error_docs
end
Expand Down