From 2fb0a74be305d03d076ba5602bbf76d5b8277d87 Mon Sep 17 00:00:00 2001
From: Ryan Mulligan <ryan@ryantm.com>
Date: Sat, 4 Mar 2023 13:06:51 -0800
Subject: [PATCH] doc: try a slightly different format for github action

---
 .github/workflows/doc.yml | 39 ++++++++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 15 deletions(-)

diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
index aeee02c..f1be4b3 100644
--- a/.github/workflows/doc.yml
+++ b/.github/workflows/doc.yml
@@ -1,34 +1,43 @@
-name: doc
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
 
 on:
+  # Runs on pushes targeting the default branch
   push:
-    branches:
-      - main
+    branches: [$default-branch]
+
+  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
 jobs:
-  publish:
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-    concurrency:
-      group: "pages"
-      cancel-in-progress: true
+  # Single deploy job since we're just deploying
+  deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: cachix/install-nix-action@v20
-      - run: nix build .#doc
+      - name: Checkout
+        uses: actions/checkout@v3
       - name: Setup Pages
         uses: actions/configure-pages@v3
+      - uses: cachix/install-nix-action@v20
+      - run: nix build .#doc
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: 'result/multi'
+          path: './result/multi'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1