Merge pull request #51 from jeromekelleher/fix-docs-params

Replace pre-build-command with declarative install-playwright input

Author: jeromekelleher

.github/actions/build-docs/action.yml

@@ -23,16 +23,16 @@ inputs:
     required: false
     default: ''
 
-  pre-build-command:
-    description: 'Command to run after installing deps but before the docs build'
-    required: false
-    default: ''
-
   install-slim:
     description: 'Whether to install SLiM'
     required: false
     default: 'false'
 
+  install-playwright:
+    description: 'Install Playwright (chromium) for docs that render browser screenshots'
+    required: false
+    default: 'false'
+
 runs:
   using: composite
   steps:
@@ -89,12 +89,12 @@ runs:
         echo "PKG_VERSION=$PKG_VERSION"
         sed -i s/__PKG_VERSION__/${PKG_VERSION}/g docs/_config.yml
 
-    - name: Pre-build
-      if: inputs.pre-build-command != ''
+    - name: Install Playwright
+      if: ${{ inputs.install-playwright == 'true' }}
       shell: bash
       env:
-        PRE_BUILD_COMMAND: ${{ inputs.pre-build-command }}
-      run: ${PRE_BUILD_COMMAND}
+        PYPROJECT_DIRECTORY: ${{ inputs.pyproject-directory }}
+      run: uv run --no-default-groups --project=${PYPROJECT_DIRECTORY} --locked --group=docs playwright install --with-deps chromium
 
     - name: Build documentation
       shell: bash

.github/workflows/docs.yml

@@ -23,18 +23,18 @@ on:
         type: string
         default: ''
 
-      pre-build-command:
-        description: 'Command to run after installing deps but before the docs build'
-        required: false
-        type: string
-        default: ''
-
       install-slim:
         description: 'Whether to install SLiM'
         required: false
         type: boolean
         default: false
 
+      install-playwright:
+        description: 'Install Playwright (chromium) for docs that render browser screenshots'
+        required: false
+        type: boolean
+        default: false
+
 permissions:
   contents: read
 
@@ -57,8 +57,8 @@ jobs:
         with:
           pyproject-directory: ${{ inputs.pyproject-directory }}
           additional-apt-packages: ${{ inputs.additional-apt-packages }}
-          pre-build-command: ${{ inputs.pre-build-command }}
           install-slim: ${{ inputs.install-slim }}
+          install-playwright: ${{ inputs.install-playwright }}
 
       - name: Trigger tskit-site rebuild
         if: github.ref == 'refs/heads/main'