Changed: pre-build-script to pre-build-command, & parallelised tests.

Sewer56 · Sewer56 · commit 18b13a1691a6 · 2024-06-16T03:14:04.000+01:00
diff --git a/.github/workflows/test-mkdocs-workflow.yml b/.github/workflows/test-mkdocs-workflow.yml
@@ -16,94 +16,118 @@ on:
       - '.github/workflows/test-mkdocs-workflow.yml'
 
 jobs:
-  test:
+  test-default-parameters:
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-
     steps:
       - name: Checkout Test Repository
         uses: actions/checkout@v4
         with:
           repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
           submodules: 'recursive'
-
       - name: Test Default Parameters
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           checkout-current-repo: false
           publish-to-pages: false
 
+  test-custom-mkdocs-version:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
       - name: Test Custom MkDocs Version
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           mkdocs-version: '9.5.24'
           checkout-current-repo: false
           publish-to-pages: false
 
+  test-disable-checkout:
+    runs-on: ubuntu-latest
+    steps:
       - name: Test Disable Checkout
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           checkout-current-repo: false
           publish-to-pages: false
 
-      - name: Create Pre-build Script (Bash)
+  test-custom-pre-build-command-bash:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
+      - name: Create Pre-build Command (Bash)
         shell: bash
         run: |
           echo '#!/bin/bash' > pre-build-bash.sh
-          echo 'echo "Running pre-build script (Bash)"' >> pre-build-bash.sh
+          echo 'echo "Running pre-build command (Bash)"' >> pre-build-bash.sh
           echo 'ls -l' >> pre-build-bash.sh
           echo 'touch pre-build-bash-executed.txt' >> pre-build-bash.sh
-
-      - name: Test Custom Pre-build Script (Bash)
+      - name: Test Custom Pre-build Command (Bash)
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
-          pre-build-script: pre-build-bash.sh
-          pre-build-shell: bash
+          pre-build-command: pre-build-bash.sh
+          pre-build-command-shell: bash
           checkout-current-repo: false
           publish-to-pages: false
-
-      - name: Assert Pre-build Script Execution (Bash)
+      - name: Assert Pre-build Command Execution (Bash)
         shell: bash
         run: |
           if [ ! -f pre-build-bash-executed.txt ]; then
-            echo "Pre-build script (Bash) did not execute successfully"
+            echo "Pre-build command (Bash) did not execute successfully"
             exit 1
           fi
 
-      - name: Create Pre-build Script (PowerShell)
+  test-custom-pre-build-command-pwsh:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
+      - name: Create Pre-build Command (PowerShell)
         shell: pwsh
         run: |
           echo '#!/usr/bin/env pwsh' > pre-build-pwsh.ps1
-          echo 'Write-Output "Running pre-build script (PowerShell)"' >> pre-build-pwsh.ps1
+          echo 'Write-Output "Running pre-build command (PowerShell)"' >> pre-build-pwsh.ps1
           echo 'Get-ChildItem' >> pre-build-pwsh.ps1
           echo 'New-Item -ItemType File -Path pre-build-pwsh-executed.txt' >> pre-build-pwsh.ps1
-
-      - name: Test Custom Pre-build Script (PowerShell)
+      - name: Test Custom Pre-build Command (PowerShell)
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
-          pre-build-script: pre-build-pwsh.ps1
-          pre-build-shell: pwsh
+          pre-build-command: pre-build-pwsh.ps1
+          pre-build-command-shell: pwsh
           checkout-current-repo: false
           publish-to-pages: false
-
-      - name: Assert Pre-build Script Execution (PowerShell)
+      - name: Assert Pre-build Command Execution (PowerShell)
         shell: pwsh
         run: |
           if (-not (Test-Path -Path pre-build-pwsh-executed.txt)) {
-            Write-Error "Pre-build script (PowerShell) did not execute successfully"
+            Write-Error "Pre-build command (PowerShell) did not execute successfully"
             exit 1
           }
 
+  test-custom-output-directory:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
       - name: Test Custom Output Directory
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           output-directory: docs/_site
           checkout-current-repo: false
           publish-to-pages: false
-
       - name: Assert Custom Output Directory
         shell: bash
         run: |
@@ -112,28 +136,54 @@ jobs:
             exit 1
           fi
 
+  test-custom-requirements-path:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
       - name: Copy Custom Requirements File
         shell: bash
         run: cp docs/requirements.txt docs/custom-requirements.txt
-
       - name: Test Custom Requirements Path
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           requirements: docs/custom-requirements.txt
           checkout-current-repo: false
           publish-to-pages: false
 
+  test-custom-config-file:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
       - name: Copy Custom Config File
         shell: bash
         run: cp mkdocs.yml docs/custom-mkdocs.yml
-
       - name: Test Custom Config File
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           config-file: docs/custom-mkdocs.yml
           checkout-current-repo: false
           publish-to-pages: false
 
+  test-publish-to-pages:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - name: Checkout Test Repository
+        uses: actions/checkout@v4
+        with:
+          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
+          submodules: 'recursive'
       - name: Test Publish to Pages
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
diff --git a/README.MD b/README.MD
@@ -44,7 +44,7 @@ jobs:
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
           requirements: ./docs/requirements.txt
-          publish-to-pages: true
+          publish-to-pages: true # Default
           checkout-current-repo: true # Checks out by default.
 ```
 
@@ -71,8 +71,8 @@ The action supports the following input parameters:
 - `publish-to-pages`: (Optional) Whether to publish the generated site to GitHub Pages. Defaults to `true`.
 - `checkout-current-repo`: (Optional) Whether to perform a repository checkout before building the site. Defaults to `true`.
 - `output-directory`: (Optional) Location of the built MkDocs site. Defaults to `./site`.
-- `pre-build-script`: (Optional) The path to a pre-build script to run before building the site.
-- `pre-build-shell`: (Optional) The shell to use for running the pre-build script. Defaults to `bash`.
+- `pre-build-command`: (Optional) The path to a pre-build command to run before building the site.
+- `pre-build-command-shell`: (Optional) The shell to use for running the pre-build command. Defaults to `bash`.
 
 ### Workflow Triggers
 
diff --git a/action.yml b/action.yml
@@ -22,13 +22,13 @@ inputs:
     required: false
     default: "true"
     description: "Whether to perform repository checkout"
-  pre-build-script:
+  pre-build-command:
     required: false
-    description: "Path to the pre-build script"
-  pre-build-shell:
+    description: "Path to the pre-build command"
+  pre-build-command-shell:
     required: false
     default: "bash"
-    description: "Shell to use for running the pre-build script"
+    description: "Shell to use for running the pre-build command"
   output-directory:
     required: false
     default: "./site"
@@ -61,13 +61,10 @@ runs:
           pip install -r "${{ inputs.requirements }}"
         fi
 
-    - name: Run Pre-build Script
-      if: ${{ inputs.pre-build-script }}
-      shell: ${{ inputs.pre-build-shell }}
-      run: |
-        if [ -f "${{ inputs.pre-build-script }}" ]; then
-          ${{ inputs.pre-build-shell }} "${{ inputs.pre-build-script }}"
-        fi
+    - name: Run Pre-build Command
+      if: ${{ inputs.pre-build-command }}
+      shell: ${{ inputs.pre-build-command-shell }}
+      run: ${{ inputs.pre-build-command }}
 
     - name: Build MkDocs Site
       shell: bash
