You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "nchammas (via GitHub)" <gi...@apache.org> on 2024/01/08 18:56:58 UTC
[PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
nchammas opened a new pull request, #44628:
URL: https://github.com/apache/spark/pull/44628
### What changes were proposed in this pull request?
1. Bump jekyll to 4.3.3.
2. Loosen the dependency spec for jekyll to make updates easier.
3. Don't mention Ruby 1 or 2 in the docs.
4. Don't use `sudo` with `gem` in the docs.
### Why are the changes needed?
1. Jekyll 4.3.2 is [broken on Ruby 3.3.0][1]. Jekyll 4.3.3 [fixes the issue][2].
2. There is no need to pin Jekyll in the Gemfile since it gets pinned automatically for us in the lock file. This makes updating dependencies via `bundle update` easier.
3. Both Ruby 1 and 2 are [EOL][eol]. We should not use or reference them in the docs.
4. Installing stuff as the superuser is explicitly discouraged by both pip and gem. Pip issues this warning:
> WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv
And bundler issues this warning:
> Don't run Bundler as root. Installing your bundle as root will break this application for all non-root users on this machine.
We should not encourage this pattern in our docs.
[1]: https://github.com/jekyll/jekyll/pull/9510
[2]: https://github.com/jekyll/jekyll/releases/tag/v4.3.3
[eol]: https://www.ruby-lang.org/en/news/2022/04/12/ruby-2-7-6-released/
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Building the docs against Ruby 3.2.2 and 3.3.0.
### Was this patch authored or co-authored using generative AI tooling?
No.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44628: [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0
URL: https://github.com/apache/spark/pull/44628
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on code in PR #44628:
URL: https://github.com/apache/spark/pull/44628#discussion_r1445151689
##########
docs/Gemfile:
##########
@@ -17,8 +17,12 @@
source "https://rubygems.org"
+# Keep these specifications as flexible as possible and leave it to Bundler
+# to pin versions in the lock file.
+# To update the lock file, run `bundle update`.
+# Version constraint reference: https://guides.rubygems.org/patterns/#declaring-dependencies
gem "ffi", "1.15.5"
-gem "jekyll", "4.3.2"
+gem "jekyll", "~> 4.3"
Review Comment:
I would like to migrate all of the dependency specifications here to use the [pessimistic operator][1], but I leave that to a future PR.
[1]: https://thoughtbot.com/blog/rubys-pessimistic-operator
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on PR #44628:
URL: https://github.com/apache/spark/pull/44628#issuecomment-1881820880
The build appears to be passing. Here is the [build of the docs][1] for this PR.
[1]: https://github.com/nchammas/spark/actions/runs/7451914898/job/20275530350#step:30:9088
Is there some other test you'd like me to run or scenario to check out? Happy to do it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on PR #44628:
URL: https://github.com/apache/spark/pull/44628#issuecomment-1881658530
cc @srowen since you reviewed #42669.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46626][DOCS] Bump jekyll to 4.3.3 to enable support for Ruby 3.3.0 [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44628:
URL: https://github.com/apache/spark/pull/44628#issuecomment-1882023269
Merged to master.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org