fix: use the documentation site path in workflow (#1866)

Author: ferrarimarco

.github/workflows/documentation.yaml

@@ -5,13 +5,13 @@ on: # yamllint disable-line rule:truthy
   push:
     paths:
       - ".github/workflows/documentation.yaml"
-      - "docs-src/**"
+      - "websites-src/home-lab-docs/**"
       - "config/mkdocs/home-lab-docs/**"
       - scripts/run-mkdocs.sh
   pull_request:
     paths:
       - ".github/workflows/documentation.yaml"
-      - "docs-src/**"
+      - "websites-src/home-lab-docs/**"
       - "config/mkdocs/home-lab-docs/**"
       - scripts/run-mkdocs.sh
   workflow_call: null
@@ -25,7 +25,7 @@ jobs:
       # Ref: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
       # github.head_ref: head_ref or source branch of the pull request
       # github.ref: ref of the branch that triggered the workflow
-      group: ${{ github.workflow }}-build-documentation-sites-${{ github.head_ref || github.ref }}-${{ github.event_name }}
+      group: ${{ github.workflow }}-build-push-documentation-site-${{ github.head_ref || github.ref }}-${{ github.event_name }}
       cancel-in-progress: true
     permissions:
       # To commit the newly built documentation site
@@ -36,11 +36,24 @@ jobs:
       - name: Build the documentation site
         run: |
           scripts/run-mkdocs.sh "build" "home-lab-docs"
+      # Check if changed files only include files that we can ignore, such as
+      # when only updating the sitemap
+      - name: Check documentation updates
+        id: check_documentation_updates
+        run: |
+          . scripts/common.sh
+          ONLY_CONTAINS_FILES_TO_IGNORE="false"
+          if check_if_uncommitted_files_only_include_files_to_ignore; then
+            echo "Documentation commit only contains files to ignore"
+            ONLY_CONTAINS_FILES_TO_IGNORE="true"
+          fi
+          echo "ONLY_CONTAINS_FILES_TO_IGNORE=${ONLY_CONTAINS_FILES_TO_IGNORE}" >>"$GITHUB_OUTPUT"
       - name: Commit and push updates to the documentation site
         if: >
           github.event.pull_request.user.login != 'dependabot[bot]' &&
           github.event_name == 'pull_request' &&
-          github.ref_name != github.event.repository.default_branch
+          github.ref_name != github.event.repository.default_branch &&
+          steps.check_documentation_updates.outputs.ONLY_CONTAINS_FILES_TO_IGNORE == 'false'
         uses: stefanzweifel/[email protected]
         with:
           branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}

scripts/build-arduino-project.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 SCRIPT_DIRECTORY_PATH="$(dirname "${0}")"
 

scripts/common.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 # shellcheck disable=SC2034
 ERR_ARGUMENT_EVAL=2
@@ -18,6 +19,12 @@ GITHUB_TOKEN_PATH="$(pwd)/.github-personal-access-token"
 # shellcheck disable=SC2034
 HOME_LAB_DOCS_CONFIGURATION_FILE_PATH="config/mkdocs/home-lab-docs/mkdocs.yml"
 
+# shellcheck disable=SC2034
+MKDOCS_IGNORE_IF_ONLY_CHANGED_FILES=(
+  "docs/sitemap.xml"
+  "docs/sitemap.xml.gz"
+)
+
 _DOCKER_INTERACTIVE_TTY_OPTION=
 if [ -t 0 ]; then
   _DOCKER_INTERACTIVE_TTY_OPTION="-it"
