https://github.com/MarounMaroun/shell-checker
✅ GitHub action for running ShellCheck on shell files in your PR
https://github.com/MarounMaroun/shell-checker
github-actions shell shellcheck
Last synced: 10 months ago
JSON representation
✅ GitHub action for running ShellCheck on shell files in your PR
- Host: GitHub
- URL: https://github.com/MarounMaroun/shell-checker
- Owner: MarounMaroun
- License: mit
- Created: 2020-05-29T17:28:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-13T06:15:19.000Z (almost 6 years ago)
- Last Synced: 2025-07-06T20:16:43.552Z (11 months ago)
- Topics: github-actions, shell, shellcheck
- Language: Shell
- Homepage: https://github.com/marketplace/actions/pr-shellcheck
- Size: 29.3 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PR Shell Checker
Run [ShellCheck](https://www.shellcheck.net/) on shell files in your PR.
You can set the severity and types of warnings you want to exclude.
## Usage
Create a file `checker.yml` inside `.github/workflows`:
```yaml
on: [pull_request]
jobs:
shell-check:
runs-on: ubuntu-latest
name: Shell Checker
steps:
- uses: actions/checkout@v2
- uses: marounmaroun/shell-checker@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
severity: 'info'
exclude: ''
```
You can set the severity to one of: "error, warning, info, style". Default is "info".
You can also include type of warnings to exclude. For example:
```yaml
exclude: 'SC2006,SC2148'
```
Default value is not set, meaning that there will be no exclusions.