style: fix lint errors (#246)

Author: ReenigneArcher

.github/workflows/jekyll-build.yml

@@ -123,7 +123,7 @@ jobs:
         env:
           TMPDIR: /home/runner/work/tmp
         run: |
-          mkdir -p ${TMPDIR}
+          mkdir -p "${TMPDIR}"
 
           base_dirs=(
             ./theme/third-party/beautiful-jekyll
@@ -148,22 +148,22 @@ jobs:
 
           for base_dir in "${base_dirs[@]}"; do
             for target in "${targets[@]}"; do
-              if [ -e "$base_dir/$target" ]; then
-                cp -rf "$base_dir/$target" ${TMPDIR}/
+              if [ -e "${base_dir}/${target}" ]; then
+                cp -rf "${base_dir}/${target}" "${TMPDIR}/"
               fi
             done
           done
 
           # copy project directory, they should only come from the project repo
-          cp -RTf ./project/ ${TMPDIR}/
+          cp -RTf ./project/ "${TMPDIR}/"
 
           # remove the workspace
           cd ..
-          rm -rf ${GITHUB_WORKSPACE}
+          rm -rf "${GITHUB_WORKSPACE}"
 
           # move the temporary directory to the workspace
-          mv ${TMPDIR} ${GITHUB_WORKSPACE}
-          cd ${GITHUB_WORKSPACE}
+          mv "${TMPDIR}" "${GITHUB_WORKSPACE}"
+          cd "${GITHUB_WORKSPACE}"
 
           # debug contents recursively
           ls -Ra
@@ -183,14 +183,14 @@ jobs:
       - name: Setup CI config
         run: |
           config_file="_config_ci.yml"
-          echo "---" > $config_file
+          echo "---" > "${config_file}"
           if [ "${{ inputs.base_url }}" == '_auto' ]; then
             echo "baseurl: '${{ steps.configure-pages.outputs.base_path }}'" >> $config_file
           else
-            echo "baseurl: '${{ inputs.base_url }}'" >> $config_file
+            echo "baseurl: '${{ inputs.base_url }}'" >> "${config_file}"
           fi
 
-          cat $config_file
+          cat "${config_file}"
 
       - name: Build site
         env:

scripts/readthedocs_build.sh

@@ -2,79 +2,64 @@
 set -e
 
 # REQUIRED ENVIRONMENT VARIABLES (for subprojects)
-github_workflow=$(echo "$GITHUB_WORKFLOW" | tr -d "'")
-site_artifact=$(echo "$SITE_ARTIFACT" | tr -d "'")
+github_workflow=$(echo "${GITHUB_WORKFLOW:-}" | tr -d "'")
+site_artifact=$(echo "${SITE_ARTIFACT:-}" | tr -d "'")
 
 # OPTIONAL ENVIRONMENT VARIABLES (for subprojects)
-config_file=$(echo "$CONFIG_FILE" | tr -d "'")
-extract_archive=$(echo "$EXTRACT_ARCHIVE" | tr -d "'")
-github_timeout=$GITHUB_TIMEOUT
-theme_ref=$THEME_REF
+config_file=$(echo "${CONFIG_FILE:-_config.yml}" | tr -d "'")
+extract_archive=$(echo "${EXTRACT_ARCHIVE:-}" | tr -d "'")
+github_timeout="${GITHUB_TIMEOUT:-10}"
+theme_ref="${THEME_REF:-master}"
 
 # From ReadTheDocs
-git_sha=$READTHEDOCS_GIT_COMMIT_HASH
-github_url=$READTHEDOCS_GIT_CLONE_URL
+git_sha=${READTHEDOCS_GIT_COMMIT_HASH}
+github_url=${READTHEDOCS_GIT_CLONE_URL}
 
-if [[ $github_url == git@* ]]; then
+if [[ ${github_url} == git@* ]]; then
   # SSH URL format: [email protected]:user/repo.git
-  github_user=$(echo "$github_url" | cut -d: -f2 | cut -d/ -f1)
-  github_repo=$(echo "$github_url" | cut -d/ -f2 | sed 's/\.git$//')
+  github_user=$(echo "${github_url}" | cut -d: -f2 | cut -d/ -f1)
+  github_repo=$(echo "${github_url}" | cut -d/ -f2 | sed 's/\.git$//')
 else
   # HTTPS URL format: https://github.com/user/repo
-  github_user=$(echo "$github_url" | cut -d/ -f4)
-  github_repo=$(echo "$github_url" | cut -d/ -f5 | sed 's/\.git$//')
+  github_user=$(echo "${github_url}" | cut -d/ -f4)
+  github_repo=$(echo "${github_url}" | cut -d/ -f5 | sed 's/\.git$//')
 fi
 
 export PAGES_REPO_NWO="${github_user}/${github_repo}"
 
-# if timeout is not set then default to 10 minutes
-if [ -z "$github_timeout" ]; then
-  github_timeout=10
-fi
-
-# if config file is not set then default to _config.yml
-if [ -z "$config_file" ]; then
-  config_file="_config.yml"
-fi
-
-# if theme ref is not set then default to master
-if [ -z "$theme_ref" ]; then
-  theme_ref="master"
-fi
-
-echo "git sha: $git_sha"
-echo "github url: $github_url"
-echo "github user: $github_user"
-echo "github repo: $github_repo"
+echo "git sha: ${git_sha}"
+echo "github url: ${github_url}"
+echo "github user: ${github_user}"
+echo "github repo: ${github_repo}"
 
 # set default directories
 project_dir="."
 theme_dir="."
 
 # if not the theme project then we need to clone the theme with submodules
 sub_project="false"
-if [ "$READTHEDOCS_PROJECT" != "lizardbyte-gh-pages-main" ]; then
+if [ "${READTHEDOCS_PROJECT}" != "lizardbyte-gh-pages-main" ]; then
   sub_project="true"
-  echo "Building a subproject: $READTHEDOCS_PROJECT"
-  echo "github workflow: $github_workflow"
-  echo "site artifact: $site_artifact"
-  echo "github timeout: $github_timeout"
-  echo "extract archive: $extract_archive"
-  echo "config file: $config_file"
-  echo "theme ref: $theme_ref"
+  echo "Building a subproject: ${READTHEDOCS_PROJECT}"
+  echo "github workflow: ${github_workflow}"
+  echo "site artifact: ${site_artifact}"
+  echo "github timeout: ${github_timeout}"
+  echo "extract archive: ${extract_archive}"
+  echo "config file: ${config_file}"
+  echo "theme ref: ${theme_ref}"
 
   start_time=$(date +%s)
   max_time=$((start_time + 60 * github_timeout))
   sleep_interval=10
 
   # fail if the workflow is not set
-  if [ -z "$github_workflow" ]; then
+  if [ -z "${github_workflow}" ]; then
     echo "github_workflow is not set"
     exit 1
   fi
 
   # fail if the site artifact is not set
-  if [ -z "$site_artifact" ]; then
+  if [ -z "${site_artifact}" ]; then
     echo "site_artifact is not set"
     exit 1
   fi
@@ -90,75 +75,75 @@ if [ "$READTHEDOCS_PROJECT" != "lizardbyte-gh-pages-main" ]; then
   git submodule update --init --recursive
   popd
 
-  encoded_workflow=$(echo "$github_workflow" | sed 's/ /%20/g')
+  encoded_workflow="${github_workflow// /%20}"
   check_api_url="https://api.github.com/repos/${github_user}/${github_repo}/commits/${git_sha}/check-runs?check_name=${encoded_workflow}"
-  echo "Check API URL: $check_api_url"
+  echo "Check API URL: ${check_api_url}"
 
   # Wait for check runs to be available
   count=1
   while true; do
     current_time=$(date +%s)
-    if [ $current_time -gt $max_time ]; then
+    if [ "${current_time}" -gt ${max_time} ]; then
       echo "Timeout waiting for check runs"
       exit 1
     fi
-    echo "Checking check runs: $count"
+    echo "Checking check runs: ${count}"
 
-    response=$(curl -s -H "Accept: application/vnd.github.v3+json" "$check_api_url")
-    check_runs=$(echo "$response" | jq -r '.check_runs')
-    check_run_count=$(echo "$check_runs" | jq -r 'length')
+    response=$(curl -s -H "Accept: application/vnd.github.v3+json" "${check_api_url}")
+    check_runs=$(echo "${response}" | jq -r '.check_runs')
+    check_run_count=$(echo "${check_runs}" | jq -r 'length')
 
-    echo "Check runs count: $check_run_count"
+    echo "Check runs count: ${check_run_count}"
 
-    if [ "$check_run_count" -gt 0 ]; then
-      check_run=$(echo "$check_runs" | jq -r '.[0]')
-      check_job_id=$(echo "$check_run" | jq -r '.id')
-      check_run_html_url=$(echo "$check_run" | jq -r '.html_url')
-      echo "Check job id: $check_job_id"
-      echo "Check run URL: $check_run_html_url"
+    if [ "${check_run_count}" -gt 0 ]; then
+      check_run=$(echo "${check_runs}" | jq -r '.[0]')
+      check_job_id=$(echo "${check_run}" | jq -r '.id')
+      check_run_html_url=$(echo "${check_run}" | jq -r '.html_url')
+      echo "Check job id: ${check_job_id}"
+      echo "Check run URL: ${check_run_html_url}"
       break
     fi
 
     echo "Waiting for check runs to be available..."
-    sleep $sleep_interval
+    sleep ${sleep_interval}
     count=$((count + 1))
   done
 
   # get the run id from the html url
   # e.g. https://github.com/LizardByte/LizardByte.github.io/actions/runs/13687305039/job/38273540489
-  check_run_id=$(echo "$check_run_html_url" | cut -d/ -f8)
-  echo "Check run id: $check_run_id"
+  check_run_id=$(echo "${check_run_html_url}" | cut -d/ -f8)
+  echo "Check run id: ${check_run_id}"
 
   # wait for the check run to complete, cancelled, timed out, etc.
   check_run_api_url="https://api.github.com/repos/${github_user}/${github_repo}/actions/runs/${check_run_id}"
-  echo "Check run API URL: $check_run_api_url"
+  echo "Check run API URL: ${check_run_api_url}"
 
   count=1
   while true; do
     current_time=$(date +%s)
-    if [ $current_time -gt $max_time ]; then
+    if [ "${current_time}" -gt ${max_time} ]; then
       echo "Timeout waiting for check runs"
       exit 1
     fi
-    echo "Checking check run status: $count"
+    echo "Checking check run status: ${count}"
 
-    check_run_response=$(curl -s -H "Accept: application/vnd.github.v3+json" "$check_run_api_url")
+    check_run_response=$(curl -s -H "Accept: application/vnd.github.v3+json" "${check_run_api_url}")
 
-    check_run_status=$(echo "$check_run_response" | jq -r '.status')
-    check_run_conclusion=$(echo "$check_run_response" | jq -r '.conclusion')
+    check_run_status=$(echo "${check_run_response}" | jq -r '.status')
+    check_run_conclusion=$(echo "${check_run_response}" | jq -r '.conclusion')
 
-    echo "Check run status: $check_run_status"
-    if [ "$check_run_status" == "completed" ]; then
+    echo "Check run status: ${check_run_status}"
+    if [ "${check_run_status}" == "completed" ]; then
       break
     fi
 
     echo "Waiting for check run to complete..."
-    sleep $sleep_interval
+    sleep ${sleep_interval}
     count=$((count + 1))
   done
 
   # if not successful then exit
-  if [ "$check_run_conclusion" != "success" ]; then
+  if [ "${check_run_conclusion}" != "success" ]; then
     echo "Check run did not complete successfully"
     exit 1
   fi
@@ -167,29 +152,29 @@ if [ "$READTHEDOCS_PROJECT" != "lizardbyte-gh-pages-main" ]; then
   artifact_url="https://nightly.link/${github_user}/${github_repo}/actions/runs/${check_run_id}/${site_artifact}"
 
   # download and extract the ZIP artifact
-  curl -sL "$artifact_url" -o "${project_dir}/artifact.zip"
+  curl -sL "${artifact_url}" -o "${project_dir}/artifact.zip"
   7z x "${project_dir}/artifact.zip" -o"${project_dir}"
   rm "${project_dir}/artifact.zip"
 
   # if there is a name provided for extract_artifact, then we will extract the nested archive
-  if [ -n "$extract_archive" ]; then
+  if [ -n "${extract_archive}" ]; then
     pushd "${project_dir}"
-    case "$extract_archive" in
+    case "${extract_archive}" in
       *.tar.gz|*.tgz)
-        tar -xzf "$extract_archive" -C .
+        tar -xzf "${extract_archive}" -C .
         ;;
       *.tar)