@@ -40,7 +47,7 @@ is_container_runtime_available() {
 }
 
 activate_python_virtual_environment() {
-  VENV_PATH="${1}"
+  local VENV_PATH="${1}"
 
   if [ -z "${VIRTUAL_ENV-}" ]; then
     echo "Activating the virtual environment in ${VENV_PATH}"
@@ -54,7 +61,7 @@ activate_python_virtual_environment() {
 }
 
 is_python_virtual_environment_up_to_date() {
-  PYTHON_VIRTUAL_ENVIRONMENT_CHECK_RETURN_CODE=0
+  local PYTHON_VIRTUAL_ENVIRONMENT_CHECK_RETURN_CODE=0
   if [ ! -e "${1}" ]; then
     # The virtual environment doesn't exist, so it can't be up to date by definition
     PYTHON_VIRTUAL_ENVIRONMENT_CHECK_RETURN_CODE=1
@@ -74,9 +81,9 @@ is_python_virtual_environment_up_to_date() {
 }
 
 create_and_activate_python_virtual_environment() {
-  PYTHON_VIRTUAL_ENVIRONMENT_PATH="${1}"
-  PIP_REQUIREMENTS_PATH="${2:-""}"
-  _FORCE_UPDATE_PYTHON_VIRTUAL_ENVIRONMENT="${3:-"false"}"
+  local PYTHON_VIRTUAL_ENVIRONMENT_PATH="${1}"
+  local PIP_REQUIREMENTS_PATH="${2:-""}"
+  local _FORCE_UPDATE_PYTHON_VIRTUAL_ENVIRONMENT="${3:-"false"}"
 
   if [ -e "${PYTHON_VIRTUAL_ENVIRONMENT_PATH}" ] && ! is_python_virtual_environment_up_to_date "${PYTHON_VIRTUAL_ENVIRONMENT_PATH}" && [ "${_FORCE_UPDATE_PYTHON_VIRTUAL_ENVIRONMENT}" = "true" ]; then
     echo "The ${PYTHON_VIRTUAL_ENVIRONMENT_PATH} virtual environment already exists but it's not up to date. Deleting it..."
@@ -123,3 +130,34 @@ check_github_token_file() {
     exit "${ERR_MISSING_GITHUB_TOKEN_FILE}"
   fi
 }
+
+check_if_uncommitted_files_only_include_files() {
+  local -a FILES_TO_CHECK=("$@")
+  local -a CHANGED_FILES
+
+  git status
+
+  readarray -d '' -t CHANGED_FILES < <(git diff-files -z --name-only)
+  readarray -d '' -t SORTED_CHANGED_FILES < <(printf '%s\0' "${CHANGED_FILES[@]}" | sort -z)
+
+  echo "Changed files (${#SORTED_CHANGED_FILES[@]}) in working directory:"
+  echo "${SORTED_CHANGED_FILES[*]}"
+
+  readarray -d '' -t SORTED_FILES_TO_CHECK < <(printf '%s\0' "${FILES_TO_CHECK[@]}" | sort -z)
+
+  if [[ "${SORTED_CHANGED_FILES[*]}" == "${SORTED_FILES_TO_CHECK[*]}" ]]; then
+    echo "Working directory contains only the files to check"
+    return 0
+  else
+    echo "Working directory doesn't contain only the files to check"
+    return 1
+  fi
+}
+
+check_if_uncommitted_files_only_include_files_to_ignore() {
+  if check_if_uncommitted_files_only_include_files "${MKDOCS_IGNORE_IF_ONLY_CHANGED_FILES[@]}"; then
+    return 0
+  else
+    return 1
+  fi
+}

scripts/copy-data.sh

@@ -1,10 +1,11 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 # shellcheck disable=SC2029
 # Disable SC2029 because intend to expand variables on the client
 # that runs this script, not on the server
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 _SOURCE_HOST="${1}"
 _SOURCE_DIRECTORY="${2}"

scripts/open-shell-ci-cd-tools-container.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 # shellcheck disable=SC1091,SC1094
 . ./scripts/common.sh

scripts/release-please-dry-run.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 # shellcheck disable=SC1091,SC1094
 . ./scripts/common.sh

scripts/run-ansible.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 # Doesn't follow symlinks, but it's likely expected for most users
 SCRIPT_BASENAME="$(basename "${0}")"

scripts/run-mkdocs.sh

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+set -o errexit
+set -o nounset
+set -o pipefail
+
 # shellcheck source=/dev/null
 . "./scripts/common.sh"
 
@@ -54,6 +58,7 @@ if [[ "${SUBCOMMAND}" == "serve" ]]; then
 elif [[ "${SUBCOMMAND}" == "build" ]]; then
   RUN_CONTAINER_COMMAND+=(
     "build"
+    "--strict"
     "${DEFAULT_MKDOCS_ARGS[@]}"
   )
 elif [[ "${SUBCOMMAND}" == "create" ]]; then

scripts/run-pre-commit.sh

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -o errexit
 set -o nounset
+set -o pipefail
 
 # Doesn't follow symlinks, but it's likely expected for most users
 SCRIPT_BASENAME="$(basename "${0}")"