Generate JSON Schema & push to GH Pages

Author: pinkwah

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.11"
+    - name: Install dependencies
+      run: |
+        pip install uv
+        uv sync
+
+    - name: Build schema
+      run: |
+        mkdir dist
+        uv run deploy schema -o dist/schema.json
+
+    - name: Upload static files as artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: dist/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+
+    permissions:
+      id-token: write
+      pages: write
+
+    steps:
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

src/deploy/cli.py

@@ -3,6 +3,7 @@
 import click
 
 from deploy.commands.build import subcommand_build
+from deploy.commands.schema import subcommand_schema
 from deploy.commands.sync import subcommand_sync
 from deploy.commands.test import subcommand_test
 
@@ -13,6 +14,7 @@ def cli() -> None:
 
 
 cli.add_command(subcommand_build)
+cli.add_command(subcommand_schema)
 cli.add_command(subcommand_sync)
 cli.add_command(subcommand_test)
 

src/deploy/commands/schema.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+from pathlib import Path
+
+import click
+import json
+from deploy.config import Config
+
+
+@click.command("schema", help="Generate JSON Schema")
+@click.option("-o", "--output", default="/dev/stdout", type=Path, help="Output file")
+def subcommand_schema(output: Path) -> None:
+    with open(output, "w") as f:
+        json.dump(Config.model_json_schema(), f)
+        f.write("\n")