feat: add setup step

src/functions.sh

@@ -300,6 +300,8 @@ is_debug () {
 }
 
 # Function to check if the script is run in GitHub Actions environment
+# GITHUB_ACTIONS is set when Differential ShellCheck is running in GitHub Actions
+# https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
 is_github_actions () {
   if [[ -z "${GITHUB_ACTIONS}" ]]; then
     return 1

src/index.sh

@@ -5,6 +5,8 @@ CURRENT_DIR="$(dirname "$(readlink -f "$0")")"
 
 # shellcheck source=functions.sh
 . "${SCRIPT_DIR="${CURRENT_DIR}/"}functions.sh"
+# shellcheck source=setup.sh
+. "${SCRIPT_DIR=}setup.sh"
 
 WORK_DIR="${WORK_DIR-../}"
 

src/setup.sh

@@ -0,0 +1,12 @@
+# shellcheck shell=bash
+
+# TODO set up required variables
+
+# Set required variables based on the environment
+if is_github_actions; then
+  is_debug && echo "Running in GitHub Actions"
+else
+  is_debug && \
+  echo "Running in non GitHub Actions environment" && \
+  echo "Functionality is limited"
+fi