WIP Release automation

.github/workflows/release.yml

@@ -0,0 +1,208 @@
+name: Release NPM Package
+
+on:
+  - push
+# on:
+#   push:
+#     branches:
+#       - main
+#     paths:
+#       - npm/sovra/package.json # Please only commit this file, so we don't need to wait for test CI to pass.
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  check:
+    name: Check version
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ env.version }}
+      version_changed: ${{ steps.version.outputs.changed }}
+    steps:
+      - uses: taiki-e/checkout-action@v1
+
+      - name: Check version changes
+        uses: EndBug/version-check@v2
+        id: version
+        with:
+          static-checking: localIsNew
+          file-url: https://unpkg.com/sovra@latest/package.json
+          file-name: npm/sovra/package.json
+
+      - name: Set version name
+        if: steps.version.outputs.changed == 'true'
+        run: |
+          echo "Version change found! New version: ${{ steps.version.outputs.version }} (${{ steps.version.outputs.version_type }})"
+          echo "version=${{ steps.version.outputs.version }}" >> $GITHUB_ENV
+
+  build:
+    needs: check
+    if: needs.check.outputs.version_changed == 'true'
+    env:
+      version: ${{ needs.check.outputs.version }}
+    outputs:
+      version: ${{ env.version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            code-target: win32-x64-msvc
+
+          - os: windows-latest
+            target: aarch64-pc-windows-msvc
+            code-target: win32-arm64-msvc
+
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            code-target: linux-x64-gnu
+
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            code-target: linux-arm64-gnu
+
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            code-target: linux-x64-musl
+
+          - os: ubuntu-latest
+            target: aarch64-unknown-linux-musl
+            code-target: linux-arm64-musl
+
+          - os: macos-13
+            target: x86_64-apple-darwin
+            code-target: darwin-x64
+
+          - os: macos-14 # M1
+            target: aarch64-apple-darwin
+            code-target: darwin-arm64
+
+    name: Package ${{ matrix.target }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: taiki-e/checkout-action@v1
+
+      ### install musl dependencies ###
+      #
+      - uses: goto-bus-stop/setup-zig@v2
+        if: ${{ contains(matrix.target, 'musl') }}
+        with:
+          version: 0.11.0
+
+      - name: Install cargo-zigbuild
+        if: ${{ contains(matrix.target, 'musl') }}
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-zigbuild
+
+      ### install non-musl dependencies ###
+
+      - name: Install cross
+        if: ${{ !contains(matrix.target, 'musl') }}
+        uses: taiki-e/install-action@cross
+
+      ### Build
+
+      - name: Add Rust Target
+        run: rustup target add ${{ matrix.target }}
+
+      - name: Build with cross
+        if: ${{ !contains(matrix.target, 'musl') }}
+        run: cross build --release -p sovra_napi --target=${{ matrix.target }}
+
+      - name: Build with zig
+        if: ${{ contains(matrix.target, 'musl') }}
+        env:
+          RUSTFLAGS: "-C target-feature=-crt-static"
+        run: cargo zigbuild --release -p sovra_napi --target=${{ matrix.target }}
+
+      ### Build Done
+
+      - name: Move file on ${{ matrix.os }}
+        run: |
+          shopt -s extglob
+          ls target/${{ matrix.target }}/release/*.@(so|dll|dylib)
+          mv target/${{ matrix.target }}/release/*.@(so|dll|dylib) napi/sovra.${{ matrix.code-target }}.node
+          ls napi
+
+      - name: Test
+        working-directory: napi
+        if: ${{ contains(matrix.target, 'x86') && !contains(matrix.target, 'musl') }} # Need docker for aarch64
+        run: node test/sanity.spec.mjs
+
+      # The binary is zipped to fix permission loss https://github.com/actions/upload-artifact#permission-loss
+      - name: Archive Binary
+        if: runner.os == 'Windows'
+        run: 7z a ${{ matrix.code-target }}.zip napi/sovra.${{ matrix.code-target }}.node
+
+      # The binary is zipped to fix permission loss https://github.com/actions/upload-artifact#permission-loss
+      - name: Archive Binary
+        if: runner.os != 'Windows'
+        run: tar czf ${{ matrix.code-target }}.tar.gz napi/sovra.${{ matrix.code-target }}.node
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: binaries-${{ matrix.code-target }}
+          path: |
+            *.zip
+            *.tar.gz
+
+  publish:
+    name: Publish NAPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # for `npm publish --provenance`
+    needs:
+      - build
+    steps:
+      - uses: taiki-e/checkout-action@v1
+
+      # - uses: ./.github/actions/pnpm
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          merge-multiple: true
+
+      - name: Unzip
+        uses: montudor/action-zip@v1
+        with:
+          args: unzip -qq *.zip -d .
+
+      - name: Untar
+        run: ls *.gz | xargs -i tar xvf {}
+
+      - name: Generate npm packages
+        run: |
+          ls
+          ls napi
+          node npm/sovra/scripts/generate-packages.mjs
+          cat npm/sovra/package.json
+          for package in npm/sovra*
+          do
+            ls $package
+            cat $package/package.json
+            echo '----'
+          done
+
+      # - name: Publish npm packages as latest
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      #   # NOTE: The trailing slash on $package/ changes it to publishing the directory
+      #   run: |
+      #     # publish subpackages first
+      #     for package in npm/sovra-*
+      #     do
+      #       pnpm publish $package/ --provenance --access public --tag latest --no-git-checks
+      #     done
+      #     # publish root package last
+      #     pnpm publish npm/sovra/ --provenance --access public --tag latest --no-git-checks

.gitignore

@@ -23,8 +23,9 @@ Cargo.lock
 node_modules
 !/fixtures/modules/node_modules
 
-/npm/*
-!/npm/package.json
+/npm/*/*
+!/npm/sovra/scripts
+!/npm/sovra/package.json
 
 /napi/*
 !/napi/src

npm/sovra/scripts/generate-packages.mjs

@@ -0,0 +1,121 @@
+// Code copied from [Oxc](https://github.com/oxc-project/oxc/blob/main/npm/oxc-parser/scripts/generate-packages.mjs)
+
+import * as fs from "node:fs";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const SOVRA_ROOT = resolve(fileURLToPath(import.meta.url), "../..");
+const PACKAGES_ROOT = resolve(SOVRA_ROOT, "..");
+const BINARY_ROOT = resolve(SOVRA_ROOT, "../../napi");
+const MANIFEST_PATH = resolve(SOVRA_ROOT, "package.json");
+
+console.log("SOVRA_ROOT", SOVRA_ROOT);
+console.log("PACKAGES_ROOT", PACKAGES_ROOT);
+console.log("BINARY_ROOT", BINARY_ROOT);
+console.log("MANIFEST_PATH", MANIFEST_PATH);
+
+const LIBC_MAPPING = {
+  gnu: "glibc",
+  musl: "musl",
+};
+
+const rootManifest = JSON.parse(
+  fs.readFileSync(MANIFEST_PATH).toString("utf-8")
+);
+
+function package_name(target) {
+  return `@sovra/binding-${target}`;
+}
+function generateNativePackage(target) {
+  const binaryName = `sovra.${target}.node`;
+
+  const packageRoot = resolve(PACKAGES_ROOT, `sovra-${target}`);
+  const binarySource = resolve(BINARY_ROOT, binaryName);
+  const binaryTarget = resolve(packageRoot, binaryName);
+
+  // Remove the directory just in case it already exists (it's autogenerated
+  // so there shouldn't be anything important there anyway)
+  fs.rmSync(packageRoot, { recursive: true, force: true });
+
+  // Create the package directory
+  console.log(`Create directory ${packageRoot}`);
+  fs.mkdirSync(packageRoot);
+
+  // Generate the package.json manifest
+  const { version, author, license, homepage, bugs, repository } = rootManifest;
+
+  const triple = target.split("-");
+  const platform = triple[0];
+  const arch = triple[1];
+  const libc = triple[2] &&
+    LIBC_MAPPING[triple[2]] && { libc: [LIBC_MAPPING[triple[2]]] };
+  const manifest = {
+    name: package_name(target),
+    version,
+    main: binaryName,
+    license,
+    author,
+    bugs,
+    homepage,
+    repository,
+    files: [binaryName],
+    cpu: [arch],
+    os: [platform],
+    ...libc,
+  };
+
+  const manifestPath = resolve(packageRoot, "package.json");
+  console.log(`Create manifest ${manifestPath}`);
+  fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
+
+  console.log(`Copy binary ${binaryTarget}`);
+  fs.copyFileSync(binarySource, binaryTarget);
+}
+
+function writeManifest() {
+  const packageRoot = resolve(PACKAGES_ROOT, "sovra");
+  const manifestPath = resolve(packageRoot, "package.json");
+
+  console.log("packageRoot", packageRoot);
+
+  const manifestData = JSON.parse(
+    fs.readFileSync(manifestPath).toString("utf-8")
+  );
+
+  const nativePackages = TARGETS.map((target) => [
+    package_name(target),
+    rootManifest.version,
+  ]);
+
+  manifestData["version"] = rootManifest.version;
+  manifestData["optionalDependencies"] = Object.fromEntries(nativePackages);
+
+  console.log("manifestPath", manifestPath);
+  console.log("manifestData", manifestData);
+
+  const content = JSON.stringify(manifestData, null, 2);
+  fs.writeFileSync(manifestPath, content);
+
+  let files = ["index.js", "index.d.ts"];
+  for (const file of files) {
+    fs.copyFileSync(resolve(BINARY_ROOT, file), resolve(packageRoot, file));
+  }
+}
+
+// NOTE: Must update npm/sovra/package.json
+const TARGETS = [
+  "win32-x64-msvc",
+  "win32-arm64-msvc",
+  "linux-x64-gnu",
+  "linux-arm64-gnu",
+  "linux-x64-musl",
+  "linux-arm64-musl",
+  "darwin-x64",
+  "darwin-arm64",
+];
+
+for (const target of TARGETS) {
+  generateNativePackage(target);
+}
+
+writeManifest();

package.json

@@ -3,8 +3,8 @@
   "private": true,
   "version": "0.0.0",
   "scripts": {
-    "build": "napi build --platform --release --package-json-path npm/package.json --manifest-path napi/Cargo.toml",
-    "build:debug": "napi build --platform --package-json-path npm/package.json --manifest-path napi/Cargo.toml",
+    "build": "napi build --platform --release --package-json-path npm/sovra/package.json --manifest-path napi/Cargo.toml",
+    "build:debug": "napi build --platform --package-json-path npm/sovra/package.json --manifest-path napi/Cargo.toml",
     "prepublishOnly": "napi pre-publish -t npm"
   },
   "devDependencies": {