Nix develop: add website instructions & CI

Author: volhovm

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

@@ -76,6 +76,45 @@ jobs:
           sqlite3 --version
           wasm-pack --version
 
+  test-nix-setup:
+    name: Test Nix Setup (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'test-doc-scripts')
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, ubuntu-24.04]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@v4
+
+      - name: Setup Nix Cache
+        uses: DeterminateSystems/magic-nix-cache-action@v2
+
+      - name: Test nix develop succeeds
+        run: |
+          nix develop
+
+      - name: Test specialised builds
+        run: |
+          nix develop --command ./website/docs/developers/scripts/setup/build-specialized.sh
+
+      - name: Test format and lint
+        run: |
+          nix develop --command ./website/docs/developers/scripts/setup/format-and-lint.sh
+
+      - name: Test run tests
+        run: |
+          nix develop --command ./website/docs/developers/scripts/setup/run-tests.sh
+
+      - name: Verify installations
+        run: |
+          echo "Verifying installed tools..."
+          nix develop --command bash -c "rustc --version && cargo --version && node --version && npm --version && protoc --version && sqlite3 --version && wasm-pack --version"
+
   test-docker-setup:
     name: Test Docker Setup Script (${{ matrix.os }})
     runs-on: ${{ matrix.os }}

CHANGELOG.md

@@ -30,6 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   support and trailing whitespace management
   ([#1234](https://github.com/o1-labs/openmina/pull/1234))
 
+
+
 ### Changed
 
 - **Build System**: Enhanced Makefile with documentation-related targets and comprehensive formatting commands ([#1234](https://github.com/o1-labs/openmina/pull/1234))
@@ -54,7 +56,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Other
 
-- Added a `flake.nix` for building the project on nixos/using nix ([#1241](https://github.com/o1-labs/openmina/pull/1241))
+- Added a `flake.nix` for building the project on nixos/using nix ([#1241](https://github.com/o1-labs/openmina/pull/1241)),
+  together with **documentation**: instructions for developers,
+  and test the installation commands in CI.
+
 
 ## [0.16.0] - 2025-04-04
 

website/docs/developers/getting-started.mdx

@@ -14,6 +14,7 @@ import CloneAndBuildSh from "!!raw-loader!./scripts/setup/clone-and-build.sh";
 import BuildSpecializedSh from "!!raw-loader!./scripts/setup/build-specialized.sh";
 import RunTestsSh from "!!raw-loader!./scripts/setup/run-tests.sh";
 import FormatAndLintSh from "!!raw-loader!./scripts/setup/format-and-lint.sh";
+import NixDevelop from "!!raw-loader!./scripts/setup/nix-develop.sh";
 
 Welcome to OpenMina development! This guide will help you set up your
 development environment and build OpenMina from source.
@@ -54,6 +55,13 @@ OpenMina requires both stable and nightly Rust toolchains:
 
 <CodeBlock language="bash">{InstallWasmToolsSh}</CodeBlock>
 
+#### 5. Using Nix to install dependencies automatically
+
+If you're on NixOS or using nix, you can use nix flake provided in the repo to
+install the dependencies automatically and enter the shell:
+
+<CodeBlock language="bash">{NixDevelop}</CodeBlock>
+
 ## Clone and Build OpenMina
 
 ### 1. Clone the Repository and Build

website/docs/developers/scripts/setup/nix-develop.sh

@@ -0,0 +1,6 @@
+# This assumes the repository is cloned, and `flake.nix` is present
+# Enter nix flake environment
+echo "Entering nix develop flake..."
+nix develop
+
+# Build your project afterwards using `make` as usual