Merge pull request #151 from vdice/ci/docs

ci(*): automate docs publishing

Author: vdice

.gitattributes

@@ -1,4 +1,3 @@
-docs/** linguist-generated=true
 src/spin_sdk/wit/** linguist-generated=true
 src/componentize_py_* linguist-generated=true
 src/componentize_py_*/** linguist-generated=true

.github/workflows/docs.yml

@@ -0,0 +1,40 @@
+name: Build and Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Parse version
+        id: version
+        run: |
+          if [[ "${{ github.ref_type }}" == "tag" ]]; then
+            # Parse the major version
+            TAG="${{ github.ref_name }}"
+            echo "folder=${TAG%%.*}" >> $GITHUB_OUTPUT
+          else
+            # Default for pushes to main
+            echo "folder=canary" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Generate Documentation
+        run: |
+          pip install pdoc3
+          ./scripts/generate_docs.py ${{ steps.version.outputs.folder }}
+
+      - name: Deploy to versioned folder
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs
+          target-folder: docs
+          clean: false

.gitignore

@@ -7,3 +7,4 @@ __pycache__
 src/spin_sdk.egg-info
 dist
 venv/
+docs

CONTRIBUTING.md

@@ -24,13 +24,7 @@ bash regenerate_bindings.sh
 
 ### Updating docs
 
-Any time you regenerate the bindings or edit files by hand, you'll want to
-regenerate the HTML docs to match.  First, install `pdoc` using `pip install
-pdoc3`.  Then, update the docs using:
-
-```bash
-./scripts/generate_docs.py
-```
+Docs are [updated automatically](.github/workflows/docs.yml) on merges to main and tag pushes.
 
 ### Building the distribution