ci(publish): add GitHub package publication workflow

Author: brandonbothell

.github/workflows/publish-github.yml

@@ -0,0 +1,26 @@
+name: Publish GitHub Package
+
+on:
+  release:
+    types: [released]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish-github:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        ref: 'release'
+    - uses: actions/setup-node@v6
+      with:
+        node-version: '23.x'
+    - name: Build and Publish Package
+      uses: borales/actions-yarn@v5
+      with:
+        cmd: run publish:github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -39,6 +39,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v6
+      with:
+          ref: 'release'
     - uses: actions/setup-node@v6
       with:
         node-version: '23.x'

package.json

@@ -31,7 +31,9 @@
     "docs:test": "yarn workspace docusaurus start",
     "lint": "eslint .",
     "build": "rimraf -- ./out/ ./typings/ && tsc --project tsconfig.build.json && ts-node ./scripts/release-prep.ts",
-    "publish": "yarn build && cd out && npm login && npm publish"
+    "build:github": "rimraf -- ./out/ ./typings/ && tsc --project tsconfig.build.json && ts-node ./scripts/release-prep-github.ts",
+    "publish": "yarn build && cd out && npm login && npm publish",
+    "publish:github": "yarn build:github && cd out && npm publish"
   },
   "nyc": {
     "include": "src"

scripts/release-prep-github.ts

@@ -0,0 +1,27 @@
+import fs from 'fs'
+
+// This file is used by build system to build a clean npm package with the compiled js files in the root of the package.
+// It will not be included in the npm package.
+
+const source = fs.readFileSync(__dirname + '/../package.json').toString('utf-8')
+const sourceObj = JSON.parse(source)
+
+sourceObj.scripts = {}
+delete sourceObj.nyc
+delete sourceObj.workspaces
+delete sourceObj.resolutions
+delete sourceObj.engines
+delete sourceObj.packageManager
+
+sourceObj.main = 'index.js'
+sourceObj.types = 'declarations/index.d.ts'
+
+fs.writeFileSync(__dirname + '/../out/package.json', Buffer.from(JSON.stringify(sourceObj, null, 2), 'utf-8'))
+fs.writeFileSync(__dirname + '/../out/version.txt', Buffer.from(sourceObj.version, 'utf-8'))
+fs.writeFileSync(__dirname + '/../out/.npmrc', Buffer.from('//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}\n', 'utf-8')) // uses an environment variable
+
+fs.cpSync(__dirname + '/../typings', __dirname + '/../out/declarations', { recursive: true })
+fs.copyFileSync(__dirname + '/../LICENSE', __dirname + '/../out/LICENSE')
+fs.copyFileSync(__dirname + '/../README.md', __dirname + '/../out/README.md')
+fs.copyFileSync(__dirname + '/../SECURITY.md', __dirname + '/../out/SECURITY.md')
+fs.copyFileSync(__dirname + '/../CHANGELOG.md', __dirname + '/../out/CHANGELOG.md')