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

Update Homebrew Java installation docs for OSX #14729

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kasittig
Copy link
Contributor

Change Description

When going through the documentation for installing Hail on OSX, I noticed that the syntax for installing Java via Homebrew was out of date.

This PR updates the documentation to use the latest syntax for Homebrew. It also updates the command to install version 11 of Temurin instead of version 8.

Security Assessment

  • This change has no security impact

Impact Description

This change updates documentation only and has no immediate end user impact.

This change updates the recommended version of Temurin to a newer version (11 vs. 8). It is reasonable to assume that the newer version is at least as secure as previous versions. So, there also should be no negative security impact on future users of this documentation.

@kasittig kasittig requested a review from a team October 15, 2024 20:54
@kasittig
Copy link
Contributor Author

@patrick-schultz - what version of Azul are we currently using in prod? I searched the repository and checked out all of the Dockerfiles but couldn't find the reference.

Copy link
Collaborator

@patrick-schultz patrick-schultz left a comment

Choose a reason for hiding this comment

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

Thanks for catching that! Java 8 should work too, but we should be consistent in recommending 11.

@@ -9,8 +9,7 @@ Install Hail on Mac OS X

.. code-block::

brew tap homebrew/cask-versions
brew install --cask temurin8
brew install zulu@11

You *must* pick a Java installation with a compatible architecture. If you have an Apple M1 or M2
Copy link
Member

Choose a reason for hiding this comment

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

Since you're here, M3+ is now a thing so this could be reworded to something mroe future-proof like

Suggested change
You *must* pick a Java installation with a compatible architecture. If you have an Apple M1 or M2
You *must* pick a Java installation with a compatible architecture.
If, for example, your processor uses M-series Apple silicon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants