Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/workflows/generate-swift-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Generate Swift Docs

on:
push:
branches: [main]
paths:
- "Sources/**"
- "Package.swift"
- "scripts/swift-docs/**"
- ".github/workflows/generate-swift-docs.yml"
schedule:
- cron: "0 3 * * *"
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
name: Generate TypeDoc JSON
runs-on: macos-15
steps:
- name: Checkout supabase-swift
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false

- name: Setup Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: "22"

- name: Install swift-docs dependencies
run: npm ci
working-directory: scripts/swift-docs

- name: Generate TypeDoc JSON
run: |
npx tsx src/index.ts \
../../ \
spec.json \
supabase-swift-categories.json
working-directory: scripts/swift-docs

- name: Prepare Pages artifact
run: |
mkdir -p site/v2
cp scripts/swift-docs/spec.json site/v2/spec.json

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site/

deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
1 change: 1 addition & 0 deletions scripts/swift-docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
Loading
Loading