Changed: Migrated Script to Common Lowercase and Dashes

Author: Sewer56

.github/workflows/test-mkdocs-workflow.yml

@@ -31,5 +31,5 @@ jobs:
       - name: Deploy MkDocs
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
-          REQUIREMENTS: docs/requirements.txt
-          CHECKOUT_CURRENT_REPO: false
+          requirements: docs/requirements.txt
+          checkout-current-repo: false

README.MD

@@ -43,9 +43,9 @@ jobs:
       - name: Deploy MkDocs
         uses: Reloaded-Project/devops-mkdocs@v1
         with:
-          REQUIREMENTS: ./docs/requirements.txt
-          PUBLISH_TO_PAGES: true
-          CHECKOUT_CURRENT_REPO: true # Checks out by default.
+          requirements: ./docs/requirements.txt
+          publish-to-pages: true
+          checkout-current-repo: true # Checks out by default.
 ```
 
 ## Setup
@@ -65,14 +65,14 @@ repository (or update the `CONFIG_FILE` parameter in the workflow).
 
 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_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`.
+- `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-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`.
 
 ### Workflow Triggers
 

action.yml

@@ -2,41 +2,41 @@ name: Build and Deploy MkDocs Material (Reloaded)
 description: Builds and/or Deploys MkDocs Material to GitHub Pages, or a Directory
 
 inputs:
-  MKDOCS_VERSION:
+  mkdocs-version:
     type: string
     required: false
     default: "latest"
     description: "MkDocs version to use"
-  REQUIREMENTS:
+  requirements:
     type: string
     required: false
     default: "./docs/requirements.txt"
     description: "Path to the requirements.txt file"
-  CONFIG_FILE:
+  config-file:
     type: string
     required: false
     default: "mkdocs.yml"
     description: "Path to the mkdocs.yml file"
-  PUBLISH_TO_PAGES:
+  publish-to-pages:
     type: boolean
     required: false
     default: true
     description: "Whether to publish to GitHub Pages"
-  CHECKOUT_CURRENT_REPO:
+  checkout-current-repo:
     type: boolean
     required: false
     default: true
     description: "Whether to perform repository checkout"
-  PRE_BUILD_SCRIPT:
+  pre-build-script:
     type: string
     required: false
     description: "Path to the pre-build script"
-  PRE_BUILD_SHELL:
+  pre-build-shell:
     type: string
     required: false
     default: "bash"
     description: "Shell to use for running the pre-build script"
-  OUTPUT_DIRECTORY:
+  output-directory:
     type: string
     required: false
     default: "./site"
@@ -46,50 +46,50 @@ runs:
   using: "composite"
   steps:
     - name: Checkout Repository
-      if: ${{ inputs.CHECKOUT_CURRENT_REPO }}
+      if: ${{ inputs.checkout-current-repo }}
       uses: actions/checkout@v4
       with:
         submodules: "recursive"
 
     - name: Setup Pages
-      if: ${{ inputs.PUBLISH_TO_PAGES }}
+      if: ${{ inputs.publish-to-pages }}
       id: pages
       uses: actions/configure-pages@v4
 
     - name: Install MkDocs and Dependencies
       shell: bash
       run: |
         python -m pip install --upgrade pip
-        if [ "${{ inputs.MKDOCS_VERSION }}" = "latest" ]; then
+        if [ "${{ inputs.mkdocs-version }}" = "latest" ]; then
           pip install mkdocs-material
         else
-          pip install mkdocs-material==${{ inputs.MKDOCS_VERSION }}
+          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 }}
+      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 }}"
+        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 }}" --site-dir "${{ inputs.OUTPUT_DIRECTORY }}"  # Updated command
+      run: mkdocs build --config-file "${{ inputs.config-file }}" --site-dir "${{ inputs.output-directory }}"
 
     - name: Upload pages artifact
-      if: ${{ inputs.PUBLISH_TO_PAGES }}
+      if: ${{ inputs.publish-to-pages }}
       uses: actions/upload-pages-artifact@v3
       with:
         name: "github-pages"
-        path: "${{ inputs.OUTPUT_DIRECTORY }}"
+        path: "${{ inputs.output-directory }}"
 
     - name: Deploy to GitHub Pages
-      if: ${{ inputs.PUBLISH_TO_PAGES }}
+      if: ${{ inputs.publish-to-pages }}
       id: deployment
       uses: actions/deploy-pages@v4
       with: