Lint bash scripts with custom shebangs

.github/workflows/lint.yml

@@ -50,3 +50,19 @@ jobs:
 
       - name: Run linter
         uses: ludeeus/[email protected]
+        with:
+          # Names of scripts with custom shebangs that the action would not
+          # discover on its own:
+          additional_files: >-
+            check_certificate_renewal
+            cpcd-config-up
+            discovery
+            finish
+            lock-tables-for-backup
+            matter-server-discovery
+            reboot
+            run
+            shutdown
+            universal-silabs-flasher-up
+            unlock-tables-for-backup
+            vlc-discovery

assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/finish

@@ -4,6 +4,7 @@
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +15,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

cec_scan/rootfs/etc/services.d/cec-scan/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start CEC scan service
 # ==============================================================================

configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/finish

@@ -4,6 +4,7 @@
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +15,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/run

@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start Configurator service
 # ==============================================================================

deconz/rootfs/etc/cont-init.d/firmware.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Manage deCONZ firmware
 # ==============================================================================

deconz/rootfs/etc/cont-init.d/nginx.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Configure NGINX for use with deCONZ
 # ==============================================================================

deconz/rootfs/etc/cont-init.d/novnc.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Setup noVNC
 # ==============================================================================

deconz/rootfs/etc/services.d/deconz/discovery

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Send deCONZ discovery information to Home Assistant
 # ==============================================================================

deconz/rootfs/etc/services.d/deconz/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start deCONZ service
 # ==============================================================================

deconz/rootfs/etc/services.d/nginx/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start NGINX service
 # ==============================================================================

deconz/rootfs/etc/services.d/otau-ikea/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Download available firmware update for IKEA
 # ==============================================================================

deconz/rootfs/etc/services.d/otau-ledvance/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Download available firmware update for OSRAM Ledvance
 # ==============================================================================

deconz/rootfs/etc/services.d/websockify/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start ozw-admin
 # ==============================================================================

dhcp_server/data/run.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 set -e
 
 CONFIG="/etc/dhcpd.conf"

dnsmasq/rootfs/etc/cont-init.d/config.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # DNSMASQ config
 # ==============================================================================

dnsmasq/rootfs/etc/services.d/dnsmasq/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 CONFIG="/etc/dnsmasq.conf"
 
 # Run dnsmasq

duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/finish

@@ -4,6 +4,7 @@
 # Home Assistant Community Add-on: chrony
 # Take down the S6 supervision tree when chrony fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -15,7 +16,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 
 CERT_DIR=/data/letsencrypt
 WORK_DIR=/data/workdir

google_assistant/rootfs/etc/services.d/google-assistant/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start Google Assistant service
 # ==============================================================================

letsencrypt/rootfs/etc/cont-init.d/file-structure.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Init folder & structures
 # ==============================================================================

letsencrypt/rootfs/etc/services.d/lets-encrypt/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start sshd service if enabled
 # ==============================================================================
@@ -294,6 +295,7 @@ else
     bashio::log.info "Detecting existing certificate type for ${DOMAIN_ARR[1]}"
     readarray -t CBCERTS < <(certbot certificates --non-interactive --cert-name "${DOMAIN_ARR[1]}" --config-dir "$CERT_DIR" --work-dir "$WORK_DIR") 
     for output in "${CBCERTS[@]}"; do
+        # shellcheck disable=SC2076
         if [[ $output =~ "No certificates found." ]]; then
             bashio::log.info "No certificate found - using 'ecdsa' key type."
             KEY_ARGUMENTS+=("--key-type" "ecdsa")

mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-core/finish

@@ -3,6 +3,7 @@
 # ==============================================================================
 # Take down the S6 supervision tree when daemon fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +15,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/finish

@@ -6,12 +6,14 @@
 
 declare MARIADB_LOCK_CORE_PID
 MARIADB_LOCK_CORE_PID=$(s6-svstat -o pid "/run/service/mariadb-lock-core")
+# shellcheck disable=SC2086
 if bashio::var.equals ${MARIADB_LOCK_CORE_PID} -1; then
     bashio::log.error "Invalid mariadb-lock-core process id ${MARIADB_LOCK_CORE_PID}"
     bashio::exit.nok
 fi
 
 # File descriptor &4 is used as stdin for mysql, because &0 is closed after the mariadb-lock-core service is started
+# shellcheck disable=SC2086
 echo "UNLOCK TABLES;" > /proc/${MARIADB_LOCK_CORE_PID}/fd/4
 
 bashio::log.info "MariaDB tables unlocked"

mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/run

@@ -6,12 +6,14 @@
 
 declare MARIADB_LOCK_CORE_PID
 MARIADB_LOCK_CORE_PID=$(s6-svstat -o pid "/run/service/mariadb-lock-core")
+# shellcheck disable=SC2086
 if bashio::var.equals ${MARIADB_LOCK_CORE_PID} -1; then
     bashio::log.error "Invalid mariadb-lock-core process id ${MARIADB_LOCK_CORE_PID}"
     bashio::exit.nok
 fi
 
 # File descriptor &4 is used as stdin for mysql, because &0 is closed after the mariadb-lock-core service is started
+# shellcheck disable=SC2086
 echo "FLUSH TABLES WITH READ LOCK;" > /proc/${MARIADB_LOCK_CORE_PID}/fd/4
 
 bashio::log.info "MariaDB tables locked"

mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-post/run

@@ -8,7 +8,9 @@ function execute_without_error_messages() {
     local current_log_level="${__BASHIO_LOG_LEVELS[${__BASHIO_LOG_LEVEL}]}"
     bashio::log.level fatal
     local exit_code=0
+    # shellcheck disable=SC2068
     $@ || exit_code=$?
+    # shellcheck disable=SC2086
     bashio::log.level ${current_log_level}
     return ${exit_code}
 }

mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-pre/run

@@ -11,8 +11,8 @@ if ! bashio::fs.directory_exists "${MARIADB_DATA}"; then
 fi
 
 # Save variables
-printf "${MARIADB_DATA}" > /var/run/s6/container_environment/MARIADB_DATA
-printf "${NEW_INSTALL}" > /var/run/s6/container_environment/NEW_INSTALL
+cat <<<"${MARIADB_DATA}" > /var/run/s6/container_environment/MARIADB_DATA
+cat <<<"${NEW_INSTALL}" > /var/run/s6/container_environment/NEW_INSTALL
 
 # Redirect log output
 mkdir -p "${MARIADB_DATA}"

matter_server/rootfs/etc/s6-overlay/s6-rc.d/matter-server/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Start matter-server service
 # ==============================================================================
@@ -24,9 +25,11 @@ log_level_sdk=$(bashio::string.lower "$(bashio::config log_level_sdk error)")
 if bashio::config.has_value "matter_server_version"; then
   matter_server_version=$(bashio::config 'matter_server_version')
   bashio::log.info "Installing Python Matter Server ${matter_server_version}"
+  # shellcheck disable=SC2102
   pip3 install --pre python-matter-server[server]=="${matter_server_version}"
 elif bashio::config.true "beta"; then
   bashio::log.info 'Upgrading Python Matter Server to latest pre-release'
+  # shellcheck disable=SC2102
   pip3 install --upgrade --pre python-matter-server[server]
 fi
 
@@ -52,20 +55,24 @@ fi
 primary_interface="$(bashio::api.supervisor 'GET' '/network/info' '' 'first(.interfaces[] | select (.primary == true)) .interface')"
 
 # Try fallback method (e.g. in case NetworkManager is not available)
+# shellcheck disable=SC2086
 if [ -z ${primary_interface} ]; then
   bashio::log.warning 'Trying fallback method to determine primary interface'
   primary_interface="$(ip --json route show default | jq --raw-output '.[0].dev')"
 fi
 
+# shellcheck disable=SC2086
 if [ -z ${primary_interface} ] || [ ${primary_interface} == "null" ]; then
     bashio::exit.nok "No primary network interface found!"
 fi
 
 if bashio::config.has_value "bluetooth_adapter_id"; then
+  # shellcheck disable=SC2207
   extra_args+=('--bluetooth-adapter' $(bashio::config 'bluetooth_adapter_id'))
 fi
 
 if bashio::config.has_value "matter_server_args"; then
+  # shellcheck disable=SC2207
   extra_args+=($(bashio::config 'matter_server_args'))
 fi
 
@@ -74,8 +81,10 @@ bashio::log.info "Using '${primary_interface}' as primary network interface."
 # Send out discovery information to Home Assistant
 /etc/s6-overlay/scripts/matter-server-discovery &
 
+# shellcheck disable=SC2164
 cd /root
 
+# shellcheck disable=SC2206
 matter_server_args+=(
   '--storage-path' "/data"
   '--port' "${server_port}"

matter_server/rootfs/etc/s6-overlay/scripts/banner.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Home Assistant Community Add-on: Base Images
 # Displays a simple add-on banner on startup

matter_server/rootfs/etc/s6-overlay/scripts/matter-server-discovery

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Send matter discovery information to Home Assistant
 # ==============================================================================

mosquitto/rootfs/etc/cont-init.d/mosquitto.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Configures mosquitto
 # ==============================================================================

mosquitto/rootfs/etc/cont-init.d/nginx.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Configures NGINX
 # ==============================================================================

mosquitto/rootfs/etc/services.d/mosquitto/discovery

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Send MQTT discovery information to Home Assistant and service information
 # to the Supervisor (for other add-ons).

mosquitto/rootfs/etc/services.d/mosquitto/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Runs mosquitto
 # ==============================================================================

mosquitto/rootfs/etc/services.d/nginx/run

@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Runs the NGINX daemon
 # ==============================================================================

nginx_proxy/rootfs/etc/periodic/daily/check_certificate_renewal

@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Check certificate renewal
 # ==============================================================================

nginx_proxy/rootfs/etc/s6-overlay/s6-rc.d/crond/finish

@@ -3,6 +3,7 @@
 # ==============================================================================
 # Take down the S6 supervision tree when daemon fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +15,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

nginx_proxy/rootfs/etc/s6-overlay/s6-rc.d/nginx/finish

@@ -3,6 +3,7 @@
 # ==============================================================================
 # Take down the S6 supervision tree when daemon fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +15,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then