feat(docs): templatize home page with build context and date (#459)

tbouffard · web-flow · commit 43b24b8d20f0 · 2026-03-31T12:01:26.000+02:00
Add `CONTEXT` and `DATE` placeholders to public/docs/index.html to match
surge preview pattern.
Update build-documentation action to accept context_label input and
apply sed substitutions.
Configure both master and PR workflows to pass appropriate context
labels (master branch or PR #number).

Also add the `DATE` placeholder in the page used in surge.sh deployment.
diff --git a/.github/actions/build-documentation/action.yml b/.github/actions/build-documentation/action.yml
@@ -1,6 +1,11 @@
 name: 'Build the documentation'
 description: 'Build static and API documentation.'
 
+inputs:
+  context_label:
+    description: 'Label describing the build context (e.g., "master branch" or "PR #123")'
+    required: true
+
 runs:
   using: 'composite'
   steps:
@@ -18,3 +23,8 @@ runs:
     - name: Copy static pages
       shell: bash
       run: cp -r public/docs build
+    - name: Apply template placeholders
+      shell: bash
+      run: |
+        sed -i "s/@CONTEXT@/${{ inputs.context_label }}/g" build/docs/index.html
+        sed -i "s/@DATE@/$(date -u +%Y-%m-%dT%H:%M:%SZ)/g" build/docs/index.html
diff --git a/.github/workflows/deploy-documentation-pr.yml b/.github/workflows/deploy-documentation-pr.yml
@@ -20,6 +20,8 @@ jobs:
       - uses: actions/checkout@v6
       - name: Build documentation
         uses: ./.github/actions/build-documentation
+        with:
+          context_label: PR ${{ github.event.pull_request.number }}
       - name: Upload
         uses: actions/upload-artifact@v7
         with:
diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml
@@ -28,6 +28,8 @@ jobs:
       - uses: actions/checkout@v6
       - name: Build documentation
         uses: ./.github/actions/build-documentation
+        with:
+          context_label: master branch
       - name: Upload artifact for GitHub Pages
         uses: actions/upload-pages-artifact@v4
         with:
diff --git a/.github/workflows/surge-pr-fork-01-build.yml b/.github/workflows/surge-pr-fork-01-build.yml
@@ -22,6 +22,7 @@ jobs:
           mkdir site
           cp -r public/surge/* site/
           sed -i "s/@PR_NUMBER@/${PR_NUMBER}/g" site/index.html
+          sed -i "s/@DATE@/$(date -u +%Y-%m-%dT%H:%M:%SZ)/g" site/index.html
 
       - name: Upload artifact
         uses: actions/upload-artifact@v7
diff --git a/.github/workflows/surge-preview-for-pr.yml b/.github/workflows/surge-preview-for-pr.yml
@@ -36,6 +36,7 @@ jobs:
           mkdir site
           cp -r public/surge/* site/
           sed -i "s/@PR_NUMBER@/${PR_NUMBER}/g" site/index.html
+          sed -i "s/@DATE@/$(date -u +%Y-%m-%dT%H:%M:%SZ)/g" site/index.html
       - name: Publish Demo preview
         if: steps.surge-preview-tools.outputs.can-run-surge-command == 'true'
         id: publish_demo_preview
diff --git a/public/docs/index.html b/public/docs/index.html
@@ -2,13 +2,13 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>Process Analytics Playground site</title>
+    <title>Process Analytics Playground site (@CONTEXT@)</title>
 </head>
 <body>
 <section>
-    <h1>Process Analytics Playground site</h1>
+    <h1>Process Analytics Playground site (@CONTEXT@)</h1>
     <p>Have a look at an example of the <a href="api/">documentation of an TypeScript API generated with Typedoc</a></p>
 </section>
-<footer>Process Analytics - 2021-present</footer>
+<footer>Process Analytics - 2021-present (built on @DATE@)</footer>
 </body>
 </html>
diff --git a/public/surge/index.html b/public/surge/index.html
@@ -9,6 +9,6 @@
     <h1>Process Analytics Playground site for PR @PR_NUMBER@</h1>
     <p>This page has been created to test <a href="https://surge.sh/">Surge</a> deployments.</p>
 </section>
-<footer>Process Analytics - 2021-present</footer>
+<footer>Process Analytics - 2021-present (built on @DATE@)</footer>
 </body>
 </html>
