TCLOUD-4780: Created workflows for automatic previews (#3875)

* TCLOUD-4780: Created workflows for automatic previews

* TCLOUD-4780: Set working directory only for the one step

* TCLOUD-4780: Replace shell code that failed with nodejs

* TCLOUD-4780: Setting permissions for id-token to write

* TCLOUD-4780: Switch to using PR number instead of branch name

* TCLOUD-4780: Removed branch restriction

* TCLOUD-4780: Avoid creating the docs subdirectory

* TCLOUD-4780: Re-add the docs folder segment for redirects

Some older redirects go from the docs level (for example docs-4x) so the
folder is needed to properly model the redirects.

* TCLOUD-4780: Generating redirects

* TCLOUD-4780: Make script parallel to speed up object creation

* TCLOUD-4780: Increased parallel s3 operations to 20

* TCLOUD-4780: Create redirects in github action

* TCLOUD-4780: Ensure the clean up of redirects

* TCLOUD-4780: Use Lua replacment string "%1" instead of "$1"

* TCLOUD-4780: Fixed missing semicolon

* TCLOUD-4780: Use crypto to make the temporary file name unpredictable

Note that this doesn't prevent the file being rewriten after it has been
created but as we have to pass the file to other processes that can't be
prevented.

* TCLOUD-4780: Use preexisting file as redirect file template

This avoids problems with creating temporary files.

* TCLOUD-4780: Add additional metadata header to indicate 404s

This solves a problem when a file created to indicate conditional
redirects does not trigger a redirect but instead returns the dummy
content.

* TCLOUD-4780 Support atomic updates

* TCLOUD-4780: Remove `--if-none-match` as it seems unsupported

* TCLOUD-4780: Prefix the run number so it's more readable

* TCLOUD-4780: Improve output prefix

* TCLOUD-4780: Fix typo

* TCLOUD-4780: Try redirect without URL encoding

* TCLOUD-4780: Reduce logging

* TCLOUD-4780: Fix a strange redirect

* TCLOUD-4780: Move the generation of redirects to an action

* TCLOUD-4780: Try using a tag to reference the action

* TCLOUD-4780: Maybe enable debug logs

* TCLOUD-4780: Fix calculation of prefix

* TCLOUD-4780: Try referring to env vars just by their name

* TCLOUD-4780: Try prefixing env vars with "env."

* TCLOUD-4780: Change AWS region

* TCLOUD-4780: Fix creation of pointer file

* TCLOUD-4780: Try loading redirects from a URL

* TCLOUD-4780: Revert to using local file path for redirects

* TCLOUD-4780: Use v1.0 of the tinymce-docs-generate-redirects-action

* TCLOUD-4780: Remove out of date comments

* TCLOUD-4780: Update assumed role

The service was renamed to tinymce-docs and so the role was updated to
match.

* TCLOUD-4780: Fix codeql's complaint about no Javascript

Author: tiny-james

.github/workflows/preview_create.yml

@@ -0,0 +1,76 @@
+name: Preview Create/Update
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+
+# Need ID token write permission to use OIDC
+permissions:
+  id-token: write
+
+env:
+  PR: pr-${{ github.event.number }}
+  RUN: run-${{ github.run_number }}-${{ github.run_attempt }}
+
+jobs:
+
+  build:
+    name: Update Docs Preview
+
+    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: 24
+
+    - name: Install dependencies
+      run: yarn install
+
+    - name: Build Website
+      run: yarn antora ./antora-playbook.yml
+
+    - 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/[email protected]
+      with:
+        role-to-assume: arn:aws:iam::327995277200:role/staging-tinymce-docs-update
+        role-session-name: tinymce-docs-update
+        aws-region: us-east-1
+
+    - name: Upload website preview to S3
+      run: |
+        aws s3 sync ./build s3://tiny-cloud-antora-docs-preview/${PR}/${RUN}
+
+    - name: Create redirects on S3
+      uses: tinymce/[email protected]
+      with:
+        build: ./build/
+        redirects: ./redirects.json
+        bucket: tiny-cloud-antora-docs-preview
+        prefix: ${{ env.PR }}/${{ env.RUN }}
+        parallel: 10
+
+    - name: Update pointer to current run output
+      run: |
+        aws s3api put-object --bucket tiny-cloud-antora-docs-preview --key ${PR}/index.html --body .github/workflows/resources/empty.html --content-type text/html --metadata pointer=${RUN}

.github/workflows/preview_delete.yml

@@ -0,0 +1,44 @@
+name: Preview Delete
+
+on:
+  pull_request:
+    types:
+      - closed
+
+# Need ID token write permission to use OIDC
+permissions:
+  id-token: write
+
+env:
+  PR: pr-${{ github.event.number }}
+
+jobs:
+  cleanup:
+    name: Cleanup Docs Preview
+
+    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: 24
+
+    - name: configure aws credentials
+      uses: aws-actions/[email protected]
+      with:
+        role-to-assume: arn:aws:iam::327995277200:role/staging-docs-preview-update
+        role-session-name: docs-preview-delete
+        aws-region: us-east-2
+
+    - name: Remove website preview from S3
+      run: |
+        aws s3 rm s3://tiny-cloud-antora-docs-preview/${PR}

.github/workflows/resources/empty.html

@@ -0,0 +1 @@
+<!doctype html><title>?</title>

.github/workflows/resources/unused.js

@@ -0,0 +1,2 @@
+// Give CodeQL something to scan so it doesn't complain there is no Javascript...
+console.log('Hello world');