titanz/action-shellcheck
Template
1
0
Fork 0
mirror of https://github.com/ludeeus/action-shellcheck.git synced 2025-01-18 17:41:58 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: suggest use of line folding (#82)

Browse Source 
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
Reid Price 2023-01-28 12:53:27 -08:00 committed by GitHub
parent 6d3f514f44
commit e5c9260d11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -45,6 +45,8 @@ example:
## Ignore paths and names ## Ignore paths and names
You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files. You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files.
These are passed as environment variables, and should evaluate to a single space-separated string.
It may be convenient to use [`>-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.
```text ```text
sample structure: sample structure:
@ -61,7 +63,9 @@ example:
- name: Run ShellCheck - name: Run ShellCheck
uses: ludeeus/action-shellcheck@master uses: ludeeus/action-shellcheck@master
with: with:
ignore_paths: ignoreme ignoremetoo ignore_paths: >-
ignoreme
ignoremetoo
ignore_names: ignorable.sh ignore_names: ignorable.sh
``` ```