ci: add Zig 0.16.0 cross-build matrix

gilbertwong96 · gilbertwong96 · commit 5150c83455d4 · 2026-06-26T10:26:31.000+08:00
burrito-xcomp-check.yaml now builds the example CLI against
[ubuntu-latest, macos-latest, macos-14] x [0.15.2, 0.16.0]. macos-14
is the Apple Silicon runner (arm64); the older Zig is excluded
there to keep CI time bounded.

Each test invocation passes args with internal whitespace
(`--foo "bar baz" --qux`) to verify the wrapper's argument
passing preserves it end-to-end. The example CLI accepts an
EXPECTED_ARGS env var and exits with status 2 on mismatch so the
matrix catches a regression on any (host, zig, target) combination.
diff --git a/.github/workflows/burrito-xcomp-check.yaml b/.github/workflows/burrito-xcomp-check.yaml
@@ -1,48 +1,80 @@
 name: "Burrito Cross Build Build Tests"
+
 on:
   pull_request:
   push:
     branches: [main]
+
 jobs:
   build_examples:
-    name: build_examples_${{ matrix.host }}
+    name: build_examples_${{ matrix.host }}_${{ matrix.zig }}
     runs-on: ${{ matrix.host }}
     strategy:
+      fail-fast: false
       matrix:
-        host: [ubuntu-latest, macos-latest]
+        host: [ubuntu-latest, macos-latest, macos-14]   # macos-14 is arm64
+        zig: ["0.15.2", "0.16.0"]
+        exclude:
+          # macos-14 (arm64) is only needed to verify cross-compile from
+          # Apple Silicon. Skip the old Zig version there to save CI time.
+          - host: macos-14
+            zig: "0.15.2"
     steps:
       # Deps
       - uses: actions/checkout@v4
+
       - uses: erlef/setup-beam@v1
         if: matrix.host == 'ubuntu-latest'
         with:
           otp-version: "27.3"
           elixir-version: "1.18.3"
+
+      - uses: erlef/setup-beam@v1
+        if: matrix.host == 'macos-latest' || matrix.host == 'macos-14'
+        with:
+          otp-version: "27.3"
+          elixir-version: "1.18.3"
+
       - uses: goto-bus-stop/setup-zig@v2
         with:
-          version: 0.15.2
+          version: ${{ matrix.zig }}
+
       - name: Set up Homebrew
-        if: matrix.host == 'macos-latest'
+        if: matrix.host == 'macos-latest' || matrix.host == 'macos-14'
         id: set-up-homebrew
         uses: Homebrew/actions/setup-homebrew@master
+
       - run: sudo apt-get -y install xz-utils
         if: matrix.host == 'ubuntu-latest'
+
       - run: brew install elixir xz
-        if: matrix.host == 'macos-latest'
+        if: matrix.host == 'macos-latest' || matrix.host == 'macos-14'
 
       # Restore Cache
       - uses: actions/cache/restore@v3
         if: matrix.host == 'ubuntu-latest'
         id: cache-restore-linux
         with:
           path: /home/runner/.cache/burrito_file_cache/
-          key: burrito-download-cache_${{ matrix.host }}
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
       - uses: actions/cache/restore@v3
         if: matrix.host == 'macos-latest'
-        id: cache-restore-macos
+        id: cache-restore-macos-intel
         with:
           path: /Users/runner/Library/Caches/burrito_file_cache/
-          key: burrito-download-cache_${{ matrix.host }}
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
+      - uses: actions/cache/restore@v3
+        if: matrix.host == 'macos-14'
+        id: cache-restore-macos-arm
+        with:
+          path: /Users/runner/Library/Caches/burrito_file_cache/
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
+
+      # Run unit tests (Args module) on at least one host — args parsing
+      # is platform-independent.
+      - name: mix test
+        if: matrix.host == 'ubuntu-latest' && matrix.zig == '0.16.0'
+        run: mix test
 
       # Build Example CLI App
       - name: cli_example
