Add GitHub action for header-gen build & publish (#6)

* Fix paths in package.json

* Add GitHub action for build workflow

This will publish the ml-header-generator package.

* Add cache dependency path

The setup-node action expects this to be at the root.

* Re-run action if build.yml is modified

* Use non-action package-versioner

This may fail if this repo doesn't have permissions to use this package

* Try using updated GHA to change version

* Actually set working-directory

* Remove old way

* Working dir change has now been released as 1.1.0

* Review feedback and merge into header-gen.yml

* Add permissions

* Don't update version on PR

* Only publish on GH release

Co-authored-by: Carlos Pereira Atencio <[email protected]>

---------

Co-authored-by: Matt Hillsdon <[email protected]>
Co-authored-by: Carlos Pereira Atencio <[email protected]>

Author: 3 people

.github/workflows/header-gen.yml

@@ -1,15 +1,26 @@
 name: Header Generator Tests
 
 on:
+  release:
+    types: [created]
   push:
     branches: '*'
+    paths:
+    - "header-gen/**"
+    - "**/header-gen.yml"
   pull_request:
     branches: '*'
+    paths:
+    - "header-gen/**"
+    - "**/header-gen.yml"
 
 jobs:
   build-and-test:
     name: Build & Test TS lib
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
 
     steps:
     - uses: actions/checkout@v4
@@ -18,15 +29,30 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20'
+        registry-url: "https://npm.pkg.github.com"
+        cache: npm
+        cache-dependency-path: header-gen/package-lock.json
 
     - name: Install Dependencies
       run: npm ci
       working-directory: ./header-gen
 
+    - name: Update version
+      if: github.event_name != 'pull_request'
+      uses: microbit-foundation/npm-package-versioner-action@v1
+      with:
+        working-directory: ./header-gen
+
     - name: Build
       run: npm run build
       working-directory: ./header-gen
 
     - name: Run Jest Tests
       run: npm test
       working-directory: ./header-gen
+
+    - name: Publish
+      run: npm publish
+      if: github.event_name == 'release' && github.event.action == 'created'
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

header-gen/.npmrc

@@ -0,0 +1 @@
+@microbit-foundation:registry=https://npm.pkg.github.com/microbit-foundation

header-gen/package.json

@@ -4,11 +4,11 @@
   "description": "A simple TS script to generate a header blob for the ML runner",
   "author": "Micro:bit Educational Foundation <[email protected]>",
   "license": "MIT",
-  "module": "./dist/main.js",
-  "typings": "./dist/main.d.ts",
+  "module": "./built/main.js",
+  "typings": "./built/main.d.ts",
   "files": [
-    "./dist/*.js",
-    "./dist/*.d.ts"
+    "./built/*.js",
+    "./built/*.d.ts"
   ],
   "scripts": {
     "start": "ts-node --project tsconfig.cli.json src/cli.ts",