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

Update README

Browse Source
This commit is contained in:
ludeeus 2020-05-29 23:11:34 +02:00
parent 5e7f90b47a
commit 35efb355bc
1 changed files with 31 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,24 +1,39 @@
# SHELLCHECK # ShellCheck
[![BuyMeCoffee][buymecoffeebedge]][buymecoffee] _GitHub action for ShellCheck._
_Run shellcheck on ALL sh files in the repository._
## Example ## Example
``` ```yaml
workflow "Shellcheck" { on:
on = "push" push:
resolves = [ branch:
"Shellcheck", - master
]
}
name: 'Trigger: Push action'
action "Shellcheck" { jobs:
uses = "ludeeus/actions/shellcheck@master" shellcheck:
} name: Shellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
``` ```
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
[buymecoffeebedge]: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
## 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
```