ci: Build and test in CI

Author: timfish

.github/workflows/ci.yml

@@ -0,0 +1,346 @@
+
+name: "CI: Build & Test"
+on:
+  push:
+    branches:
+      - main
+      - release/**
+  pull_request:
+
+jobs:
+  job_lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "package.json"
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+      - name: Lint
+        run: yarn lint
+
+  job_compile:
+    name: Compile Binary (v${{ matrix.node }}) ${{ matrix.target_platform || matrix.os }}, ${{ matrix.arch || matrix.container }}, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }}
+    runs-on: ${{ matrix.os }}
+    container:
+      image: ${{ matrix.container }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # x64 glibc
+          - os: ubuntu-22.04
+            node: 18
+            binary: linux-x64-glibc-108
+          - os: ubuntu-22.04
+            node: 20
+            binary: linux-x64-glibc-115
+          - os: ubuntu-22.04
+            node: 22
+            binary: linux-x64-glibc-127
+          - os: ubuntu-22.04
+            node: 24
+            binary: linux-x64-glibc-137
+
+            # x64 musl
+          - os: ubuntu-22.04
+            container: node:18-alpine3.17
+            node: 18
+            binary: linux-x64-musl-108
+          - os: ubuntu-22.04
+            container: node:20-alpine3.17
+            node: 20
+            binary: linux-x64-musl-115
+          - os: ubuntu-22.04
+            container: node:22-alpine3.18
+            node: 22
+            binary: linux-x64-musl-127
+          - os: ubuntu-22.04
+            container: node:24-alpine3.20
+            node: 24
+            binary: linux-x64-musl-137
+
+            # arm64 glibc
+          - os: ubuntu-22.04
+            arch: arm64
+            node: 18
+            binary: linux-arm64-glibc-108
+          - os: ubuntu-22.04
+            arch: arm64
+            node: 20
+            binary: linux-arm64-glibc-115
+          - os: ubuntu-22.04
+            arch: arm64
+            node: 22
+            binary: linux-arm64-glibc-127
+          - os: ubuntu-22.04
+            arch: arm64
+            node: 24
+            binary: linux-arm64-glibc-137
+
+            # arm64 musl
+          - os: ubuntu-22.04
+            arch: arm64
+            container: node:18-alpine3.17
+            node: 18
+            binary: linux-arm64-musl-108
+          - os: ubuntu-22.04
+            arch: arm64
+            container: node:20-alpine3.17
+            node: 20
+            binary: linux-arm64-musl-115
+          - os: ubuntu-22.04
+            arch: arm64
+            container: node:22-alpine3.18
+            node: 22
+            binary: linux-arm64-musl-127
+          - os: ubuntu-22.04
+            arch: arm64
+            container: node:24-alpine3.20
+            node: 24
+            binary: linux-arm64-musl-137
+
+            # macos x64
+          - os: macos-13
+            node: 18
+            arch: x64
+            binary: darwin-x64-108
+          - os: macos-13
+            node: 20
+            arch: x64
+            binary: darwin-x64-115
+          - os: macos-13
+            node: 22
+            arch: x64
+            binary: darwin-x64-127
+          - os: macos-13
+            node: 24
+            arch: x64
+            binary: darwin-x64-137
+
+            # macos arm64
+          - os: macos-13
+            arch: arm64
+            node: 18
+            target_platform: darwin
+            binary: darwin-arm64-108
+          - os: macos-13
+            arch: arm64
+            node: 20
+            target_platform: darwin
+            binary: darwin-arm64-115
+          - os: macos-13
+            arch: arm64
+            node: 22
+            target_platform: darwin
+            binary: darwin-arm64-127
+          - os: macos-13
+            arch: arm64
+            node: 24
+            target_platform: darwin
+            binary: darwin-arm64-137
+
+            # windows x64
+          - os: windows-2022
+            node: 18
+            arch: x64
+            binary: win32-x64-108
+          - os: windows-2022
+            node: 20
+            arch: x64
+            binary: win32-x64-115
+          - os: windows-2022
+            node: 22
+            arch: x64
+            binary: win32-x64-127
+          - os: windows-2022
+            node: 24
+            arch: x64
+            binary: win32-x64-137
+
+    steps:
+      - name: Setup (alpine)
+        if: contains(matrix.container, 'alpine')
+        run: |
+          apk add --no-cache build-base git g++ make curl python3
+          ln -sf python3 /usr/bin/python
+
+      - name: Check out current commit
+        uses: actions/checkout@v4
+
+      # Note: On alpine images, this does nothing
+      # The node version will be the one that is installed in the image
+      # If you want to change the node version, you need to change the image
+      # For non-alpine images, this will install the correct version of node
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        if: contains(matrix.container, 'alpine') == false
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Increase yarn network timeout on Windows
+        if: contains(matrix.os, 'windows')
+        run: yarn config set network-timeout 600000 -g
+
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+
+      - name: Configure safe directory
+        run: |
+          git config --global --add safe.directory "*"
+
+      - name: Setup python
+        uses: actions/setup-python@v5
+        if: ${{ !contains(matrix.container, 'alpine') }}
+        id: python-setup
+        with:
+          python-version: "3.9.13"
+
+      - name: Setup (arm64| ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+        if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          sudo apt-get update
+          sudo apt install -y gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
+
+      - name: Setup Musl
+        if: contains(matrix.container, 'alpine')
+        run: |
+          curl -OL https://musl.cc.timfish.dev/aarch64-linux-musl-cross.tgz
+          tar -xzvf aarch64-linux-musl-cross.tgz
+          $(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc --version
+
+      # configure node-gyp
+      - name: Configure node-gyp
+        if: matrix.arch != 'arm64'
+        run: yarn build:bindings:configure
+
+      - name: Configure node-gyp (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+        if: matrix.arch == 'arm64' && matrix.target_platform != 'darwin'
+        run: yarn build:bindings:configure:arm64
+
+      - name: Configure node-gyp (arm64, darwin)
+        if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin'
+        run: yarn build:bindings:configure:arm64
+
+      # build bindings
+      - name: Build Bindings
+        if: matrix.arch != 'arm64'
+        run: |
+          yarn build:bindings
+
+      - name: Build Bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+        if: matrix.arch == 'arm64' && contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          CC=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc \
+          CXX=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-g++ \
+          BUILD_ARCH=arm64 \
+          yarn build:bindings
+
+      - name: Build Bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }})
+        if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin'
+        run: |
+          CC=aarch64-linux-gnu-gcc \
+          CXX=aarch64-linux-gnu-g++ \
+          BUILD_ARCH=arm64 \
+          yarn build:bindings:arm64
+
+      - name: Build Bindings (arm64, darwin)
+        if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin'
+        run: |
+          BUILD_PLATFORM=darwin \
+          BUILD_ARCH=arm64 \
+          yarn build:bindings:arm64
+
+      - name: Build
+        run: yarn build:lib
+
+      - name: Archive Binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: stack-trace-${{ matrix.binary }}
+          path: ${{ github.workspace }}/lib/stack-trace-${{matrix.binary}}.node
+          if-no-files-found: error
+
+  job_build:
+    name: Build Package
+    needs: [job_compile]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "package.json"
+
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+
+      - name: Build TypeScript
+        run: yarn build:lib
+
+      - name: Extract Prebuilt Binaries
+        uses: actions/download-artifact@v4
+        with:
+          pattern: stack-trace-*
+          path: ${{ github.workspace }}/lib/
+          merge-multiple: true
+
+      - name: Pack tarball
+        run: yarn build:tarball
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.sha }}
+          retention-days: 90
+          path: ${{ github.workspace }}/*.tgz
+
+  job_test_bindings:
+    name: Test (v${{ matrix.node }}) ${{ matrix.os }}
+    needs: [job_build]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+            ubuntu-24.04,
+            ubuntu-22.04,
+            ubuntu-22.04-arm,
+            macos-latest, # macOS arm64
+            macos-13, # macOS x64
+            windows-latest,
+          ]
+        node: [18, 20, 22, 24]
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+      - name: Download Tarball
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ github.sha }}
+      - name: Run tests
+        run: yarn test
+
+  job_required_jobs_passed:
+    name: All required jobs passed
+    needs: [job_lint, job_test_bindings]
+    # Always run this, even if a dependent job failed
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for failures
+        if: contains(needs.*.result, 'failure')
+        run: |
+          echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1

package.json

@@ -21,14 +21,14 @@
     "build:dev": "yarn clean && yarn build:bindings:configure && yarn build",
     "build:tarball": "npm pack",
     "clean": "node-gyp clean && rm -rf lib && rm -rf build",
-    "test": "vitest run --silent=false --disable-console-intercept"
+    "test": "node ./test/prepare.mjs && vitest run --silent=false --disable-console-intercept"
   },
   "volta": {
     "node": "24.1.0"
   },
   "dependencies": {
     "detect-libc": "^2.0.4",
-    "node-abi": "^4.9.0"
+    "node-abi": "^3.73.0"
   },
   "devDependencies": {
     "@sentry-internal/eslint-config-sdk": "^9.22.0",
@@ -49,4 +49,4 @@
     "/scripts/check-build.mjs",
     "/scripts/copy-target.mjs"
   ]
-}
+}