docs: versioned TypeDoc

.github/workflows/typedoc.yml

@@ -1,50 +1,84 @@
 name: Publish TypeDoc
 on:
-  push:
-    branches:
-      - master
+  workflow_dispatch:
+  workflow_call:
+permissions:
+  contents: write # allows the 'Commit' step without tokens
 
 jobs:
-  build-docs:
+  get_history: # create an artifact from the existing documentation builds
     runs-on: ubuntu-latest
-    steps: 
-      - name: Checkout repository
+    steps:
+      - name: get the typedoc repo
         uses: actions/checkout@v4
         with:
-          persist-credentials: false
+            ref: typedoc
 
-      - name: Setup node
-        uses: actions/setup-node@v4
+      - name: tar the existing docs
+        run: |
+            mkdir -p ./docs
+            tar -cvf documentation.tar ./docs
+
+      - name: create a document artifact
+        uses: actions/upload-artifact@v4
         with:
-          node-version: latest
-          cache: npm
-          cache-dependency-path: package-lock.json
+            name: documentation
+            path: documentation.tar
 
-      - name: Install deps
-        run: npm i
+  build: # builds the distribution and then the documentation
+    needs: get_history
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout src
+        uses: actions/checkout@v4
 
-      - name: Build docs
-        run: npm run build:docs
+      - run: mkdir -p ./docs
+      - name: Download the existing documents artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: documentation
+      - run: tar -xf documentation.tar ./docs -C ./docs
 
-      - name: Upload pages artifact
-        uses: actions/upload-pages-artifact@v3
+      - name: Build
+        uses: actions/setup-node@v4
         with:
-          path: docs/
+          node-version: lts/*
+          cache: npm
+      - run: npm i
+      - run: npm run build # set up 'build' script in your package.json
 
-  deploy-docs:
-    needs: build-docs
+      - name: Build documents
+        run: npm run build:docs #set up 'build:docs' build script in your package.json
 
-    permissions:
-      id-token: write
-      pages: write
+      - name: tar the new docs
+        run: tar -cvf newdocumentation.tar ./docs
 
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      - name: create a new document artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: newdocumentation
+          path: newdocumentation.tar
 
+  commit: # commit the old and new merged documents to typedoc/docs
+    needs: build
     runs-on: ubuntu-latest
     steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
-
+      - name: checkout the typedoc repo
+        uses: actions/checkout@v4
+        with:
+          ref: typedoc
+
+      - run: mkdir -p ./docs
+      - name: Download the new documents artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: newdocumentation
+      - run: tar -xf newdocumentation.tar ./docs -C ./docs
+
+      - name: commit
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Actions"
+          git add .
+          git commit -m "Updated the docs"
+          git push

.gitignore

@@ -3,6 +3,8 @@
 .DS_Store
 node_modules/
 dist/
+docs/
+package-lock.json
 pnpm-lock.yaml
 yarn.lock
 yarn-debug.log*