Update Mac OS Quickstart #1964
Merged
Update Mac OS Quickstart #1964
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I tested the `brew` instructions on a fresh laptop that does not use Apple Silicon, but does use zsh. Docker 4.3.0 was chosen since that's the first version to support Apple Silicon.
Java and Docker dependencies are each now their own "part", and the two ways to install openJDK 17 have subheadings -- the combination of these two changes makes the Mac OS Java installation parts much less confusing. Additional zsh notice made on adding dockstore CLI to the path. Tell people their version of openJDK will vary. Give a few use cases for the Dockstore CLI after installing the required bits, and clarify WDL doesn't require any additional downloads. Remove some unnecessary numbering.
11 tasks
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1964 +/- ##
========================================
Coverage 40.32% 40.32%
========================================
Files 400 400
Lines 11957 11957
Branches 2894 2894
========================================
Hits 4822 4822
Misses 4846 4846
Partials 2289 2289 ☔ View full report in Codecov by Sentry. |
|
If this is approved by all, please merge while I'm out. |
|
(adding a few more mac users) |
denis-yuen
approved these changes
Apr 17, 2024
svonworl
approved these changes
Apr 18, 2024
kathy-t
approved these changes
Apr 18, 2024
david4096
approved these changes
Apr 19, 2024
|
coverbeck
pushed a commit
that referenced
this pull request
Jul 19, 2024
See PR comments. (cherry picked from commit 98d079a)
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There are lots of ways to install Java on a Mac, so be less prescriptive than we have been. The other changes are from PR #1843, which I left unchanged, and were approved in that PR. The Mac Java install changes are based from my comments on that PR.
Before
After
Review Instructions
Go to quick start, from the My Dockstore page, and verify the Mac OS instructions look good.
Issue
SEAB-6372
Security
If there are any concerns that require extra attention from the security team, highlight them here.
Please make sure that you've checked the following before submitting your pull request. Thanks!
npm run buildmarkdown-wrappercomponent, which does extra sanitizationnpm auditand ensure you are not introducing new vulnerabilities