1
0
Fork 0
mirror of https://github.com/ludeeus/action-shellcheck.git synced 2024-08-16 10:09:53 +02:00
shellcheck/README.md

40 lines
617 B
Markdown
Raw Normal View History

2020-05-29 23:11:34 +02:00
# ShellCheck
2019-03-09 11:25:14 +01:00
2020-05-29 23:11:34 +02:00
_GitHub action for ShellCheck._
2019-03-09 11:25:14 +01:00
## Example
2020-05-29 23:11:34 +02:00
```yaml
on:
push:
branch:
- master
2019-03-09 11:25:14 +01:00
2020-05-29 23:11:34 +02:00
name: 'Trigger: Push action'
2019-03-09 11:25:14 +01:00
2020-05-29 23:11:34 +02:00
jobs:
shellcheck:
name: Shellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
2019-03-09 11:25:14 +01:00
```
2020-05-29 23:11:34 +02:00
## Globally disable checks
To disable specific checks add it to a `SHELLCHECK_OPTS` env key in the job definition.
example:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
env:
SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090
```