ci: add docs CI

PostgREST · Dec 19, 2023 · 8e6bfce · 8e6bfce
1 parent b2c855e
commit 8e6bfce
Show file tree

Hide file tree

Showing 7 changed files with 118 additions and 115 deletions.
diff --git a/docs/.github/workflows/ci.yaml → .github/workflows/docs.yaml b/docs/.github/workflows/ci.yaml → .github/workflows/docs.yaml
@@ -1,41 +1,52 @@
-name: CI
+name: Documentation
 
 on:
   push:
     branches:
-    - main
-    - v*
+      - main
+      - rel-*
+    tags:
+      - v[0-9]+.[0-9]+
   pull_request:
     branches:
-    - main
-    - v*
+      - main
+      - rel-*
 
 jobs:
   build:
     name: Build docs
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA build
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-build
 
   spellcheck:
     name: Run spellcheck
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA spellcheck
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-spellcheck
 
   dictcheck:
     name: Run dictcheck
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: cachix/install-nix-action@v24
-      - run: nix-env -f default.nix -iA dictcheck
+      - name: Setup Nix Environment
+        uses: ./.github/actions/setup-nix
+        with:
+          tools: docs
+          cache-id: common
       - run: postgrest-docs-dictcheck
 
   linkcheck:
@@ -44,7 +55,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA linkcheck
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-linkcheck
-
diff --git a/docs/.readthedocs.yaml → .readthedocs.yaml b/docs/.readthedocs.yaml → .readthedocs.yaml
@@ -1,9 +1,9 @@
 version: 2
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/docs/conf.py
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: docs/requirements.txt
 build:
   os: ubuntu-22.04
   tools:

diff --git a/docs/.github/PULL_REQUEST_TEMPLATE.md b/docs/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/docs/.github/dependabot.yml b/docs/.github/dependabot.yml
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md