chore: Publish typedoc on gh pages #1143

.github/workflows/typedoc.yaml

@@ -0,0 +1,38 @@
+name: Publish typedoc on Github Pages
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - name: Generate docs
+        run: |
+          npm ci
+          npm run typedoc
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          # typedoc "out" path
+          path: ./typedoc
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,6 +3,7 @@ coverage/
 dist/
 .idea
 temp/
+typedoc/
 .remote-sync.json
 tsconfig.tsbuildinfo
 

package.json

@@ -87,7 +87,7 @@
         "eslint": "eslint . --ext .ts --max-warnings=0",
         "pretty:write": "prettier --write .",
         "pretty:check": "prettier --check .",
-        "docs": "typedoc --tsconfig typedoc-tsconfig.json",
+        "typedoc": "typedoc --gitRevision $(git describe --tag --abbrev=0) --tsconfig tsconfig.json --excludePrivate --excludeProtected --excludeExternals --entryPointStrategy expand ./src --sourceLinkTemplate 'https://github.com/Koenkk/zigbee-herdsman/blob/{gitRevision}/{path}#L{line}' -out typedoc",
         "clean": "rimraf temp coverage dist",
         "prepack": "npm run clean && npm run build"
     },