build ppx for linux ARM64 (#146)

* build ppx for linux ARM64

* use ocaml/setup-ocaml instead of alpine ocaml

because JavaScript Actions in Alpine containers are only supported on x64 Linux runners.

* fix artifact name on upload of linux arm ppx

* move to setup-ocaml for build linux ppx

* move to ocaml 4.14.2

* upgrade ocaml to v5.3.0

* relax dependencies and create dune pkg locks

* use dune package manager workflow

* use setup dune

* Revert "use setup dune"

This reverts commit 225dc50.

* use opam again

* fix ci on windows

* downgrade to setup-ocaml@v2 for windows

* downgrading ocaml to 5.2.0 on windows

* try downgrading to 4.14 on windows

* try using [email protected] and windows-2022

* try again with latest windows and setup-ocaml

* try running dune build inside a script

* add more logs

* and more logs again

* use ppxlib < 0.35.0

ppxlib 0.35.0 dropped support for ocaml ast <= 4.08

* remove dune pkg lock for now

* simplify dependency constraints

* disable dune cache for windows

* add permissions for E2E test

* remove dune_build.sh

* fix E2E tests permissions

* update contribution instructions for ocaml

Author: tsnobip

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   sury:
     name: Sury - Build & Test & Lint & Pack
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
@@ -42,22 +42,21 @@ jobs:
 
   ppx-build-linux:
     name: ppx-build-linux
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     defaults:
       run:
         working-directory: packages/sury-ppx/src
     strategy:
       matrix:
         ocaml-compiler:
-          - 4.12.1
-    container:
-      image: ocaml/opam:alpine-3.16-ocaml-4.12
-      options: --user root
+          - 5.3.0
     steps:
       - uses: actions/checkout@v4
 
-      - name: Opam init
-        run: opam init -a --disable-sandboxing --compiler=${{ matrix.ocaml-compiler }}
+      - name: Use OCaml ${{ matrix.ocaml-compiler}}
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
 
       - name: Install deps
         run: opam install . --deps-only --with-test
@@ -72,6 +71,37 @@ jobs:
           path: packages/sury-ppx/src/_build/default/bin/bin.exe
           if-no-files-found: error
 
+  ppx-build-linux-arm:
+    name: ppx-build-linux-arm
+    runs-on: ubuntu-24.04-arm
+    defaults:
+      run:
+        working-directory: packages/sury-ppx/src
+    strategy:
+      matrix:
+        ocaml-compiler:
+          - 5.3.0
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use OCaml ${{ matrix.ocaml-compiler}}
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+      - name: Install deps
+        run: opam install . --deps-only --with-test
+
+      - name: Build
+        run: opam exec -- dune build --profile static
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ppx-build-linux-arm
+          path: packages/sury-ppx/src/_build/default/bin/bin.exe
+          if-no-files-found: error
+
   ppx-build-macos:
     name: ppx-build-macos
     runs-on: macOS-latest
@@ -81,12 +111,12 @@ jobs:
     strategy:
       matrix:
         ocaml-compiler:
-          - 4.12.1
+          - 5.3.0
     steps:
       - uses: actions/checkout@v4
 
       - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
+        uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: ${{ matrix.ocaml-compiler }}
 
@@ -97,7 +127,7 @@ jobs:
         run: opam exec -- dune build
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@v4
         with:
           name: ppx-build-macos
           path: packages/sury-ppx/src/_build/default/bin/bin.exe
@@ -112,12 +142,12 @@ jobs:
     strategy:
       matrix:
         ocaml-compiler:
-          - 4.12.1
+          - 5.3.0
     steps:
       - uses: actions/checkout@v4
 
       - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
+        uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: ${{ matrix.ocaml-compiler }}
 
@@ -128,27 +158,27 @@ jobs:
         run: opam exec -- dune build
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@v4
         with:
           name: ppx-build-macos-x64
           path: packages/sury-ppx/src/_build/default/bin/bin.exe
           if-no-files-found: error
 
   ppx-build-windows:
     name: ppx-build-windows
-    runs-on: windows-latest
+    runs-on: windows-2025
     defaults:
       run:
         working-directory: packages/sury-ppx/src
     strategy:
       matrix:
         ocaml-compiler:
-          - 4.12.1
+          - 5.3.0
     steps:
       - uses: actions/checkout@v4
 
       - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
+        uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: ${{ matrix.ocaml-compiler }}
 
@@ -159,16 +189,23 @@ jobs:
         run: opam exec -- dune build
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@master
+        uses: actions/upload-artifact@v4
         with:
           name: ppx-build-windows
           path: packages/sury-ppx/src/_build/default/bin/bin.exe
           if-no-files-found: error
 
   pack-sury-ppx:
     name: Pack sury-ppx
-    needs: [ppx-build-linux, ppx-build-macos, ppx-build-macos-x64, ppx-build-windows]
-    runs-on: ubuntu-latest
+    needs:
+      [
+        ppx-build-linux,
+        ppx-build-linux-arm,
+        ppx-build-macos,
+        ppx-build-macos-x64,
+        ppx-build-windows,
+      ]
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
@@ -184,6 +221,12 @@ jobs:
           name: ppx-build-linux
           path: binaries/linux
 
+      - name: Download ppx linux-ARM artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: ppx-build-linux-arm
+          path: binaries/linux-arm
+
       - name: Download macOS artifacts
         uses: actions/download-artifact@master
         with:
@@ -205,6 +248,7 @@ jobs:
       - name: Move ppx artifacts
         run: |
           mv binaries/linux/bin.exe packages/sury-ppx/ppx-linux.exe
+          mv binaries/linux-arm/bin.exe packages/sury-ppx/ppx-linux-arm.exe
           mv binaries/macos/bin.exe packages/sury-ppx/ppx-osx.exe
           mv binaries/macos-x64/bin.exe packages/sury-ppx/ppx-osx-x64.exe
           mv binaries/windows/bin.exe packages/sury-ppx/ppx-windows.exe
@@ -221,8 +265,11 @@ jobs:
 
   e2e:
     name: E2E Test
+    permissions:
+      contents: write
+      pull-requests: write
     needs: [ppx-build-linux]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2

CONTRIBUTING.md

@@ -26,7 +26,7 @@ Make sure running the below commands in `packages/sury-ppx/src`.
 1. Create a sandbox with opam
 
 ```
-opam switch create sury-ppx 4.12.1
+opam switch create sury-ppx 5.3.0
 ```
 
 Or

packages/sury-ppx/install.cjs

@@ -35,7 +35,9 @@ const installWindowsBinary = () => {
 
 switch (process.platform) {
   case "linux":
-    installMacLinuxBinary("ppx-linux.exe");
+    installMacLinuxBinary(
+      process.arch === "arm64" ? "ppx-linux-arm.exe" : "ppx-linux.exe"
+    );
     break;
   case "darwin":
     const binaryName =

packages/sury-ppx/package.json

@@ -24,6 +24,7 @@
     "install.cjs",
     "ppx-windows.exe",
     "ppx-linux.exe",
+    "ppx-linux-arm.exe",
     "ppx-osx.exe",
     "ppx-osx-x64.exe",
     "bin.cmd",

packages/sury-ppx/src/dune-project

@@ -1,2 +1,3 @@
-(lang dune 2.7)
+(lang dune 3.19)
+
 (name sury-ppx)

packages/sury-ppx/src/sury-ppx.opam

@@ -12,9 +12,9 @@ homepage: "https://github.com/DZakh/rescript-schema"
 bug-reports: "https://github.com/DZakh/rescript-schema/issues"
 dev-repo: "git+https://github.com/DZakh/rescript-schema.git"
 depends: [
-  "ocaml" { = "4.12.1"}
-  "dune" { >= "2.7"}
-  "ppxlib" { = "0.24.0"}
+  "ocaml" { >= "4.12.1"}
+  "dune" { >= "3.19"}
+  "ppxlib" { = "0.34.0" }
 ]
 build: [
   ["dune" "build" "-p" name "-j" jobs]