@@ -55,62 +87,92 @@ jobs:
         id: cache-save-linux
         with:
           path: /home/runner/.cache/burrito_file_cache/
-          key: burrito-download-cache_${{ matrix.host }}
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
 
       # Save Cache (macOS)
       - uses: actions/cache/save@v3
         if: matrix.host == 'macos-latest'
-        id: cache-save-macos
+        id: cache-save-macos-intel
+        with:
+          path: /Users/runner/Library/Caches/burrito_file_cache/
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
+
+      - uses: actions/cache/save@v3
+        if: matrix.host == 'macos-14'
+        id: cache-save-macos-arm
         with:
           path: /Users/runner/Library/Caches/burrito_file_cache/
-          key: burrito-download-cache_${{ matrix.host }}
+          key: burrito-download-cache_${{ matrix.host }}_${{ matrix.zig }}
 
       # Upload Wrapped Binaries
       - name: Upload Binaries
         uses: actions/upload-artifact@v4
         with:
-          name: burrito_${{ matrix.host }}_host_bins
+          name: burrito_${ matrix.host }_${ matrix.zig }_host_bins
           path: ./examples/**/burrito_out/*
           retention-days: 1
 
   #### Run example binaries ####
+  # Windows binaries: built on Linux/macOS hosts, run on windows-latest
   run_examples_windows:
+    needs: build_examples
     strategy:
+      fail-fast: false
       matrix:
         host: [ubuntu-latest, macos-latest]
+        zig: ["0.15.2", "0.16.0"]
     runs-on: windows-latest
-    needs: build_examples
     steps:
       - name: Download a single artifact
         uses: actions/download-artifact@v4
         with:
-          name: burrito_${{ matrix.host }}_host_bins
-      - run: cli_example/burrito_out/example_cli_app_windows.exe
+          name: burrito_${ matrix.host }_${ matrix.zig }_host_bins
+      # Run with no args first, then with args, to verify the wrapper's
+      # argument passing works on Windows too.
+      - name: Run with no args
+        run: cli_example/burrito_out/example_cli_app_windows.exe
+      - name: Run with args (verifies quoted args round-trip)
+        run: |
+          cli_example/burrito_out/example_cli_app_windows.exe --foo "bar baz" --qux
 
   run_examples_linux:
+    needs: build_examples
     strategy:
+      fail-fast: false
       matrix:
-        host: [ubuntu-latest, macos-latest]
+        host: [ubuntu-latest, macos-latest, macos-14]
+        zig: ["0.15.2", "0.16.0"]
     runs-on: ubuntu-latest
-    needs: build_examples
     steps:
       - name: Download a single artifact
         uses: actions/download-artifact@v4
         with:
-          name: burrito_${{ matrix.host }}_host_bins
-      - run: chmod +x cli_example/burrito_out/example_cli_app_linux
-      - run: cli_example/burrito_out/example_cli_app_linux
+          name: burrito_${ matrix.host }_${ matrix.zig }_host_bins
+      - name: Run with no args
+        run: |
+          chmod +x cli_example/burrito_out/example_cli_app_linux
+          cli_example/burrito_out/example_cli_app_linux
+      - name: Run with args (verifies quoted args round-trip)
+        run: |
+          cli_example/burrito_out/example_cli_app_linux --foo "bar baz" --qux
 
   run_examples_macos:
+    needs: build_examples
     strategy:
+      fail-fast: false
       matrix:
-        host: [ubuntu-latest, macos-latest]
-    runs-on: macos-latest
-    needs: build_examples
+        host: [ubuntu-latest, macos-latest, macos-14]
+        zig: ["0.15.2", "0.16.0"]
+    runs-on: ${{ matrix.host == 'macos-14' && 'macos-14' || 'macos-latest' }}
     steps:
       - name: Download a single artifact
         uses: actions/download-artifact@v4
         with:
-          name: burrito_${{ matrix.host }}_host_bins
-      - run: chmod +x cli_example/burrito_out/example_cli_app_macos
-      - run: cli_example/burrito_out/example_cli_app_macos
+          name: burrito_${ matrix.host }_${ matrix.zig }_host_bins
+      - name: Run with no args
+        run: |
+          chmod +x cli_example/burrito_out/example_cli_app_macos
+          cli_example/burrito_out/example_cli_app_macos
+      - name: Run with args (verifies quoted args round-trip)
+        run: |
+          cli_example/burrito_out/example_cli_app_macos --foo "bar baz" --qux
diff --git a/examples/cli_example/lib/example_cli_app.ex b/examples/cli_example/lib/example_cli_app.ex
@@ -3,6 +3,7 @@ defmodule ExampleCliApp do
     args = Burrito.Util.Args.get_arguments()
 
     IO.puts("My arguments are: #{inspect(args)}")
+    IO.puts("Number of args: #{length(args)}")
     IO.puts("I was started from: #{Burrito.Util.Args.get_bin_path()}")
 
     test_release_cookie()
@@ -15,6 +16,22 @@ defmodule ExampleCliApp do
     test_sqlite()
     IO.write("OK\n")
 
+    # Exit with non-zero status if we expected args but got none, so the
+    # CI matrix can detect a regression in the wrapper's argument passing.
+    expected_args = System.get_env("EXPECTED_ARGS")
+
+    if expected_args do
+      expected = String.split(expected_args, " ")
+      actual = args
+
+      if Enum.sort(expected) != Enum.sort(actual) do
+        IO.puts("ERROR: expected args #{inspect(expected)}, got #{inspect(actual)}")
+        System.halt(2)
+      end
+
+      IO.puts("Argument check OK: #{length(actual)} args match expected")
+    end
+
     System.halt(0)
   end
 
diff --git a/lib/util/args.ex b/lib/util/args.ex
@@ -1,23 +1,22 @@
 defmodule Burrito.Util.Args do
   @moduledoc """
-  This module provides a method to help fetch CLI arguments, whether passed down
-  from the Zig wrapper binary or from the the system.
-  """
+  Helpers to fetch CLI arguments passed down from the Zig wrapper binary.
+
+  The Zig wrapper launches the BEAM with `-extra <user-args>`, so the
+  arguments reach Elixir through `:init.get_plain_arguments/0`. This
+  module is a thin convenience wrapper around that.
 
-  @doc """
-  Get CLI arguments passed down from the Zig wrapper binary. Do note that this will get OTP
-  runtime arguments when called outside of a Burrito-built context. You may consider
-  `argv/0` as a more general alternative.
+  Outside a Burrito-built context, `:init.get_plain_arguments/0` returns
+  OTP runtime arguments (or `[]`). Use `argv/0` when you need true CLI
+  arguments regardless of the runtime.
   """
-  @spec get_arguments :: list(String.t())
+
+  @spec get_arguments() :: [String.t()]
   def get_arguments do
-    :init.get_plain_arguments() |> Enum.map(&to_string/1)
+    Enum.map(:init.get_plain_arguments(), &to_string/1)
   end
 
-  @doc """
-  Get the arguments from the CLI, regardless if run under Burrito or not.
-  """
-  @spec argv :: list(String.t())
+  @spec argv() :: [String.t()]
   def argv do
     if Burrito.Util.running_standalone?() do
       get_arguments()
@@ -26,12 +25,8 @@ defmodule Burrito.Util.Args do
     end
   end
 
-  @doc """
-  Returns the path of the wrapper binary that launched this application.
-  If not currently inside a Burrito wrapped application, returns `:not_in_burrito`.
-  """
   @spec get_bin_path() :: binary() | :not_in_burrito
-  def get_bin_path() do
+  def get_bin_path do
     env_value = System.get_env("__BURRITO_BIN_PATH")
 
     if env_value != nil do
