Skip to content

Commit 6eddb72

Browse files
authoredJul 2, 2024··
docs: included commands and links for mac setup (#2327)
1 parent 10581bf commit 6eddb72

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed
 

‎documentation/developer-setup.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22

33
## Machine Setup (Mac)
44

5-
- [ ] Docker for Mac
6-
- [ ] XCode or command-line tools for Xcode or however Mac OS does this in the future (installs git too)
7-
- [ ] Git setup - prob SSL key/cert, username, etc.
8-
- [ ] NVM
9-
- [ ] Node through NVM
10-
- [ ] Text Editor / IDE
5+
- [ ] [Docker for Mac](https://docs.docker.com/desktop/install/mac-install/)
6+
- [ ] [Homebrew](https://brew.sh/) (`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)`)
7+
- [ ] XCode (`xcode-select --install`) or command-line tools for XCode or however Mac OS does this in the future
8+
- [ ] Git setup: `brew install git`, then SSL key/certificate, username, etc. ([SSH help](https://docs.github.com/en/enterprise/2.15/user/articles/adding-a-new-ssh-key-to-your-github-account))
9+
- [ ] NVM (`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash`, check [here](https://github.com/nvm-sh/nvm) for latest version)
10+
- [ ] [Node though NVM](https://nodejs.org/en/download/package-manager) (`nvm install 20`, or latest version instead of 20)
1111
- [ ] `brew install postgresql` (c library required for pg-native tests)
12-
- [ ] Swap OpenSSL (if necessary)
12+
- [ ] Text Editor / IDE
13+
- [ ] Swap OpenSSL (if necessary, see below)
1314

1415
### Swapping OpenSSL for LibreSSL
1516

1617
LibreSSL doesn’t seem to work w/ our make/tests that rely on OpenSSL functionality.
1718

1819
To fix:
1920

20-
1. Install openssl via homebrew (brew install)
21-
2. Execute brew info openssl
21+
1. Install openssl via homebrew (`brew install openssl`)
22+
2. Execute `brew info openssl`
2223
3. Copy/Paste instructions for "If you need to have this software first in your PATH run:..." section.
2324

2425
## How We Work
@@ -51,12 +52,12 @@ a set of "versioned" integration style tests. See the [package.json](../package.
5152
for the full set of scripts, but a short list of common scenarios is:
5253

5354
+ `npm run versioned:internal` - to run all versioned tests across all supported
54-
versions of each instrumented module.
55+
versions of each instrumented module.
5556
+ `npm run versioned:internal:major` - to run all versioned tests for each
56-
current major release of each instrumented module.
57+
current major release of each instrumented module.
5758
+ `npm run versioned:internal:major foo` - to run a specific versioned test
58-
for the latest major version of the instrumented module named "foo" (as an
59-
example).
59+
for the latest major version of the instrumented module named "foo" (as an
60+
example).
6061

6162
Note: when running the versioned test suite on a macOS system, the application
6263
firewall is likely to issue multiple requests to authorize the `node` binary

0 commit comments

Comments
 (0)
Please sign in to comment.