ci: add example build test (#2)

Author: Brooooooklyn

.github/workflows/ci.yml

@@ -2,6 +2,8 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
   pull_request:
   # Run daily to catch when Rust updates cause problems to happen.
   schedule:
@@ -102,3 +104,94 @@ jobs:
 
       - name: 'Check documentation links in `libmimalloc-sys`'
         run: cargo rustdoc -p libmimalloc-sys2 -- -D warnings
+
+  build-example:
+    name: Build example ${{ matrix.settings.target }}
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: x86_64-apple-darwin
+          - host: windows-latest
+            target: x86_64-pc-windows-msvc
+          - host: windows-latest
+            target: i686-pc-windows-msvc
+          - host: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - host: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+          - host: macos-latest
+            target: aarch64-apple-darwin
+          - host: ubuntu-24.04-arm
+            target: aarch64-unknown-linux-gnu
+          - host: ubuntu-latest
+            target: armv7-unknown-linux-gnueabihf
+          - host: ubuntu-latest
+            target: aarch64-linux-android
+          - host: ubuntu-24.04-arm
+            target: aarch64-unknown-linux-musl
+          - host: windows-latest
+            target: aarch64-pc-windows-msvc
+          - host: ubuntu-latest
+            target: powerpc64le-unknown-linux-gnu
+          - host: ubuntu-latest
+            target: s390x-unknown-linux-gnu
+          - host: ubuntu-latest
+            target: wasm32-wasip1-threads
+
+    runs-on: ${{ matrix.settings.host }}
+    
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install
+        run: rustup target add ${{ matrix.settings.target }}
+
+      - uses: goto-bus-stop/setup-zig@v2
+        if: ${{ contains(matrix.settings.target, 'musl') }}
+        with:
+          version: 0.14.0
+      
+      - name: Install cargo-zigbuild
+        uses: taiki-e/install-action@v2
+        if: ${{ contains(matrix.settings.target, 'musl') }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          tool: cargo-zigbuild
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        working-directory: example
+        run: |
+          corepack enable
+          yarn install
+
+      - name: Install wasi-sdk
+        run: |
+          mkdir -p $HOME/wasi-sdk
+          curl -L https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-25/wasi-sdk-25.0-x86_64-linux.tar.gz | tar -xzf - -C $HOME/wasi-sdk --strip-components=1
+          echo "WASI_SDK_PATH=$HOME/wasi-sdk" >> $GITHUB_ENV
+
+      - name: Build
+        working-directory: example
+        shell: bash
+        run: |
+          if [[ "${{ matrix.settings.target }}" == *"musl"* ]]; then
+            yarn build --target ${{ matrix.settings.target }} -x
+            yarn build --target ${{ matrix.settings.target }} -x --release
+          elif [[ "${{ matrix.settings.target }}" == *"gnu"* ]]; then
+            export CFLAGS="-fuse-ld=lld"
+            export CC=clang
+            yarn build --target ${{ matrix.settings.target }} --use-napi-cross
+            yarn build --target ${{ matrix.settings.target }} --use-napi-cross --release
+          else
+            yarn build --target ${{ matrix.settings.target }}
+            yarn build --target ${{ matrix.settings.target }} --release
+          fi

Cargo.toml

@@ -16,7 +16,7 @@ license = "MIT"
 readme = "README.md"
 
 [workspace]
-members = ["libmimalloc-sys", "libmimalloc-sys/sys-test"]
+members = ["libmimalloc-sys", "libmimalloc-sys/sys-test", "example"]
 
 [badges]
 travis-ci = { repository = "purpleprotocol/mimalloc_rust" }

example/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.yarn
+*.node
+*.wasm

example/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

example/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "mimalloc_example"
+version = "0.1.0"
+edition = "2024"
+
+[lib]
+crate-type = ["cdylib", "lib"]
+
+[dependencies]
+napi = "3.0.0-alpha"
+napi-derive = "3.0.0-alpha"
+
+[target.'cfg(target_os = "linux")'.dependencies]
+mimalloc-safe = { path = "../", features = ["local_dynamic_tls", "skip_collect_on_exit"] }
+
+[target.'cfg(not(target_os = "linux"))'.dependencies]
+mimalloc-safe = { path = "../", features = ["skip_collect_on_exit"] }
+
+[build-dependencies]
+napi-build = "2"

example/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    napi_build::setup();
+}

example/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "mimalloc-example",
+  "private": true,
+  "scripts": {
+    "build": "napi build"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "canary"
+  },
+  "packageManager": "[email protected]"
+}

example/src/lib.rs

@@ -0,0 +1,9 @@
+use napi_derive::napi;
+
+#[global_allocator]
+static ALLOC: mimalloc_safe::MiMalloc = mimalloc_safe::MiMalloc;
+
+#[napi]
+pub fn hello() -> String {
+    "Hello, world!".to_string()
+}