docs: generate reference API site and publish to GitHub Pages on publish

Author: mikehardy

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       id-token: write # enables OIDC for npmjs.com "Trusted Publisher" and provenance
-      contents: read
+      contents: write # push API reference to gh-pages (docs/)
     steps:
       - uses: actions/checkout@v6
         with:
@@ -64,3 +64,15 @@ jobs:
           # org admin Github Token required for the changelog/tag commit+push
           # to work via an exception to branch protection rules
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Build API reference (TypeDoc)
+        run: yarn reference:api:gh-pages
+      - name: Publish API reference to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GH_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./apidocs-out
+          destination_dir: docs
+          user_name: 'Invertase Publisher'
+          user_email: 'oss@invertase.io'
+          commit_message: 'docs: update TypeDoc API reference'

.gitignore

@@ -539,6 +539,7 @@ packages/**/version.js
 packages/**/version.ts
 typedoc.raw.json
 reference/
+apidocs-out/
 tests/ios/Firebase
 tests/ios/resetXcode.sh
 .tmp