Example of Job Summary
+
+ 
+
+
+
@@ -271,7 +283,8 @@ This feature is fully compatible with [exclude-path](#exclude-path) and [include * requirements: `optional` * example: `"build/**"` * example for multiple values: - ``` + + ```yml scan-directory: | build/** testing diff --git a/docs/example.sh b/docs/example.sh new file mode 100644 index 00000000..a4c63620 --- /dev/null +++ b/docs/example.sh @@ -0,0 +1,120 @@ +#!/bin/sh +# Examples taken from the ShellCheck Gallery of bad code - https://github.com/koalaman/shellcheck#gallery-of-bad-code + +# Quoting +# ======= + +# echo $1 # Unquoted variables +# rm "~/my file.txt" # Quoted tilde expansion +# v='--verbose="true"'; cmd $v # Literal quotes in variables +# touch $@ # Unquoted $@ +# echo 'Path is $PATH' # Variables in single quotes +# trap "echo Took ${SECONDS}s" 0 # Prematurely expanded trap +# unset var[i] # Array index treated as glob + +# Conditionals +# ============ + +# [[ n != 0 ]] # Constant test expressions +# [[ -e *.mpg ]] # Existence checks of globs +# [[ $foo==0 ]] # Always true due to missing spaces +# [[ -n "$foo " ]] # Always true due to literals +# [[ $foo =~ "fo+" ]] # Quoted regex in =~ +# [ foo =~ re ] # Unsupported [ ] operators +# [ $1 -eq "shellcheck" ] # Numerical comparison of strings +# [ $n && $m ] # && in [ .. ] +# [[ "$$file" == *.jpg ]] # Comparisons that can't succeed +# (( 1 -lt 2 )) # Using test operators in ((..)) +# [ x ] & [ y ] | [ z ] # Accidental backgrounding and piping + +# Frequently misused commands +# =========================== + +# grep '*foo*' file # Globs in regex contexts +# find . -exec foo {} && bar {} \; # Prematurely terminated find -exec +# sudo echo 'Var=42' > /etc/profile # Redirecting sudo +# time --format=%s sleep 10 # Passing time(1) flags to time builtin +# alias archive='mv $1 /backup' # Defining aliases with arguments +# tr -cd '[a-zA-Z0-9]' # [] around ranges in tr +# exec foo; echo "Done!" # Misused 'exec' +# find -name \*.bak -o -name \*~ -delete # Implicit precedence in find +# find . -exec foo > bar \; # Redirections in find +# f() { whoami; }; sudo f # External use of internal functions + +# Common beginner's mistakes +# var = 42 # Spaces around = in assignments +# $foo=42 # $ in assignments +# var$n="Hello" # Wrong indirect assignment +# echo ${var$n} # Wrong indirect reference +# var=(1, 2, 3) # Comma separated arrays +# array=( [index] = value ) # Incorrect index initialization +# echo $var[14] # Missing {} in array references +# echo "Argument 10 is $10" # Positional parameter misreference +# [ false ] # 'false' being true + +# Style +# ===== + +# [[ -z $(find /tmp | grep mpg) ]] # Use grep -q instead +# a >> log; b >> log; c >> log # Use a redirection block instead +# echo "The time is `date`" # Use $() instead +# cd dir; process *; cd ..; # Use subshells instead +# echo $[1+2] # Use standard $((..)) instead of old $[] +# echo $(($RANDOM % 6)) # Don't use $ on variables in $((..)) +# echo "$(date)" # Useless use of echo +# cat file | grep foo # Useless use of cat + +# Data and typing errors +# ====================== + +# args="$@" # Assigning arrays to strings +# files=(foo bar); echo "$files" # Referencing arrays as strings +# declare -A arr=(foo bar) # Associative arrays without index +# printf "%s\n" "Arguments: $@." # Concatenating strings and arrays +# [[ $# > 2 ]] # Comparing numbers as strings +# var=World; echo "Hello " var # Unused lowercase variables +# echo "Hello $name" # Unassigned lowercase variables +# cmd | read bar; echo $bar # Assignments in subshells +# cat foo | cp bar # Piping to commands that don't read +# printf '%s: %s\n' foo # Mismatches in printf argument count +# eval "${array[@]}" # Lost word boundaries in array eval + +# Robustness +# ========== + +# rm -rf "$STEAMROOT/"* # Catastrophic rm +# touch ./-l; ls * # Globs that could become options +# find . -exec sh -c 'a && b {}' \; # Find -exec shell injection +# printf "Hello $name" # Variables in printf format +# export MYVAR=$(cmd) # Masked exit codes + +# Portability +# =========== + +# echo {1..$n} # Works in ksh, but not bash/dash/sh +# echo {1..10} # Works in ksh and bash, but not dash/sh +# echo -n 42 # Works in ksh, bash and dash, undefined in sh +# expr match str regex # Unportable alias for `expr str : regex` +# trap 'exit 42' sigint # Unportable signal spec +# cmd &> file # Unportable redirection operator +# read foo < /dev/tcp/host/22 # Unportable intercepted files +# foo-bar() { ..; } # Undefined/unsupported function name +# [ $UID = 0 ] # Variable undefined in dash/sh +# local var=value # local is undefined in sh +# time sleep 1 | sleep 5 # Undefined uses of 'time' + +# Miscellaneous +# ============= + +# PS1='\e[0;32m\$\e[0m ' # PS1 colors not in \[..\] +# PATH="$PATH:~/bin" # Literal tilde in $PATH +# rm “file” # Unicode quotes +# echo "Hello world" # Carriage return / DOS line endings +# echo hello \ # Trailing spaces after \ +# var=42 echo $var # Expansion of inlined environment +# echo $((n/180*100)) # Unnecessary loss of precision +# ls *[:digit:].txt # Bad character class globs +# sed 's/foo/bar/' file > file # Redirecting to input +# var2=$var2 # Variable assigned to itself +# [ x$var = xval ] # Antiquated x-comparisons +# ls() { ls -l "$@"; } # Infinitely recursive wrapper diff --git a/docs/images/job-summary-dark.png b/docs/images/job-summary-dark.png new file mode 100644 index 00000000..fa48266c Binary files /dev/null and b/docs/images/job-summary-dark.png differ diff --git a/docs/images/job-summary-light.png b/docs/images/job-summary-light.png new file mode 100644 index 00000000..6ee06cb7 Binary files /dev/null and b/docs/images/job-summary-light.png differ diff --git a/docs/images/output-example.png b/docs/images/output-example.png index f4973e07..d667e6b3 100644 Binary files a/docs/images/output-example.png and b/docs/images/output-example.png differ diff --git a/src/index.sh b/src/index.sh index 121707fc..28695343 100755 --- a/src/index.sh +++ b/src/index.sh @@ -67,7 +67,7 @@ if ! is_strict_check_on_push_demanded; then execute_shellcheck "${only_changed_scripts[@]}" > ../head-shellcheck.err # Checkout the base branch/commit - git checkout --force --quiet -b ci_br_dest "${BASE}" + git checkout --force --quiet -b ci_br_dest "${BASE}" || git checkout --force --quiet "${BASE}" execute_shellcheck "${only_changed_scripts[@]}" > ../base-shellcheck.err @@ -103,7 +103,7 @@ csgrep \ --set-scan-prop='tool:ShellCheck' \ --set-scan-prop="tool-version:${shellcheck_version}" \ --set-scan-prop='tool-url:https://www.shellcheck.net/wiki/' \ - '../sarif-defects.log' >> output.sarif + '../sarif-defects.log' > output.sarif echo "sarif=output.sarif" >> "${GITHUB_OUTPUT}"