Added: Additional Settings for Pages Publishing, etc.

Author: Sewer56

README.MD

@@ -44,6 +44,10 @@ jobs:
         uses: Reloaded-Project/reloaded-project-configurations-rust/.github/actions/deploy-mkdocs-documentation@v1
         with:
           REQUIREMENTS: ./docs/requirements.txt
+          PUBLISH_TO_PAGES: true
+          CHECKOUT: true
+          PRE_BUILD_SCRIPT: ./scripts/pre-build.sh
+          PRE_BUILD_SHELL: bash
 ```
 
 ## Setup
@@ -66,6 +70,10 @@ The action supports the following input parameters:
 - `MKDOCS_VERSION`: (Optional) The version of MkDocs to use. Defaults to `latest`. This corresponds to the version in the Python package index.
 - `REQUIREMENTS`: (Optional) The path to a `requirements.txt` file listing additional Python dependencies. Defaults to `./docs/requirements.txt`.
 - `CONFIG_FILE`: (Optional) The path to your MkDocs configuration file. Defaults to `mkdocs.yml` in the repository root.
+- `PUBLISH_TO_PAGES`: (Optional) Whether to publish the generated site to GitHub Pages. Defaults to `true`.
+- `CHECKOUT`: (Optional) Whether to perform a repository checkout before building the site. Defaults to `true`.
+- `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`.
 
 ### Workflow Triggers
 

README.md

@@ -16,23 +16,40 @@ inputs:
     required: false
     default: "mkdocs.yml"
     description: "Path to the mkdocs.yml file"
+  PUBLISH_TO_PAGES:
+    type: boolean
+    required: false
+    default: true
+    description: "Whether to publish to GitHub Pages"
+  CHECKOUT:
+    type: boolean
+    required: false
+    default: true
+    description: "Whether to perform repository checkout"
+  PRE_BUILD_SCRIPT:
+    type: string
+    required: false
+    description: "Path to the pre-build script"
+  PRE_BUILD_SHELL:
+    type: string
+    required: false
+    default: "bash"
+    description: "Shell to use for running the pre-build script"
 
 runs:
   using: "composite"
   steps:
-    - uses: actions/checkout@v4
+    - name: Checkout Repository
+      if: ${{ inputs.CHECKOUT }}
+      uses: actions/checkout@v4
       with:
         submodules: "recursive"
 
     - name: Setup Pages
+      if: ${{ inputs.PUBLISH_TO_PAGES }}
       id: pages
       uses: actions/configure-pages@v4
 
-    - name: Setup Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: 3.x
-
     - name: Install MkDocs and Dependencies
       shell: bash
       run: |
@@ -42,21 +59,31 @@ runs:
         else
           pip install mkdocs-material==${{ inputs.MKDOCS_VERSION }}
         fi
-        if [ -f ${{ inputs.REQUIREMENTS }} ]; then
-          pip install -r ${{ inputs.REQUIREMENTS }}
+        if [ -f "${{ inputs.REQUIREMENTS }}" ]; then
+          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: Build MkDocs Site
       shell: bash
-      run: mkdocs build --config-file ${{ inputs.CONFIG_FILE }}
+      run: mkdocs build --config-file "${{ inputs.CONFIG_FILE }}"
 
     - name: Upload pages artifact
+      if: ${{ inputs.PUBLISH_TO_PAGES }}
       uses: actions/upload-pages-artifact@v3
       with:
         name: "github-pages"
         path: "./site"
 
     - name: Deploy to GitHub Pages
+      if: ${{ inputs.PUBLISH_TO_PAGES }}
       id: deployment
       uses: actions/deploy-pages@v4
       with: