docs: publish HTML documentation to Github Pages

Signed-off-by: VirtualTam <[email protected]>

.github/workflows/ci.yaml

@@ -24,20 +24,6 @@ jobs:
       - name: Build
         run: make build
 
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - uses: jontze/action-mdbook@v3
-        with:
-          mdbook-version: "~0.4.36"
-          token: ${{secrets.GITHUB_TOKEN}}
-
-      - name: Generate documentation
-        run: make docs
-
   lint:
     runs-on: ubuntu-latest
     steps:

.github/workflows/docs.yaml

@@ -0,0 +1,49 @@
+---
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  pull_request: {}
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: jontze/action-mdbook@v3
+        with:
+          mdbook-version: "~0.4.36"
+          token: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Generate documentation
+        run: make docs
+
+      - name: Upload documentation as an artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/book'
+
+  gh-pages:
+    if: github.ref == 'refs/heads/main'
+    needs: docs
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

docs/src/changelog.md

@@ -15,6 +15,7 @@ project adheres to [Semantic Versioning](https://semver.org/).
 ### Changed
 ### CI
 - Lint and format SQL files with SQLFluff
+- Publish HTML documentation to Github Pages
 
 #### www
 - Update the home page