From f47b7cd9c4ec3352fee0fb2778d8a77e6787f9a6 Mon Sep 17 00:00:00 2001
From: James Munro <jamesjulianmunro@gmail.com>
Date: Sat, 4 Nov 2023 13:54:16 +0000
Subject: [PATCH] Docs workflow fixes.  (#1030)

- add write permission
- use tag name (v prefix)
- require environment.
- fetch docs-pages branch
- explicitly set branch for mike
---
 .github/workflows/docs_build.yml   | 12 +++++++++---
 .github/workflows/docs_publish.yml |  3 ++-
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml
index bc464e3c69..c154a8781a 100644
--- a/.github/workflows/docs_build.yml
+++ b/.github/workflows/docs_build.yml
@@ -9,11 +9,17 @@ on:
 jobs:
   docs_build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
-          ref: ${{inputs.version || 'master'}}
+          ref: ${{inputs.version && format('v{0}', inputs.version) || 'master'}}
+
+      - name: Fetch docs-pages branch
+        if: ${{inputs.deploy}}
+        run: git fetch origin docs-pages --depth=1
 
       - name: Detect runner Python implementation
         if: ${{!inputs.version}}
@@ -60,8 +66,8 @@ jobs:
           git config --global user.name "${GITHUB_ACTOR}"
           git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
           git_hash=$(git rev-parse --short HEAD)
-          mike deploy ${{inputs.version || 'dev'}} ${{inputs.latest && 'latest' || ''}} --update-aliases ${{inputs.deploy && '--push' || ''}} --message "Deploying docs: ${{inputs.version || 'dev'}} $git_hash ${{inputs.latest && '[latest]' || ''}}"
-          mike set-default latest
+          mike deploy ${{inputs.version || 'dev'}} ${{inputs.latest && 'latest' || ''}} --update-aliases --branch docs-pages ${{inputs.deploy && '--push' || ''}} --message "Deploying docs: ${{inputs.version || 'dev'}} $git_hash ${{inputs.latest && '[latest]' || ''}}"
+          mike set-default latest --branch docs-pages ${{inputs.deploy && '--push' || ''}}
 
       - name: List docs versions after deploy
         run: |
diff --git a/.github/workflows/docs_publish.yml b/.github/workflows/docs_publish.yml
index 4f7542ce71..0de3cc86d6 100644
--- a/.github/workflows/docs_publish.yml
+++ b/.github/workflows/docs_publish.yml
@@ -2,7 +2,7 @@ name: Docs Publish
 on:
   workflow_dispatch:
     inputs:
-      environment: { type: environment, required: false }
+      environment: { type: environment, required: true }
 jobs:
   docs_publish:
     runs-on: ubuntu-latest
@@ -20,4 +20,5 @@ jobs:
           apiToken: ${{secrets.CLOUDFLARE_API_TOKEN}}
           accountId: ${{vars.CLOUDFLARE_ACCOUNT_ID}}
           projectName: ${{vars.CLOUDFLARE_PAGES_PROJECT}}
+          directory: .
           branch: ${{vars.CLOUDFLARE_PAGE_BRANCH}}