deploy_docs_v2.yml

name: Deploy Tiny Docs v2

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'staging'
        type: choice
        options:
        - 'staging'
        - 'production'

# Need ID token write permission to use OIDC
permissions:
  id-token: write

env:
  TARGET: ${{ inputs.environment || 'staging' }}
  ACCT: ${{ inputs.environment == 'production' && '990880627107' || '327995277200' }}
  BUCKET: ${{ inputs.environment == 'production' && 'tiny-cloud-antora-docs-release' || 'tiny-cloud-antora-docs-preview' }}
  RUN: run-${{ github.run_number }}-${{ github.run_attempt }}

jobs:
  build:
    name: Build Docs and Deploy

    if: github.repository == 'tinymce/tinymce-docs' && github.repository_owner == 'tinymce'

    runs-on: ubuntu-latest

    defaults:
      run:
        shell: bash

    steps:
    - name: Checkout branch
      uses: actions/checkout@v5

    - name: Setup Node.js
      uses: actions/setup-node@v5
      with:
        cache: 'yarn'
        node-version: 22

    - name: Install dependencies
      run: yarn install

    - name: Build Website
      run: yarn antora ./antora-playbook.yml

    - name: Generate markdown for agents
      run: yarn build:markdown build/site

    - name: Generate LLM files
      run: yarn generate-llm-files build/site

    - name: Rename site folder to docs
      run: |
        mv ./build/site ./build/docs

    - name: Rename sitemap.xml to antora-sitemap.xml
      run: |
        mv ./build/docs/sitemap.xml ./build/docs/antora-sitemap.xml

    - name: configure aws credentials
      uses: aws-actions/configure-aws-credentials@v6
      with:
        role-to-assume: 'arn:aws:iam::${{ env.ACCT }}:role/${{ env.TARGET }}-tinymce-docs-update'
        role-session-name: tinymce-docs-${{ env.TARGET }}-release
        aws-region: us-east-1

    # Markdown and plain-text files cannot declare their own encoding the way
    # HTML does with <meta charset>, so the charset must be in the content type.
    # Without it, browsers decode the UTF-8 files as Windows-1252 and show an
    # em dash as "—". The sync guesses the type with no charset, so these files
    # are uploaded separately with the type set explicitly.
    - name: Upload website to S3
      run: |
        aws s3 sync ./build s3://${BUCKET}/main/${RUN} \
          --exclude "*/index.html" \
          --exclude "*.md" \
          --exclude "*.txt" \
          --cache-control "public, max-age=3600, stale-if-error=3600, stale-while-revalidate=86400"
        aws s3 sync ./build s3://${BUCKET}/main/${RUN} \
          --exclude "*" \
          --include "*/index.html" \
          --cache-control "max-age=300, stale-if-error=3600, stale-while-revalidate=86400"
        aws s3 sync ./build s3://${BUCKET}/main/${RUN} \
          --exclude "*" \
          --include "*/index.md" \
          --content-type "text/markdown; charset=utf-8" \
          --cache-control "max-age=300, stale-if-error=3600, stale-while-revalidate=86400"
        aws s3 sync ./build s3://${BUCKET}/main/${RUN} \
          --exclude "*" \
          --include "*.md" \
          --exclude "*/index.md" \
          --content-type "text/markdown; charset=utf-8" \
          --cache-control "public, max-age=3600, stale-if-error=3600, stale-while-revalidate=86400"
        aws s3 sync ./build s3://${BUCKET}/main/${RUN} \
          --exclude "*" \
          --include "*.txt" \
          --content-type "text/plain; charset=utf-8" \
          --cache-control "public, max-age=3600, stale-if-error=3600, stale-while-revalidate=86400"

    # Attachment PDFs, such as the accessibility conformance reports, are served
    # as downloads rather than rendered inline. The metadata directive replaces
    # the full metadata set, so the cache headers set by the sync above must be
    # restated here or they are lost.
    - name: Serve attachment PDFs as downloads
      run: |
        aws s3 cp \
          s3://${BUCKET}/main/${RUN}/ \
          s3://${BUCKET}/main/${RUN}/ \
          --recursive \
          --exclude "*" \
          --include "*/_attachments/*.pdf" \
          --metadata-directive REPLACE \
          --content-type application/pdf \
          --content-disposition attachment \
          --cache-control "public, max-age=3600, stale-if-error=3600, stale-while-revalidate=86400"

    - name: Create redirects on S3
      uses: tinymce/tinymce-docs-generate-redirects-action@v1.0
      with:
        build: ./build/
        redirects: ./redirects.json
        bucket: ${{ env.BUCKET }}
        prefix: main/${{ env.RUN }}
        parallel: 10

    - name: Update pointer to current run output
      run: |
        aws s3api put-object --bucket ${BUCKET} --key main/index.html --body .github/workflows/resources/empty.html --content-type text/html --metadata pointer=${RUN}

    - name: Tag old versions for cleanup
      uses: tinymce/tinymce-docs-cleanup-action@v1.0
      with:
        bucket: ${{ env.BUCKET }}
        folder: main
        parallel: 20