@automattic/yara 2.5.0 → 2.6.0-beta.1

package/.github/workflows/build.yml

@@ -7,6 +7,10 @@ on:
     branches: [ master ]
   pull_request:
 
+  # we're going to build and commit fresh binaries when a new release is published
+  release:
+    types: [created]
+
 # allow these jobs to commit to the repository
 permissions:
   contents: write
@@ -19,27 +23,41 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-#        - '14'
         - '16'
-#        - '18'
+        - '18'
+        - '20'
 
     runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v3
 
+    # https://github.com/actions/setup-node
+    - name: Install Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@master
+      with:
+        node-version: ${{ matrix.node-version }}
+
     - name: Build binaries inside the container
       run: |
         set -x
-        
+        node -v
+
         # what's the package version?
         # e.g.  Binary staged at "build/stage/Automattic/node-yara/raw/master/binaries/yara-v2.5.0-linux-x64.tar.gz"
         export PACKAGE_VERSION=$(jq -r .version package.json)
 
-        # build inside the container and copy the package to the host
-        docker build -t yara/debian .
+        # what's the Node.js version?
+        export ABI=$(node --eval 'console.log(process.versions.modules)')
+
+        echo "::notice::Building binary for node-yara package v${PACKAGE_VERSION} for Node.js $(node -v) (ABI ${ABI}) ..."
+
+        # build inside the container (pass the required Node.js version there) and copy the package to the host
+        docker build --build-arg NODEJS=${{ matrix.node-version }} -t yara/debian .
         docker images
-        docker run --rm --volume /tmp:/tmp yara/debian cp ./binaries/yara-v${PACKAGE_VERSION}-linux-x64.tar.gz /tmp
+
+        # e.g. yara-v2.5.0-linux-x64-node-v93.tar.gz
+        docker run --rm --volume /tmp:/tmp yara/debian cp ./binaries/yara-v${PACKAGE_VERSION}-linux-x64-node-v${ABI}.tar.gz /tmp
         ls -lh /tmp/yara-v${PACKAGE_VERSION}-*
 
         # copy it to the repository clone and see if there's a difference
@@ -50,7 +68,8 @@ jobs:
     # and co-authored by the user that made the last commit.
     # https://github.com/marketplace/actions/git-auto-commit
     - name: Commit the changes to the binary files
-      if: false  # node-gyp builds are not reproducible, hence each build would create a "new" commit -> disabling for now (comment out this line if needed)
+      # if: true  # node-gyp builds are not reproducible, hence each build would create a "new" commit -> disabling for now (comment out this line if needed)
+      if: github.event_name == 'release' && github.event.action == 'created'  # commit new binaries package on releases
       uses: stefanzweifel/git-auto-commit-action@v4
       with:
         ref: ${{ github.head_ref }}  # https://github.com/marketplace/actions/git-auto-commit#checkout-the-correct-branch
@@ -63,9 +82,9 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-#        - '14'
         - '16'
-#        - '18'
+        - '18'
+        - '20'
 
     runs-on: macos-12
 
@@ -83,6 +102,15 @@ jobs:
     - name: Build binaries with node-pre-gyp
       run: |
         set -x
+
+        # what's the package version?
+        # e.g.  Binary staged at "build/stage/Automattic/node-yara/raw/master/binaries/yara-v2.5.0-linux-x64.tar.gz"
+        export PACKAGE_VERSION=$(jq -r .version package.json)
+
+        # what's the Node.js version?
+        export ABI=$(node --eval 'console.log(process.versions.modules)')
+        echo "::notice::Building binary for node-yara package v${PACKAGE_VERSION} for Node.js $(node -v) (ABI ${ABI}) ..."
+
         npm install --ignore-scripts
         time -p npx node-pre-gyp configure rebuild
 
@@ -96,11 +124,14 @@ jobs:
     - name: Run tests
       run: npm test
 
+    # TODO: publish as the release artifacts
+    #
     # By default, the commit is made in the name of "GitHub Actions"
     # and co-authored by the user that made the last commit.
     # https://github.com/marketplace/actions/git-auto-commit
     - name: Commit the changes to the binary files
-      if: false  # node-gyp builds are not reproducible, hence each build would create a "new" commit -> disabling for now (comment out this line if needed)
+      # if: true  # node-gyp builds are not reproducible, hence each build would create a "new" commit -> disabling for now (comment out this line if needed)
+      if: github.event_name == 'release' && github.event.action == 'created'  # commit new binaries package on releases
       uses: stefanzweifel/git-auto-commit-action@v4
       with:
         ref: ${{ github.head_ref }}  # https://github.com/marketplace/actions/git-auto-commit#checkout-the-correct-branch

package/Dockerfile

@@ -1,5 +1,6 @@
 # this container is used to build binaries for Debian 10 (aka oldstable)
-FROM node:16.16-buster-slim
+ARG NODEJS=16.16
+FROM node:$NODEJS-buster-slim
 
 RUN apt-get update -y && \
 	apt-get install -y \

package/binding.gyp

@@ -4,10 +4,13 @@
       "target_name": "action_before_build",
       "type": "none",
       "copies": [],
+      "variables": {
+        'architecture': '<!(uname -m)'
+      },
       "conditions": [
         ['OS == "linux"', {
           "copies": [{
-            "files": [ "/usr/lib/x86_64-linux-gnu/libmagic.a" ],
+            "files": [ "/usr/lib/<(architecture)-linux-gnu/libmagic.a" ],
             "destination": "build/"
           }],
         }],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@automattic/yara",
-  "version": "2.5.0",
-  "description": "Automattic's fork of YARA support for Node.js",
+  "version": "2.6.0-beta.1",
+  "description": "Automattic's fork of YARA support for Node.js with pre-built binaries",
   "main": "index.js",
   "directories": {
     "example": "example"
@@ -9,7 +9,7 @@
   "dependencies": {
     "@mapbox/node-pre-gyp": "^1.0.10",
     "nan": "2.17.*",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.3"
   },
   "scripts": {
     "test": "mocha test/*",
@@ -20,7 +20,7 @@
     "module_path": "./build/Release",
     "host": "https://github.com/",
     "remote_path": "/Automattic/node-yara/raw/master/binaries/",
-    "package_name": "{module_name}-v{version}-{platform}-{arch}.tar.gz"
+    "package_name": "{module_name}-v{version}-{platform}-{arch}-{node_abi}.tar.gz"
   },
   "contributors": [
     {