From ac3e5d1ab40d004ba233f74852c1cfc2287061bb Mon Sep 17 00:00:00 2001 From: Justin Hammond <39606064+Justintime50@users.noreply.github.com> Date: Wed, 13 Jan 2021 10:26:27 -0700 Subject: [PATCH] Updates README to include ShellCheck flag/options usage (#35) --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 733adf5..2209760 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,14 @@ jobs: uses: ludeeus/action-shellcheck@master ``` -## Globally disable checks +## ShellCheck options -To disable specific checks add it to a `SHELLCHECK_OPTS` env key in the job definition. +You can pass any supported ShellCheck option or flag with the `SHELLCHECK_OPTS` env key in the job definition. + +Some examples include: + +* To disable specific checks (eg: `-e SC2059 -e SC2034 -e SC1090`) +* To test against different shells (eg: `-s dash` or `-s ksh`) example: