From 3a4806a465837a729c6b953c5aee578c8bd10972 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sat, 30 May 2020 11:57:50 +0200 Subject: [PATCH] Update readme --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37a1dfd..294beb8 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,6 @@ jobs: uses: ludeeus/action-shellcheck@master ``` - - ## Globally disable checks To disable specific checks add it to a `SHELLCHECK_OPTS` env key in the job definition. @@ -37,3 +35,25 @@ example: env: SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090 ``` + +## Disable paths + +You can use the `ignore` input to disable specific directories. + +```text +sample structure: +sample/directory/with/files/toignore/test.sh +sample/directory/with/files/test.sh +``` + +example: + +```yaml + ... + - name: Run ShellCheck + uses: ludeeus/action-shellcheck@master + with: + ignore: toignore +``` + +This will skip `sample/directory/with/files/toignore/test.sh`