ci: build and deploy docs to gh-pages on release (#1374)

Author: developerkunal

.github/actions/deploy-docs/action.yml

@@ -0,0 +1,35 @@
+name: Deploy documentation to GitHub Pages
+
+inputs:
+    node-version:
+        required: true
+    token:
+        required: true
+
+runs:
+    using: composite
+
+    steps:
+        - name: Checkout code
+          uses: actions/checkout@v4
+
+        - name: Setup Node
+          uses: actions/setup-node@v4
+          with:
+              node-version: ${{ inputs.node-version }}
+              cache: "yarn"
+
+        - name: Install dependencies
+          shell: bash
+          run: yarn install --frozen-lockfile
+
+        - name: Build documentation
+          shell: bash
+          run: yarn docs:build
+
+        - name: Deploy to GitHub Pages
+          uses: peaceiris/actions-gh-pages@v4
+          with:
+              github_token: ${{ inputs.token }}
+              publish_dir: ./docs
+              publish_branch: gh-pages

.github/workflows/release.yml

@@ -22,3 +22,18 @@ jobs:
             require-build: true
         secrets:
             github-token: ${{ secrets.GITHUB_TOKEN }}
+
+    deploy-docs:
+        name: Deploy Documentation
+        needs: release
+        if: github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged && startsWith(github.event.pull_request.head.ref, 'release/'))
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@v4
+
+            - uses: ./.github/actions/deploy-docs
+              with:
+                  node-version: 22.23.1
+                  token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 .DS_Store
 /dist
+/docs
 /coverage
 *.lcov