docs_preview_build_cf.yaml

# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


name: "CF: Build Docs Preview"

on:
  pull_request:
    types: [opened, synchronize, reopened, labeled]
    paths:
      - 'docs/**'
      - '.github/workflows/docs*_cf.yaml'
      - '.hugo/**'

permissions: read-all

jobs:
  build-preview:
    if: "contains(github.event.pull_request.labels.*.name, 'docs: deploy-preview')"
    runs-on: ubuntu-24.04
    env:
      PR_NUMBER: ${{ github.event.number }}
      HEAD_SHA: ${{ github.event.pull_request.head.sha }}
    concurrency:
      group: "cf-preview-${{ github.event.number }}"
      cancel-in-progress: true
    defaults:
      run:
        working-directory: .hugo
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          ref: ${{ env.HEAD_SHA }}
          fetch-depth: 0

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3
        with:
          hugo-version: "0.145.0"
          extended: true

      - name: Setup Node
        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
        with:
          node-version: "22"
          cache: 'npm'
          cache-dependency-path: '.hugo/package-lock.json'

      - run: npm ci --ignore-scripts
      - run: hugo --minify --config hugo.cloudflare.toml
        env:
          HUGO_BASEURL: "/"
          HUGO_ENVIRONMENT: preview
          HUGO_RELATIVEURLS: false

      - name: Build Pagefind Search Index
        run: npx pagefind --site public

      - name: Prepare Artifact Payload
        run: |
          mkdir -p ../artifact-payload
          cp -r public ../artifact-payload/public
          echo ${{ env.PR_NUMBER }} > ../artifact-payload/pr_number.txt

      - name: Upload Artifact
        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
        with:
          name: cf-preview-data
          path: artifact-payload/
          retention-days: 1

      - name: Deployment Link
        run: |
          DEPLOY_URL="https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}/actions/workflows/docs_deploy_cf.yaml"

          echo "### Build Complete" >> $GITHUB_STEP_SUMMARY
          echo "The build for PR #${{ env.PR_NUMBER }} succeeded." >> $GITHUB_STEP_SUMMARY
          echo "The Cloudflare deployment workflow is now starting." >> $GITHUB_STEP_SUMMARY
          echo "---" >> $GITHUB_STEP_SUMMARY
          echo "#### [Track Deployment Progress]($DEPLOY_URL)" >> $GITHUB_STEP_SUMMARY

  remove-label:
    needs: build-preview
    if: "always() && contains(github.event.pull_request.labels.*.name, 'docs: deploy-preview')"
    runs-on: ubuntu-24.04
    permissions:
      pull-requests: write
    steps:
      - name: Remove deploy-preview label
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
        with:
          script: |
            try {
              await github.rest.issues.removeLabel({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                name: 'docs: deploy-preview'
              });
              console.log("Label 'docs: deploy-preview' removed successfully.");
            } catch (error) {
              console.log(`Error removing label: ${error}`);
            }