Skip to content

Commit fe5b82b

Browse files
dannywillemsdannywillems
committed
docs: add macOS instructions to developer getting-started guide
Add comprehensive macOS support to the developer documentation by: - Creating platform-specific setup scripts for macOS using Homebrew - Splitting installation instructions using tabbed interface for Linux and macOS - Adding macOS CI testing jobs to verify setup scripts work correctly - Renaming CI jobs for clarity (ubuntu, macos, docker-ubuntu, docker-macos) This enables macOS developers to easily set up their development environment with proper platform-specific installation commands.
1 parent 727c1a0 commit fe5b82b

File tree

5 files changed

+158
-5
lines changed

5 files changed

+158
-5
lines changed

‎.github/workflows/test-docs-scripts.yml‎

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Test Documentation Scripts
1+
name: Documentation Scripts
22

33
# This workflow tests the documentation setup scripts to ensure they work correctly.
44
# It runs nightly and on-demand to avoid slowing down regular development workflow,
@@ -14,7 +14,7 @@ on:
1414
# Allow manual triggering for testing
1515

1616
jobs:
17-
test-system-setup:
17+
ubuntu:
1818
name: Test System Setup Scripts (${{ matrix.os }})
1919
runs-on: ${{ matrix.os }}
2020
# Only run if the event is scheduled, manual, or PR has test-doc-scripts label
@@ -76,7 +76,69 @@ jobs:
7676
sqlite3 --version
7777
wasm-pack --version
7878
79-
test-docker-setup:
79+
macos:
80+
name: Test System Setup Scripts (${{ matrix.os }})
81+
runs-on: ${{ matrix.os }}
82+
# Only run if the event is scheduled, manual, or PR has test-doc-scripts label
83+
# This prevents long-running tests from blocking regular development workflow
84+
if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'test-doc-scripts')
85+
strategy:
86+
matrix:
87+
os: [macos-latest]
88+
89+
steps:
90+
- name: Checkout repository
91+
uses: actions/checkout@v4
92+
93+
- name: Test system dependencies installation
94+
run: |
95+
./website/docs/developers/scripts/setup/install-system-deps-macos.sh
96+
97+
- name: Test Node.js installation
98+
run: |
99+
./website/docs/developers/scripts/setup/install-nodejs-macos.sh
100+
101+
- name: Test Rust installation
102+
run: |
103+
./website/docs/developers/scripts/setup/install-rust.sh
104+
105+
- name: Test WASM tools installation
106+
run: |
107+
# Source cargo environment first
108+
source ~/.cargo/env
109+
./website/docs/developers/scripts/setup/install-wasm-tools.sh
110+
111+
- name: Test specialised builds
112+
run: |
113+
# Source cargo environment first
114+
source ~/.cargo/env
115+
./website/docs/developers/scripts/setup/build-specialized.sh
116+
117+
- name: Test format and lint
118+
run: |
119+
# Source cargo environment first
120+
source ~/.cargo/env
121+
./website/docs/developers/scripts/setup/format-and-lint.sh
122+
123+
- name: Test run tests
124+
run: |
125+
# Source cargo environment first
126+
source ~/.cargo/env
127+
./website/docs/developers/scripts/setup/run-tests.sh
128+
129+
- name: Verify installations
130+
run: |
131+
echo "Verifying installed tools..."
132+
source ~/.cargo/env
133+
rustc --version
134+
cargo --version
135+
node --version
136+
npm --version
137+
protoc --version
138+
sqlite3 --version
139+
wasm-pack --version
140+
141+
docker-ubuntu:
80142
name: Test Docker Setup Script (${{ matrix.os }})
81143
runs-on: ${{ matrix.os }}
82144
# Only run if the event is scheduled, manual, or PR has test-doc-scripts label
@@ -98,3 +160,27 @@ jobs:
98160
run: |
99161
sudo docker --version
100162
sudo docker run hello-world
163+
164+
docker-macos:
165+
name: Test Docker Setup Script (${{ matrix.os }})
166+
runs-on: ${{ matrix.os }}
167+
# Only run if the event is scheduled, manual, or PR has test-doc-scripts label
168+
# This prevents long-running tests from blocking regular development workflow
169+
if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'test-doc-scripts')
170+
strategy:
171+
matrix:
172+
os: [macos-latest]
173+
174+
steps:
175+
- name: Checkout repository
176+
uses: actions/checkout@v4
177+
178+
- name: Test Docker installation
179+
run: |
180+
./website/docs/developers/scripts/setup/install-docker-macos.sh
181+
182+
- name: Verify Docker installation
183+
run: |
184+
# Docker Desktop needs to be started manually on macOS
185+
# We'll just check if it was installed via Homebrew
186+
docker --version || echo "Docker installed but not running (expected on macOS CI)"

‎website/docs/developers/getting-started.mdx‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,15 @@ sidebar_position: 1
55
# Getting Started for Developers
66

