Build npm package in CI

Author: cknitt

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ on:
     branches: [master]
 
 jobs:
-  test:
+  build:
     strategy:
       fail-fast: false
       matrix:
@@ -48,7 +48,7 @@ jobs:
           opam-depext: false
 
       - name: Use Node.js
-        uses: actions/setup-node@v2.1.5
+        uses: actions/setup-node@v3
         with:
           node-version: 16
 
@@ -57,17 +57,6 @@ jobs:
         env:
           RESCRIPT_FORCE_REBUILD: 1
 
-      - name: ninja config
-        if: runner.os != 'Windows'
-        run: opam exec -- node ./scripts/ninja.js config
-
-      - name: ninja build
-        if: runner.os != 'Windows'
-        run: opam exec -- node ./scripts/ninja.js build
-
-      - name: Check for changes in lib folder
-        run: git diff --exit-code lib/js lib/es6
-
       - name: Run tests
         if: runner.os != 'Windows'
         run: opam exec -- node scripts/ciTest.js -all
@@ -80,8 +69,73 @@ jobs:
         id: get_artifact_info
         run: node .github/workflows/get_artifact_info.js
 
-      - name: Upload artifacts
+      - name: "Upload artifacts: binaries"
         uses: actions/upload-artifact@v3
         with:
           name: ${{ steps.get_artifact_info.outputs.artifact_name }}
           path: ${{ steps.get_artifact_info.outputs.artifact_path }}
+
+      - name: "Upload artifacts: lib/ocaml"
+        if: runner.os == 'Linux'
+        uses: actions/upload-artifact@v3
+        with:
+          name: lib-ocaml
+          path: lib/ocaml
+
+      # Important: the ninja build must run after the artifact upload because for some reason
+      # the bsc.exe created by the ninja build does not find the Pervasives module.
+      # So this is run here just to test the normal dev workflow, too.
+      - name: ninja config
+        if: runner.os != 'Windows'
+        run: opam exec -- node ./scripts/ninja.js config
+
+      - name: ninja build
+        if: runner.os != 'Windows'
+        run: opam exec -- node ./scripts/ninja.js build
+
+      - name: Check for changes in lib folder
+        run: git diff --exit-code lib/js lib/es6
+
+  package:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: NPM install
+        run: npm ci --ignore-scripts
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+
+      - name: Copy artifacts
+        run: ./scripts/moveArtifacts.sh
+
+      - name: Create ninja.tar.gz
+        run: git -C ninja archive --format=tar.gz HEAD -o ../vendor/ninja.tar.gz
+
+      - name: Run prepublish.js
+        run: node ./scripts/prepublish.js -nocheck
+
+      - name: npm pack
+        run: npm pack
+
+      - name: Get package info
+        id: get_package_info
+        # For pull requests, pass the correct commit SHA explicitly as GITHUB_SHA points to the wrong commit.
+        run: node .github/workflows/get_package_info.js ${{ github.event.pull_request.head.sha }}
+
+      - name: "Upload artifact: npm package tarball"
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.get_package_info.outputs.artifact_name }}
+          path: ${{ steps.get_package_info.outputs.artifact_path }}

.github/workflows/get_package_info.js

@@ -0,0 +1,16 @@
+const fs = require("fs");
+
+const packageSpec = JSON.parse(fs.readFileSync("./package.json", "utf8"));
+const { name, version } = packageSpec;
+
+const commitHash = process.argv[2] || process.env.GITHUB_SHA;
+const commitHashShort = commitHash.substring(0, 7);
+
+const packageName = `${name}-${version}.tgz`;
+const artifactName = `${name}-${version}-${commitHashShort}.tgz`;
+
+fs.renameSync(packageName, artifactName);
+
+// Pass artifactPath and artifactName to subsequent GitHub actions
+console.log(`::set-output name=artifact_path::${artifactName}`);
+console.log(`::set-output name=artifact_name::${artifactName}`);

.npmignore

@@ -47,6 +47,7 @@ ocaml-tree
 dummy.opam
 dune
 dune-project
+scripts/moveArtifacts.sh
 scripts/deps.js
 scripts/format.js
 scripts/local_br_clean.sh

jscomp/artifacts.json

@@ -45,9 +45,7 @@
   ],
   "lib": [
     "bstracing",
-    "build.ninja",
-    "minisocket.js",
-    "prebuilt.ninja"
+    "minisocket.js"
   ],
   "lib/4.06.1": [
     "bsb_helper.ml",

scripts/moveArtifacts.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+chmod +x binaries-*/*.exe
+
+mv binaries-darwin/* darwin
+mv binaries-darwinarm64/* darwinarm64
+mv binaries-linux/* linux
+mv binaries-win32/* win32
+
+rmdir binaries-*
+
+mv lib-ocaml lib/ocaml

scripts/prepublish.js

@@ -103,11 +103,11 @@ if (!process.argv.includes("-nocheck")) {
   check(map);
 }
 
-var output = p.spawnSync(`git diff jscomp/artifacts.json`, {
+var output = p.spawnSync(`git diff --exit-code jscomp/artifacts.json`, {
   cwd: root,
   encoding: "utf8",
   shell: true,
 });
 
-assert(output.status === 0);
 console.log("The diff of artifacts", output.stdout);
+assert(output.status === 0);