Enable Shellcheck in code scan. (#2046)

ZePan110 · web-flow · commit a1bbc69bd620 · 2025-06-13T13:34:42.000+08:00
Signed-off-by: ZePan110 &lt;ze.pan@intel.com&gt;
diff --git a/.github/workflows/pr-code-scan.yml b/.github/workflows/pr-code-scan.yml
@@ -66,3 +66,35 @@ jobs:
         with:
           name: ${{ matrix.job_name }}
           path: ${{ github.workspace }}/.github/workflows/scripts/codeScan/${{ matrix.job_name }}.*
+
+  shell-check:
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      actions: read
+      contents: read
+    steps:
+      - name: Repository checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get changed shell files
+        id: get-changed-files
+        run: |
+          base_commit="${{ github.event.pull_request.base.sha }}"
+          merged_commit="${{ github.sha }}"
+          echo "base_commit=${base_commit}" >> $GITHUB_ENV
+          echo "merged_commit=${merged_commit}" >> $GITHUB_ENV
+          changed_files="$(git diff --name-only --diff-filter=AM ${base_commit} ${merged_commit} | grep -E '\.sh$'  | tr '\n' ' ')" || true
+          echo "changed_files=${changed_files}"
+          echo "changed_files=${changed_files}" >> $GITHUB_ENV
+
+      - name: ShellCheck
+        if: ${{ env.changed_files != '' }}
+        uses: ludeeus/action-shellcheck@2.0.0
+        env:
+          SHELLCHECK_OPTS: -e SC2164 -e SC2154 -e SC2034 -e SC2155 -e SC1090 -e SC2153 -e SC2046
+        with:
+          path: ${{ env.changed_files }}
+          severity: warning
diff --git a/.github/workflows/scripts/update_images_tag.sh b/.github/workflows/scripts/update_images_tag.sh
@@ -27,9 +27,9 @@ function replace_image_version() {
         echo "version is empty"
     else
         echo "replace $repo_image:tag with $repo_image:$version"
-        find . -name "Dockerfile" | xargs sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
-        find . -name "*.yaml" | xargs sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
-        find . -name "*.md" | xargs sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
+        find . -name "Dockerfile" -print0 | xargs -0 sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
+        find . -name "*.yaml" -print0 | xargs -0 sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
+        find . -name "*.md" -print0 | xargs -0 sed -i "s|$repo_image:sha[A-Za-z0-9\-]*|$repo_image:$version|g"
     fi
 }
 
diff --git a/AgentQnA/docker_compose/amd/gpu/rocm/launch_agent_service_tgi_rocm.sh b/AgentQnA/docker_compose/amd/gpu/rocm/launch_agent_service_tgi_rocm.sh
@@ -66,9 +66,9 @@ echo ${SUPERVISOR_REACT_AGENT_PORT} > ${WORKPATH}/SUPERVISOR_REACT_AGENT_PORT_tm
 echo ${CRAG_SERVER_PORT} > ${WORKPATH}/CRAG_SERVER_PORT_tmp
 
 echo "Downloading chinook data..."
-echo Y | rm -R chinook-database
+rm -R chinook-database
 git clone https://github.com/lerocha/chinook-database.git
-echo Y | rm -R ../../../../../AgentQnA/tests/Chinook_Sqlite.sqlite
+rm -R ../../../../../AgentQnA/tests/Chinook_Sqlite.sqlite
 cp chinook-database/ChinookDatabase/DataSources/Chinook_Sqlite.sqlite ../../../../../AgentQnA/tests
 
 docker compose -f ../../../../../DocIndexRetriever/docker_compose/intel/cpu/xeon/compose.yaml up -d
diff --git a/AgentQnA/docker_compose/amd/gpu/rocm/launch_agent_service_vllm_rocm.sh b/AgentQnA/docker_compose/amd/gpu/rocm/launch_agent_service_vllm_rocm.sh
@@ -67,9 +67,9 @@ echo ${SUPERVISOR_REACT_AGENT_PORT} > ${WORKPATH}/SUPERVISOR_REACT_AGENT_PORT_tm
 echo ${CRAG_SERVER_PORT} > ${WORKPATH}/CRAG_SERVER_PORT_tmp
 
 echo "Downloading chinook data..."
-echo Y | rm -R chinook-database
+rm -R chinook-database
 git clone https://github.com/lerocha/chinook-database.git
-echo Y | rm -R ../../../../../AgentQnA/tests/Chinook_Sqlite.sqlite
+rm -R ../../../../../AgentQnA/tests/Chinook_Sqlite.sqlite
 cp chinook-database/ChinookDatabase/DataSources/Chinook_Sqlite.sqlite ../../../../../AgentQnA/tests
 
 docker compose -f ../../../../../DocIndexRetriever/docker_compose/intel/cpu/xeon/compose.yaml up -d
diff --git a/AgentQnA/docker_compose/amd/gpu/rocm/stop_agent_service_tgi_rocm.sh b/AgentQnA/docker_compose/amd/gpu/rocm/stop_agent_service_tgi_rocm.sh
@@ -46,7 +46,7 @@ export DATAPREP_GET_FILE_ENDPOINT="http://${host_ip}:6007/v1/dataprep/get"
 export DATAPREP_DELETE_FILE_ENDPOINT="http://${host_ip}:6007/v1/dataprep/delete"
 
 echo "Removing chinook data..."
-echo Y | rm -R chinook-database
+rm -R chinook-database
 if [ -d "chinook-database" ]; then
     rm -rf chinook-database
 fi
diff --git a/AgentQnA/docker_compose/amd/gpu/rocm/stop_agent_service_vllm_rocm.sh b/AgentQnA/docker_compose/amd/gpu/rocm/stop_agent_service_vllm_rocm.sh
@@ -68,7 +68,7 @@ echo ${SUPERVISOR_REACT_AGENT_PORT} > ${WORKPATH}/SUPERVISOR_REACT_AGENT_PORT_tm
 echo ${CRAG_SERVER_PORT} > ${WORKPATH}/CRAG_SERVER_PORT_tmp
 
 echo "Removing chinook data..."
-echo Y | rm -R chinook-database
+rm -R chinook-database
 if [ -d "chinook-database" ]; then
     rm -rf chinook-database
 fi
diff --git a/AudioQnA/tests/test_compose_on_rocm.sh b/AudioQnA/tests/test_compose_on_rocm.sh
@@ -14,7 +14,7 @@ export MODEL_CACHE=${model_cache:-"/var/lib/GenAI/data"}
 WORKPATH=$(dirname "$PWD")
 LOG_PATH="$WORKPATH/tests"
 ip_address=$(hostname -I | awk '{print $1}')
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 
 function build_docker_images() {
     opea_branch=${opea_branch:-"main"}
diff --git a/AudioQnA/tests/test_compose_vllm_on_rocm.sh b/AudioQnA/tests/test_compose_vllm_on_rocm.sh
@@ -13,7 +13,7 @@ export TAG=${IMAGE_TAG}
 WORKPATH=$(dirname "$PWD")
 LOG_PATH="$WORKPATH/tests"
 ip_address=$(hostname -I | awk '{print $1}')
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 
 function build_docker_images() {
     opea_branch=${opea_branch:-"main"}
diff --git a/ChatQnA/tests/test_compose_faqgen_on_rocm.sh b/ChatQnA/tests/test_compose_faqgen_on_rocm.sh
@@ -17,7 +17,7 @@ ip_address=$(hostname -I | awk '{print $1}')
 
 source $WORKPATH/docker_compose/amd/gpu/rocm/set_env_faqgen.sh
 
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 
 function build_docker_images() {
     opea_branch=${opea_branch:-"main"}
diff --git a/ChatQnA/tests/test_compose_on_rocm.sh b/ChatQnA/tests/test_compose_on_rocm.sh
@@ -17,7 +17,7 @@ ip_address=$(hostname -I | awk '{print $1}')
 
 source $WORKPATH/docker_compose/amd/gpu/rocm/set_env.sh
 
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 
 function build_docker_images() {
     opea_branch=${opea_branch:-"main"}
diff --git a/VideoQnA/tests/test_compose_on_xeon.sh b/VideoQnA/tests/test_compose_on_xeon.sh
@@ -86,7 +86,7 @@ function build_docker_images() {
     sed -i "s|$OLD_STRING|$NEW_STRING|g" "GenAIComps/comps/third_parties/clip/src/Dockerfile"
 
     echo "Build all the images with --no-cache, check docker_image_build.log for details..."
-    docker compose -f build.yaml build --no-cache 2>&1 > ${LOG_PATH}/docker_image_build.log
+    docker compose -f build.yaml build --no-cache > ${LOG_PATH}/docker_image_build.log 2>&1
 
 	docker pull intellabs/vdms:latest
     docker images && sleep 1s
@@ -152,7 +152,7 @@ function start_services() {
             item=${list[i]}
             if check_condition "$item"; then
                 echo "Condition met for $item, removing from list." >> ${LOG_PATH}/list_check.log
-                unset list[i]
+                unset "list[i]"
             else
                 echo "Condition not met for $item, keeping in list." >> ${LOG_PATH}/list_check.log
             fi
diff --git a/VisualQnA/tests/test_compose_on_rocm.sh b/VisualQnA/tests/test_compose_on_rocm.sh
@@ -17,7 +17,7 @@ export REGISTRY=${IMAGE_REPO}
 export TAG=${IMAGE_TAG}
 export host_ip=${ip_address}
 export MODEL="llava-hf/llava-v1.6-mistral-7b-hf"
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 source $WORKPATH/docker_compose/amd/gpu/rocm/set_env.sh
 
 function build_docker_images() {
diff --git a/VisualQnA/tests/test_compose_vllm_on_rocm.sh b/VisualQnA/tests/test_compose_vllm_on_rocm.sh
@@ -16,7 +16,7 @@ export REGISTRY=${IMAGE_REPO}
 export TAG=${IMAGE_TAG}
 export host_ip=${ip_address}
 export MODEL="llava-hf/llava-v1.6-mistral-7b-hf"
-export PATH="~/miniconda3/bin:$PATH"
+export PATH="$HOME/miniconda3/bin:$PATH"
 export MODEL_CACHE=${model_cache:-"/var/opea/multimodalqna-service/data"}
 source $WORKPATH/docker_compose/amd/gpu/rocm/set_env_vllm.sh
 
