Merge pull request #3131 from o1-labs/include-macos-ci

dannywillems · web-flow · commit 62328ff820d7 · 2025-08-18T19:17:25.000+02:00
CI: include macos-latest
diff --git a/.github/actions/build-mips/action.yaml b/.github/actions/build-mips/action.yaml
@@ -4,19 +4,39 @@ description: 'Builds MIPS programs for testing'
 runs:
   using: "composite"
   steps:
-    - name: Cache apt packages
+    - name: Cache apt packages (Linux)
+      if: runner.os == 'Linux'
       uses: actions/cache@v4
       with:
         path: |
           /var/cache/apt/archives/*.deb
         key: ${{ runner.os }}-apt-${{ hashFiles('.github/workflows/o1vm-mips-build.yml') }}
 
-    - name: Install MIPS tools
+    - name: Install MIPS tools (Linux)
+      if: runner.os == 'Linux'
       shell: bash
       run: |
         sudo apt-get update
         sudo apt-get install -y binutils-mips-linux-gnu
 
-    - name: Build MIPS programs
+    - name: Install MIPS tools (macOS)
+      if: runner.os == 'macOS'
       shell: bash
-      run: make build-mips-programs
+      run: |
+        # Pull the dockcross MIPS image for cross-compilation
+        docker pull dockcross/linux-mips:latest
+
+    - name: Build MIPS programs (Linux)
+      if: runner.os == 'Linux'
+      shell: bash
+      run: make build-mips-programs
+
+    - name: Build MIPS programs (macOS)
+      if: runner.os == 'macOS'
+      shell: bash
+      run: |
+        # Use dockcross Docker image for MIPS cross-compilation on macOS
+        docker run --rm -v $(pwd):/work dockcross/linux-mips:latest bash -c "
+          cd /work &&
+          make build-mips-programs MIPS_AS=mips-linux-gnu-as MIPS_LD=mips-linux-gnu-ld
+        "
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,31 +30,45 @@ jobs:
   define-matrix:
     runs-on: ubuntu-latest
     outputs:
-      rust_toolchain_version: ${{ steps.rust.outputs.version }}
-      default_rust_version: ${{ fromJson(steps.rust.outputs.version)[0] }}
       ocaml_version: ${{ steps.ocaml.outputs.version }}
       node: ${{ steps.node.outputs.version }}
-      os: ${{ steps.os.outputs.version }}
-      default_os: ${{ fromJson(steps.os.outputs.version)[0] }}
+      matrix: ${{ steps.matrix.outputs.value }}
+      default_rust_version: ${{ steps.defaults.outputs.rust_version }}
+      default_os: ${{ steps.defaults.outputs.os }}
     steps:
-      - id: rust
-        run: echo 'version=["1.81", "1.82"]' >> "$GITHUB_OUTPUT"
       # FIXME: currently not available for 5.0.0.
       # It might be related to boxroot dependency, and we would need to bump
       # up the ocaml-rs dependency
       - id: ocaml
         run: echo 'version=["4.14.2"]' >> "$GITHUB_OUTPUT"
       - id: node
         run: echo 'version=["20"]' >> "$GITHUB_OUTPUT"
-      - id: os
-        run: echo 'version=["ubuntu-latest", "ubuntu-24.04-arm"]' >> "$GITHUB_OUTPUT"
+      - id: defaults
+        run: |
+          echo 'rust_version=1.81' >> "$GITHUB_OUTPUT"
+          echo 'os=ubuntu-latest' >> "$GITHUB_OUTPUT"
+      - id: matrix
+        run: |
+          # NOTE: This custom matrix configuration is needed to use Rust 1.84 specifically for macOS.
+          # When https://github.com/o1-labs/proof-systems/issues/3254 is fixed,
+          # this can be simplified to use a standard matrix configuration.
+          cat > matrix.json << 'EOF'
+          {
+            "include": [
+              {"rust_toolchain_version": "1.81", "os": "ubuntu-latest"},
+              {"rust_toolchain_version": "1.82", "os": "ubuntu-latest"},
+              {"rust_toolchain_version": "1.81", "os": "ubuntu-24.04-arm"},
+              {"rust_toolchain_version": "1.82", "os": "ubuntu-24.04-arm"},
+              {"rust_toolchain_version": "1.84", "os": "macos-latest"}
+            ]
+          }
+          EOF
+          echo "value=$(cat matrix.json | jq -c .)" >> "$GITHUB_OUTPUT"
 
   refresh-cache:
     needs: ['define-matrix']
     strategy:
-      matrix:
-        rust_toolchain_version: ${{ fromJSON(needs.define-matrix.outputs.rust_toolchain_version) }}
-        os: ${{ fromJSON(needs.define-matrix.outputs.os) }}
+      matrix: ${{ fromJSON(needs.define-matrix.outputs.matrix) }}
     runs-on: ${{ matrix.os }}
     steps:
       # if 'workflow_run'
@@ -64,7 +78,7 @@ jobs:
       - uses: ./.github/actions/toolchain-shared
         if: ${{ github.event_name == 'workflow_run' }}
         with:
-          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+          rust_toolchain_version: ${{ matrix.rust_and_os.rust_toolchain_version }}
       - name: start-fresh
         if: ${{ github.event_name == 'workflow_run' }}
         shell: bash
@@ -81,11 +95,14 @@ jobs:
     needs: ['define-matrix', 'refresh-cache']
     strategy:
       matrix:
-        rust_toolchain_version: ${{ fromJSON(needs.define-matrix.outputs.rust_toolchain_version) }}
+        rust_and_os: ${{ fromJSON(needs.define-matrix.outputs.matrix).include }}
         ocaml_version: ${{ fromJSON(needs.define-matrix.outputs.ocaml_version) }}
         node: ${{ fromJSON(needs.define-matrix.outputs.node) }}
-        os: ${{ fromJSON(needs.define-matrix.outputs.os) }}
-    runs-on: ${{ matrix.os }}
+        exclude:
+          # Skip Rust 1.84 due to linting issues - remove when
+          # https://github.com/o1-labs/proof-systems/pull/3245 is fixed
+          - rust_and_os: {rust_toolchain_version: '1.84', os: 'macos-latest'}
+    runs-on: ${{ matrix.rust_and_os.os }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
@@ -100,7 +117,7 @@ jobs:
       - name: Use shared Rust toolchain setting up steps
         uses: ./.github/actions/toolchain-shared
         with:
-          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+          rust_toolchain_version: ${{ matrix.rust_and_os.rust_toolchain_version }}
 
       - name: Use shared OCaml setting up steps
         uses: ./.github/actions/ocaml-shared
@@ -159,10 +176,10 @@ jobs:
 
       - name: Rerun doc generation with different args and copy into book directory
         if: >-
-          github.event_name == 'push' && 
+          github.event_name == 'push' &&
           github.ref == 'refs/heads/master' &&
-          matrix.rust_toolchain_version == needs.define-matrix.outputs.default_rust_version &&
-          matrix.os == needs.define-matrix.outputs.default_os
+          matrix.rust_and_os.rust_toolchain_version == needs.define-matrix.outputs.default_rust_version &&
+          matrix.rust_and_os.os == needs.define-matrix.outputs.default_os
         run: |
           eval $(opam env)
           RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly doc --all-features --no-deps --workspace --exclude xtask
@@ -171,10 +188,10 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e
         if: >-
-          github.event_name == 'push' && 
+          github.event_name == 'push' &&
           github.ref == 'refs/heads/master' &&
-          matrix.rust_toolchain_version == needs.define-matrix.outputs.default_rust_version &&
-          matrix.os == needs.define-matrix.outputs.default_os
+          matrix.rust_and_os.rust_toolchain_version == needs.define-matrix.outputs.default_rust_version &&
+          matrix.rust_and_os.os == needs.define-matrix.outputs.default_os
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./book/book/html
@@ -183,11 +200,14 @@ jobs:
     needs: ['define-matrix', 'refresh-cache']
     strategy:
       matrix:
-        rust_toolchain_version: ${{ fromJSON(needs.define-matrix.outputs.rust_toolchain_version) }}
+        rust_and_os: ${{ fromJSON(needs.define-matrix.outputs.matrix).include }}
         ocaml_version: ${{ fromJSON(needs.define-matrix.outputs.ocaml_version) }}
         node: ${{ fromJSON(needs.define-matrix.outputs.node) }}
-        os: ${{ fromJSON(needs.define-matrix.outputs.os) }}
-    runs-on: ${{ matrix.os }}
+        exclude:
+          # Skip Rust 1.84 due to linting issues - remove when
+          # https://github.com/o1-labs/proof-systems/pull/3245 is fixed
+          - rust_and_os: {rust_toolchain_version: '1.84', os: 'macos-latest'}
+    runs-on: ${{ matrix.rust_and_os.os }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
@@ -197,7 +217,7 @@ jobs:
       - name: Use shared Rust toolchain setting up steps
         uses: ./.github/actions/toolchain-shared
         with:
-          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+          rust_toolchain_version: ${{ matrix.rust_and_os.rust_toolchain_version }}
 
       - name: Use shared OCaml setting up steps
         uses: ./.github/actions/ocaml-shared
@@ -216,11 +236,10 @@ jobs:
     needs: ['define-matrix', 'refresh-cache']
     strategy:
       matrix:
-        rust_toolchain_version: ${{ fromJSON(needs.define-matrix.outputs.rust_toolchain_version) }}
+        rust_and_os: ${{ fromJSON(needs.define-matrix.outputs.matrix).include }}
         ocaml_version: ${{ fromJSON(needs.define-matrix.outputs.ocaml_version) }}
         node: ${{ fromJSON(needs.define-matrix.outputs.node) }}
-        os: ${{ fromJSON(needs.define-matrix.outputs.os) }}
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.rust_and_os.os }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
@@ -230,7 +249,7 @@ jobs:
       - name: Use shared Rust toolchain setting up steps
         uses: ./.github/actions/toolchain-shared
         with:
-          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+          rust_toolchain_version: ${{ matrix.rust_and_os.rust_toolchain_version }}
 
       - name: Use shared OCaml setting up steps
         uses: ./.github/actions/ocaml-shared
@@ -249,11 +268,14 @@ jobs:
     needs: ['define-matrix', 'refresh-cache']
     strategy:
       matrix:
-        rust_toolchain_version: ${{ fromJSON(needs.define-matrix.outputs.rust_toolchain_version) }}
+        rust_and_os: ${{ fromJSON(needs.define-matrix.outputs.matrix).include }}
         ocaml_version: ${{ fromJSON(needs.define-matrix.outputs.ocaml_version) }}
         node: ${{ fromJSON(needs.define-matrix.outputs.node) }}
-        os: ${{ fromJSON(needs.define-matrix.outputs.os) }}
-    runs-on: ${{ matrix.os }}
+        exclude:
+          # Skip Rust 1.84 due to linting issues - remove when
+          # https://github.com/o1-labs/proof-systems/pull/3245 is fixed
+          - rust_and_os: {rust_toolchain_version: '1.84', os: 'macos-latest'}
+    runs-on: ${{ matrix.rust_and_os.os }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
@@ -263,7 +285,7 @@ jobs:
       - name: Use shared Rust toolchain setting up steps
         uses: ./.github/actions/toolchain-shared
         with:
-          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+          rust_toolchain_version: ${{ matrix.rust_and_os.rust_toolchain_version }}
           components: llvm-tools-preview
 
       - name: Use shared OCaml setting up steps
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### CI
+
+#### Added
+
+- CI: add support for macos-latest with Rust 1.84
+  ([#3131](https://github.com/o1-labs/proof-systems/pull/3131))
+
 ### [arrabbiata](./arrabbiata)
 
 #### Changed
diff --git a/Makefile b/Makefile
@@ -25,6 +25,10 @@ O1VM_MIPS_SOURCE_FILES = $(patsubst ${OPTIMISM_MIPS_SOURCE_DIR}/%.asm,${O1VM_MIP
 O1VM_MIPS_BIN_DIR = ${O1VM_RESOURCES_PATH}/mips/bin
 O1VM_MIPS_BIN_FILES = $(patsubst ${O1VM_MIPS_SOURCE_DIR}/%.asm,${O1VM_MIPS_BIN_DIR}/%.o,${O1VM_MIPS_SOURCE_FILES})
 
+# MIPS toolchain configuration (can be overridden for different platforms)
+MIPS_AS ?= mips-linux-gnu-as
+MIPS_LD ?= mips-linux-gnu-ld
+
 # This should be updated if rust-toolchain.toml is updated, and the nightly
 # version should be close to the date of the release of the stable version used
 # in rust-toolchain.toml.
@@ -229,8 +233,8 @@ ${O1VM_MIPS_SOURCE_DIR}/%.asm: ${OPTIMISM_MIPS_SOURCE_DIR}/%.asm
 ${O1VM_MIPS_BIN_DIR}/%.o: ${O1VM_MIPS_SOURCE_DIR}/%.asm
 		@echo "Building the MIPS binary: $(basename $@) using $<"
 		@mkdir -p ${O1VM_MIPS_BIN_DIR}
-		@mips-linux-gnu-as -defsym big_endian=1 -march=mips32r2 -o $@ $<
-		@mips-linux-gnu-ld -s -o $(basename $@) $@
+		@${MIPS_AS} -defsym big_endian=1 -march=mips32r2 -o $@ $<
+		@${MIPS_LD} -s -o $(basename $@) $@
 
 fclean: clean ## Clean the tooling artefacts in addition to running clean
 		rm -rf ${RISCV32_TOOLCHAIN_PATH}