-        tar -xf "$extract_archive" -C .
+        tar -xf "${extract_archive}" -C .
         ;;
       *.zip)
-        7z x "$extract_archive" -o.
+        7z x "${extract_archive}" -o.
         ;;
       *)
         echo "Unsupported archive format"
         exit 1
         ;;
     esac
-    rm -f "$extract_archive"
+    rm -f "${extract_archive}"
     popd
   fi
 fi
@@ -220,8 +205,8 @@ targets=(
 
 for base_dir in "${base_dirs[@]}"; do
   for target in "${targets[@]}"; do
-    if [ -e "$base_dir/$target" ]; then
-      cp -rf "$base_dir/$target" "${TMPDIR}/"
+    if [ -e "${base_dir}/${target}" ]; then
+      cp -rf "${base_dir}/${target}" "${TMPDIR}/"
     fi
   done
 done
@@ -233,31 +218,31 @@ cd "${TMPDIR}"
 
 gem install bundle
 bundle install
-echo "baseurl: $READTHEDOCS_VERSION" > _config_rtd.yml
+echo "baseurl: ${READTHEDOCS_VERSION}" > _config_rtd.yml
 echo "_config_rtd.yml:"
 cat _config_rtd.yml
 echo "_config_theme.yml:"
 cat _config_theme.yml
 
 config_files=_config_rtd.yml,_config_theme.yml
-if [ -n "$config_file" ] && [ -e "$config_file" ]; then
-  config_files="${config_files},$config_file"
-  echo "config file: $config_file"
-  cat "$config_file"
+if [ -n "${config_file}" ] && [ -e "${config_file}" ]; then
+  config_files="${config_files},${config_file}"
+  echo "config file: ${config_file}"
+  cat "${config_file}"
 fi
 
 bundle exec jekyll build \
   --future \
-  --config $config_files \
+  --config "${config_files}" \
   --destination "${READTHEDOCS_OUTPUT}html"
 
 # mimic gh-pages
-if [ "$sub_project" == "true" ]; then
+if [ "${sub_project}" == "true" ]; then
   mkdir -p "${READTHEDOCS_OUTPUT}html/${github_repo}/assets"
   cp -RTf "${READTHEDOCS_OUTPUT}html/assets" "${READTHEDOCS_OUTPUT}html/${github_repo}/assets"
 fi
 
 echo "Build finished"
 echo "Output directory: ${READTHEDOCS_OUTPUT}html"
 echo "Listing output directory:"
-ls -Ra "$READTHEDOCS_OUTPUT"
+ls -Ra "${READTHEDOCS_OUTPUT}"