77
import CodeBlock from "@theme/CodeBlock";
8+
import Tabs from "@theme/Tabs";
9+
import TabItem from "@theme/TabItem";
810
import InstallRustSh from "!!raw-loader!./scripts/setup/install-rust.sh";
911
import InstallSystemDepsSh from "!!raw-loader!./scripts/setup/install-system-deps.sh";
12+
import InstallSystemDepsMacOSSh from "!!raw-loader!./scripts/setup/install-system-deps-macos.sh";
1013
import InstallNodejsSh from "!!raw-loader!./scripts/setup/install-nodejs.sh";
14+
import InstallNodejsMacOSSh from "!!raw-loader!./scripts/setup/install-nodejs-macos.sh";
1115
import InstallDockerSh from "!!raw-loader!./scripts/setup/install-docker.sh";
16+
import InstallDockerMacOSSh from "!!raw-loader!./scripts/setup/install-docker-macos.sh";
1217
import InstallWasmToolsSh from "!!raw-loader!./scripts/setup/install-wasm-tools.sh";
1318
import CloneAndBuildSh from "!!raw-loader!./scripts/setup/clone-and-build.sh";
1419
import BuildSpecializedSh from "!!raw-loader!./scripts/setup/build-specialized.sh";
@@ -22,8 +27,10 @@ development environment and build OpenMina from source.
2227

2328
### System Requirements
2429

25-
- **Operating System**: Ubuntu 20.04+ or Debian 11+ (other Linux distributions
26-
may work but are not officially supported)
30+
- **Operating System**:
31+
- **Linux**: Ubuntu 20.04+ or Debian 11+ (other Linux distributions may work
32+
but are not officially supported)
33+
- **macOS**: macOS 12.0+ (Monterey or later)
2734
- **Memory**: At least 8GB RAM (16GB recommended)
2835
- **Storage**: At least 20GB free space
2936
- **Network**: Stable internet connection for downloading dependencies
@@ -38,18 +45,51 @@ OpenMina requires both stable and nightly Rust toolchains:
3845

3946
#### 2. System Dependencies
4047

48+
<Tabs groupId="operating-systems">
49+
<TabItem value="linux" label="Linux (Ubuntu/Debian)">
50+
4151
<CodeBlock language="bash">{InstallSystemDepsSh}</CodeBlock>
4252

53+
</TabItem>
54+
<TabItem value="macos" label="macOS">
55+
56+
<CodeBlock language="bash">{InstallSystemDepsMacOSSh}</CodeBlock>
57+
58+
</TabItem>
59+
</Tabs>
60+
4361
#### 3. Additional Development Tools
4462

4563
**Node.js (for documentation and frontend):**
4664

65+
<Tabs groupId="operating-systems">
66+
<TabItem value="linux" label="Linux (Ubuntu/Debian)">
67+
4768
<CodeBlock language="bash">{InstallNodejsSh}</CodeBlock>
4869

70+
</TabItem>
71+
<TabItem value="macos" label="macOS">
72+
73+
<CodeBlock language="bash">{InstallNodejsMacOSSh}</CodeBlock>
74+
75+
</TabItem>
76+
</Tabs>
77+
4978
**Docker (optional, for containerized builds):**
5079

80+
<Tabs groupId="operating-systems">
81+
<TabItem value="linux" label="Linux (Ubuntu/Debian)">
82+
5183
<CodeBlock language="bash">{InstallDockerSh}</CodeBlock>
5284

85+
</TabItem>
86+
<TabItem value="macos" label="macOS">
87+
88+
<CodeBlock language="bash">{InstallDockerMacOSSh}</CodeBlock>
89+
90+
</TabItem>
91+
</Tabs>
92+
5393
#### 4. WASM Tools (for web node development)
5494

5595
<CodeBlock language="bash">{InstallWasmToolsSh}</CodeBlock>

‎website/docs/developers/scripts/setup/install-docker-macos.sh‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Install Docker Desktop for Mac
2+
# Note: This requires manual download and installation
3+
echo "Docker Desktop for Mac needs to be installed manually."
4+
echo "Please download it from: https://www.docker.com/products/docker-desktop/"
5+
echo "Alternatively, you can use Homebrew Cask:"
6+
echo "brew install --cask docker"
7+
8+
# Install Docker via Homebrew Cask (user will need to start Docker Desktop manually)
9+
brew install --cask docker

‎website/docs/developers/scripts/setup/install-nodejs-macos.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Install Node.js (version 18+ recommended) via Homebrew
2+
brew install node@18
3+
4+
# Link Node.js if needed
5+
brew link node@18

‎website/docs/developers/scripts/setup/install-system-deps-macos.sh‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Install Homebrew if not already installed
2+
if ! command -v brew &> /dev/null; then
3+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
4+
fi
5+
6+
# Install system dependencies
7+
brew install \
8+
openssl \
9+
pkg-config \
10+
protobuf \
11+
sqlite \
12+
git \
13+
curl

0 commit comments

Comments
 (0)