Rename dispatch-env to publish-env for consistency

dispatch-env and publish-env were the same value under two different
names once the vocabulary was unified - reusable-docs-build.yml's input
and the docs-publish payload were already publish-env/publish_env, so
docs-generate-html.yml's own input was the odd one out.

Author: recrwplay

.github/workflows/docs-generate-html.yml

@@ -15,39 +15,38 @@ on:
         description: 'The git ref to build from'
         type: string
         required: true
-      dispatch-env:
+      publish-env:
         description: 'Override for dev/prod. Leave blank to derive it from build-ref against vars.DOCS_PROD_BRANCH - only needs setting explicitly when DOCS_DEV_BRANCH == DOCS_PROD_BRANCH, where build-ref alone cannot tell the two builds apart.'
         type: string
         required: false
         default: ''
 
 jobs:
 
-  # Resolves dispatch-env (dev/prod) once, so neither docs-build nor publish-html
-  # duplicates the override-or-derive logic. Also reusable-docs-build.yml's publish-env
-  # input, now that both speak the same dev/prod vocabulary.
+  # Resolves publish-env (dev/prod) once, so neither docs-build nor publish-html
+  # duplicates the override-or-derive logic.
   resolve-env:
     name: Resolve environment
     runs-on: ubuntu-latest
     outputs:
-      dispatch-env: ${{ steps.resolve.outputs.dispatch-env }}
+      publish-env: ${{ steps.resolve.outputs.publish-env }}
     steps:
-      - name: Resolve dispatch-env
+      - name: Resolve publish-env
         id: resolve
         env:
-          DISPATCH_ENV_OVERRIDE: ${{ inputs.dispatch-env }}
+          PUBLISH_ENV_OVERRIDE: ${{ inputs.publish-env }}
           BUILD_REF: ${{ inputs.build-ref }}
           PROD_BRANCH: ${{ vars.DOCS_PROD_BRANCH }}
         run: |
-          if [[ -n "${DISPATCH_ENV_OVERRIDE}" ]]; then
-            dispatch_env="${DISPATCH_ENV_OVERRIDE}"
+          if [[ -n "${PUBLISH_ENV_OVERRIDE}" ]]; then
+            publish_env="${PUBLISH_ENV_OVERRIDE}"
           elif [[ "${BUILD_REF}" == "${PROD_BRANCH}" ]]; then
-            dispatch_env="prod"
+            publish_env="prod"
           else
-            dispatch_env="dev"
+            publish_env="dev"
           fi
 
-          echo "dispatch-env=${dispatch_env}" >> $GITHUB_OUTPUT
+          echo "publish-env=${publish_env}" >> $GITHUB_OUTPUT
 
   docs-build:
     name: Generate HTML
@@ -58,7 +57,7 @@ jobs:
       package-script: 'verify:publish'
       build-ref: ${{ inputs.build-ref }}
       fetch-depth: 0
-      publish-env: ${{ needs.resolve-env.outputs.dispatch-env }}
+      publish-env: ${{ needs.resolve-env.outputs.publish-env }}
 
   docs-verify:
     name: Verify HTML
@@ -74,7 +73,7 @@ jobs:
     needs: [docs-verify, resolve-env]
     runs-on: ubuntu-latest
     steps:
-      - name: Publish to ${{ needs.resolve-env.outputs.dispatch-env }}
+      - name: Publish to ${{ needs.resolve-env.outputs.publish-env }}
         uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697 #v4
         with:
           token: ${{ secrets.DOCS_DISPATCH_TOKEN }}
@@ -85,5 +84,5 @@ jobs:
               "org": "${{ github.repository_owner }}",
               "repo": "${{ github.event.repository.name }}",
               "run_id": "${{ github.run_id }}",
-              "publish_env": "${{ needs.resolve-env.outputs.dispatch-env }}"
+              "publish_env": "${{ needs.resolve-env.outputs.publish-env }}"
             }

.github/workflows/docs-publish.yml

@@ -45,11 +45,11 @@ jobs:
     name: Set builds to trigger
     runs-on: ubuntu-latest
     outputs:
-      # JSON array of {buildRef, dispatchEnv} - one entry per independent
-      # docs-generate-html.yml run to trigger. dispatchEnv is left '' except in the one
+      # JSON array of {buildRef, publishEnv} - one entry per independent
+      # docs-generate-html.yml run to trigger. publishEnv is left '' except in the one
       # case where it's genuinely ambiguous (see below) - docs-generate-html.yml derives
-      # both dispatch-env and publish-env itself from build-ref against its own
-      # vars.DOCS_PROD_BRANCH whenever dispatchEnv is blank.
+      # it itself from build-ref against its own vars.DOCS_PROD_BRANCH whenever
+      # publishEnv is blank.
       builds: ${{ steps.set-ref-env.outputs.builds }}
     steps:
       - name: Set builds
@@ -73,19 +73,19 @@ jobs:
           #   know for certain doesn't affect prod.
           if [[ -z "${prod_branch}" ]]; then
             builds=$(jq -nc --arg dev "$dev_branch" \
-              '[{buildRef:$dev,dispatchEnv:""}]')
+              '[{buildRef:$dev,publishEnv:""}]')
           elif [[ "${dev_branch}" == "${prod_branch}" ]]; then
-            # build-ref alone can't distinguish these two - same branch - so dispatchEnv
+            # build-ref alone can't distinguish these two - same branch - so publishEnv
             # has to be passed explicitly here, or docs-generate-html.yml's derivation
             # would resolve both to the same environment.
             builds=$(jq -nc --arg b "$dev_branch" \
-              '[{buildRef:$b,dispatchEnv:"dev"},{buildRef:$b,dispatchEnv:"prod"}]')
+              '[{buildRef:$b,publishEnv:"dev"},{buildRef:$b,publishEnv:"prod"}]')
           elif [[ "${GITHUB_REF}" == "refs/heads/${dev_branch}" ]]; then
             builds=$(jq -nc --arg dev "$dev_branch" \
-              '[{buildRef:$dev,dispatchEnv:""}]')
+              '[{buildRef:$dev,publishEnv:""}]')
           else
             builds=$(jq -nc --arg dev "$dev_branch" --arg prod "$prod_branch" \
-              '[{buildRef:$dev,dispatchEnv:""},{buildRef:$prod,dispatchEnv:""}]')
+              '[{buildRef:$dev,publishEnv:""},{buildRef:$prod,publishEnv:""}]')
           fi
 
           echo "builds=${builds}" >> $GITHUB_OUTPUT
@@ -116,7 +116,7 @@ jobs:
                 ref: process.env.DISPATCH_REF,
                 inputs: {
                   'build-ref': build.buildRef,
-                  'dispatch-env': build.dispatchEnv,
+                  'publish-env': build.publishEnv,
                 },
               })
             }