kandev/.github/workflows/notify-docs.yml

name: Published Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/public/**"
  pull_request:
    branches: [main]
    paths:
      - "docs/public/**"
      - "apps/web/scripts/check-no-em-dash-ui.mjs"
      - "apps/web/scripts/check-no-em-dash-ui.test.ts"
      - "scripts/validate-public-docs.mjs"
      - "scripts/validate-public-docs.test.mjs"
      - "scripts/notify-docs-workflow.test.mjs"
      - ".github/workflows/notify-docs.yml"
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  validate:
    name: Validate public docs
    runs-on: ubuntu-latest
    timeout-minutes: 5

    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          persist-credentials: false

      - name: Test public docs validator
        run: node --test scripts/validate-public-docs.test.mjs scripts/notify-docs-workflow.test.mjs

      - name: Validate public docs
        run: node scripts/validate-public-docs.mjs

  preview:
    name: Deploy Cloudflare Pages preview
    outputs:
      enabled: ${{ steps.cloudflare.outputs.enabled }}
      deployment_url: ${{ steps.deploy.outputs.deployment-url }}
      alias_url: ${{ steps.deploy.outputs.pages-deployment-alias-url }}
    needs: validate
    if: >-
      github.event_name == 'pull_request' &&
      github.event.pull_request.head.repo.full_name == github.repository
    runs-on: ubuntu-latest
    timeout-minutes: 15
    permissions:
      contents: read

    steps:
      - name: Checkout docs pull request
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          persist-credentials: false

      - name: Checkout landing publisher
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          repository: kdlbs/landing
          # Preview against the current production publisher contract rather than a stale renderer.
          ref: main
          path: landing
          ssh-key: ${{ secrets.LANDING_REPO_DEPLOY_KEY }}
          persist-credentials: false

      - name: Set up pnpm
        uses: pnpm/action-setup@a8198c4bff370c8506180b035930dea56dbd5288 # v5
        with:
          version: 9.15.9

      - name: Set up Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
        with:
          node-version: 24.12.0
          cache: pnpm
          cache-dependency-path: landing/pnpm-lock.yaml

      - name: Install landing dependencies
        working-directory: landing
        run: pnpm install --frozen-lockfile

      - name: Build preview from pull request docs
        working-directory: landing
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          KANDEV_DOCS_SOURCE_PATH: ${{ github.workspace }}/docs
        run: pnpm run build:pages

      - name: Check Cloudflare preview configuration
        id: cloudflare
        env:
          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          CLOUDFLARE_ACCOUNT_ID: ${{ vars.CLOUDFLARE_ACCOUNT_ID }}
        run: |
          if [[ -n "$CLOUDFLARE_API_TOKEN" && -n "$CLOUDFLARE_ACCOUNT_ID" ]]; then
            echo "enabled=true" >> "$GITHUB_OUTPUT"
          else
            echo "enabled=false" >> "$GITHUB_OUTPUT"
            echo "::warning::Docs preview deploy is not configured. Add CLOUDFLARE_API_TOKEN as a repository secret and CLOUDFLARE_ACCOUNT_ID as a repository variable."
          fi

      - name: Prepare isolated Wrangler environment
        if: steps.cloudflare.outputs.enabled == 'true'
        run: |
          mkdir -p landing/wrangler-deploy
          cd landing/wrangler-deploy
          npm init --yes

      - name: Deploy preview to Cloudflare Pages
        id: deploy
        if: steps.cloudflare.outputs.enabled == 'true'
        uses: cloudflare/wrangler-action@ebbaa1584979971c8614a24965b4405ff95890e0 # v4.0.0
        with:
          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          accountId: ${{ vars.CLOUDFLARE_ACCOUNT_ID }}
          workingDirectory: landing/wrangler-deploy
          packageManager: npm
          wranglerVersion: 3.90.0
          command: >-
            pages deploy ../out
            --project-name=landing
            --branch=docs-pr-${{ github.event.pull_request.number }}
            --commit-dirty=true

  publish-preview-link:
    name: Publish docs preview link
    needs: preview
    if: needs.preview.outputs.enabled == 'true'
    runs-on: ubuntu-latest
    timeout-minutes: 4
    permissions:
      contents: read
      issues: write
      pull-requests: write

    steps:
      - name: Publish docs preview link
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          DEPLOYMENT_URL: ${{ needs.preview.outputs.deployment_url }}
          ALIAS_URL: ${{ needs.preview.outputs.alias_url }}
        with:
          script: |
            const marker = '<!-- kandev-docs-cloudflare-preview -->';
            const deploymentUrl = process.env.DEPLOYMENT_URL?.replace(/\/$/, '');
            const aliasUrl = process.env.ALIAS_URL?.replace(/\/$/, '');
            if (!deploymentUrl) {
              core.setFailed('Cloudflare Pages did not return a deployment URL; cannot publish the docs preview link.');
              return;
            }
            const shortSha = context.payload.pull_request.head.sha.slice(0, 7);
            const bodyLines = [
              marker,
              '## Cloudflare Pages docs preview',
              '',
              `[Open the docs preview](${deploymentUrl}/docs)`,
              '',
              `Built from docs commit \`${shortSha}\`.`,
            ];
            if (aliasUrl) {
              bodyLines.push('', `Stable PR alias: [${aliasUrl}/docs](${aliasUrl}/docs)`);
            }
            const body = bodyLines.join('\n');
            const comments = await github.paginate(github.rest.issues.listComments, {
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
              per_page: 100,
            });
            const existing = comments.find((comment) => comment.body?.includes(marker));

            if (existing) {
              await github.rest.issues.updateComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                comment_id: existing.id,
                body,
              });
            } else {
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body,
              });
            }

  rebuild:
    name: Trigger Cloudflare Pages rebuild
    needs: validate
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    timeout-minutes: 4

    steps:
      - name: Trigger Cloudflare Pages deploy hook
        env:
          DEPLOY_HOOK_URL: ${{ secrets.CLOUDFLARE_PAGES_DEPLOY_HOOK_KANDEV_AI }}
        run: |
          if [[ -z "$DEPLOY_HOOK_URL" ]]; then
            echo "::error::CLOUDFLARE_PAGES_DEPLOY_HOOK_KANDEV_AI is not configured"
            exit 1
          fi

          curl --fail --silent --show-error \
            --max-time 30 \
            --retry 3 \
            --retry-all-errors \
            --retry-max-time 90 \
            --request POST \
            "$DEPLOY_HOOK_URL"