Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shellcheck on Github workflow #3596

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 58 additions & 1 deletion bin/check/shellcheck.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,62 @@
#!/bin/bash
set -Eeuo pipefail

find . -type f -name '*.sh' -print0 | xargs -0 shellcheck
function init_colors(){
color_red=$(echo -ne "\033[1;31m")
color_green=$(echo -ne "\033[1;32m")
color_cyan=$(echo -ne "\033[1;36m")
color_reset=$(echo -ne "\033[0m")
}

function prerequisites(){
if ! (command -v shellcheck >/dev/null 2>&1) ; then
echo "${color_red}Error${color_reset} - Shellcheck has to be installed on your system (https://github.com/koalaman/shellcheck?tab=readme-ov-file#installing)."
exit 1
fi
if ! (command -v yq >/dev/null 2>&1) ; then
echo "${color_red}Error${color_reset} - Yq has to be installed on your system (https://github.com/mikefarah/yq#install)."
exit 1
fi
}

function shellcheck_files(){
echo "# shellcheck sh scripts files"
find . -type f -name '*.sh' -print0 | xargs -0 shellcheck
echo "${color_green}No problem with sh script files${color_reset}"
echo
}

function shellcheck_gitflow(){
echo "# shellcheck sh scripts inside Github Workflow"
error_count=0
for yaml in .github/workflows/*yml ; do
echo "${color_cyan} ======================================================================="
echo "${color_cyan} > shellchecking ${yaml}..."
echo "${color_cyan} ======================================================================="
echo "${color_cyan} |${color_reset}"
file=$(basename "${yaml}")
tmp="/tmp/${file}"
yq '.jobs[] | select(.["runs-on"] | test("windows") | not).steps[] | select(.run != null) | .run' "${yaml}" > "${tmp}"
if ! output=$(shellcheck --exclude=SC2148 --color=always "${tmp}" 2>&1) ; then
echo "${output}" | sed "/In.*${file}.*/d" | sed "s/^/${color_cyan} |${color_reset} /g"
error_count=$((error_count+1))
else
echo "${color_cyan} | ${color_green}No problem with ${yaml}${color_reset}"
fi
rm "${tmp}"
echo
done
if [[ $error_count -gt 0 ]] ; then
echo "${color_red}There are shellcheck errors with sh scripts inside github workflows${color_reset}"
exit 1
else
echo "${color_green}No problem with sh scripts inside github workflows${color_reset}"
fi
}

# main
init_colors
prerequisites
shellcheck_files
shellcheck_gitflow

Loading