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

[SPARK-46658][DOCS] Loosen Ruby dependency specification #44667

Closed
wants to merge 4 commits into from

Conversation

nchammas
Copy link
Contributor

What changes were proposed in this pull request?

As promised here, this change loosens our Ruby dependency specification so that Bundler can update transitive dependencies more easily.

Other changes included:

  • Remove the direct dependency on webrick, because Jekyll fixed the problem that caused us to add it in the first place.
  • Add explanatory comments to parts of the document generation process that are not obvious.

We can still build our docs using Ruby 2.7, but we should push devs to install Ruby 3 since Ruby 2 is EOL and we are unable to upgrade some of our doc dependencies until we're running Ruby 3.

Why are the changes needed?

Make the document building process more robust to future updates coming from the Ruby ecosystem.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

I built and reviewed the docs on both Ruby 2.7.8 and Ruby 3.3.0 using the following command:

SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 bundle exec jekyll build

Was this patch authored or co-authored using generative AI tooling?

No.

@github-actions github-actions bot added the DOCS label Jan 10, 2024
@nchammas
Copy link
Contributor Author

cc @HyukjinKwon @srowen - We should update the build images to include Ruby 3.

$APT_INSTALL ruby2.7 ruby2.7-dev && \
gem install --no-document $GEM_PKGS

ruby \
ruby-dev \

I would do this myself, but non-committers cannot really test changes to these images fully.

@HyukjinKwon
Copy link
Member

Merged to master.

@nchammas nchammas deleted the SPARK-46658-ruby-deps branch January 11, 2024 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants