Re-enable docs auto-deployment on main (#1317)

Also add a trigger for docs paths/files Fixes #1316
TraceMachina · Sep 4, 2024 · ca88d90 · ca88d90
1 parent ef3a8a6
commit ca88d90
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 6 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -3,8 +3,22 @@ name: Deploy NativeLink Docs
 on:
   push:
     branches: [main]
+    paths:
+      - 'docs/**'
+      - '**/*.md'
+      - 'nativelink-config/**'
+      - 'tools/**'
+      - '**/*.lock'
+      - '**/*.nix'
   pull_request:
     branches: [main]
+    paths:
+      - 'docs/**'
+      - '**/*.md'
+      - 'nativelink-config/**'
+      - 'tools/**'
+      - '**/*.lock'
+      - '**/*.nix'
 
 permissions: read-all
 
@@ -14,9 +28,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-24.04, macos-14 ]
+
     name: Docs Deployment / ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
+    permissions:
+      id-token: write
+      contents: read
+
     steps:
       - name: Checkout
         uses: >- # v4.1.1
@@ -30,23 +49,22 @@ jobs:
         uses: >- # v4
           DeterminateSystems/magic-nix-cache-action@fc6aaceb40b9845a02b91e059ec147e78d1b4e41
 
-      - name: Test deployment on Ubuntu
+      - name: Test Build on Ubuntu
         if: matrix.os == 'ubuntu-24.04' && github.event_name == 'pull_request'
         working-directory: docs
         run: |
           nix develop --impure --command bash -c "
-            bun staging --project=nativelink-docs --org=nativelink
+            bun setup && bun docs && bun run build
           "
 
-      - name: Test deployment on macOS
+      - name: Test Build on macOS
         if: matrix.os == 'macos-14' && github.event_name == 'pull_request'
         working-directory: docs
         run: |
           nix develop --impure --command bash -c "bun setup && bun run build"
 
-
       - name: Production deployment
-        if: matrix.os == 'ubuntu-22.04' && github.ref == 'refs/heads/main'
+        if: matrix.os == 'ubuntu-24.04' && github.ref == 'refs/heads/main'
         working-directory: docs
         run: |
           nix develop --impure --command bash -c "

diff --git a/docs/README.md b/docs/README.md
@@ -29,7 +29,7 @@ This project requires `bun`. The nix flake ships a compatible version.
 # Install dependencies with bun.
 bun install
 
-# Rebuild the docs reference.
+# Rebuild the docs reference. (Note MacOS: Use Bun & Bazel from Host)
 bun run docs.build
 
 # Generate the simple parts of the autogenerated docs.