Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azohra/shell-linter
A Github Action for ShellCheck
https://github.com/azohra/shell-linter
developer-tools github-actions lint static-analysis
Last synced: 11 days ago
JSON representation
A Github Action for ShellCheck
- Host: GitHub
- URL: https://github.com/azohra/shell-linter
- Owner: azohra
- License: mit
- Created: 2019-10-02T19:40:54.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-28T23:41:00.000Z (6 months ago)
- Last Synced: 2024-12-22T05:10:02.552Z (18 days ago)
- Topics: developer-tools, github-actions, lint, static-analysis
- Language: Shell
- Homepage: https://github.com/marketplace/actions/shell-linter
- Size: 247 KB
- Stars: 66
- Watchers: 7
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shell Linter
[](https://github.com/azohra/shell-linter/releases)
[](https://github.com/marketplace/actions/shell-linter)
[](https://github.com/azohra/shell-linter/actions?query=branch%3Adevelop)
A GitHub Action that performs static analysis for shell scripts using [ShellCheck](https://github.com/koalaman/shellcheck).
# Usage
Shell Linter can perform static analysis in various ways. By default it scans all the ShellCheck-supported shell scripts (sh/bash/dash/ksh) in your project. However, you can use the `path` parameter to scan a specific file or folder or use the `exclude-paths` parameter to exclude files or folders from the scan. With Shell Linter, you can also specify the minimum severity of errors to consider using the `severity` parameter. Specific use cases along with examples are shown below:
#### Run static analysis for all the supported shell scripts in your repository:
```yml
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v1
- name: Run ShellCheck
uses: azohra/shell-linter@latest
```
#### Run static analysis for a single shell script:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
path: "setup.sh"
```
#### Run static analysis for multiple shell scripts **with or without** extension:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
path: "setup,deploy.sh"
```
#### Run static analysis for all the shell scripts in a folder:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
path: "src"
```
#### Run static analysis using a **wildcard** path:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
path: "src/*.sh"
```
#### Exclude files and folders from the static analysis:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
exclude-paths: "src/setup.sh,tests/unit_tests"
```
Note that `exclude-paths` only accepts paths relative to your project's root directory. However, **do not** include `./` at the beginning of the paths.
To exclude a folder and it's content recursively just provide the path of the folder **without** a `/` at the end. In the example above, the entire folder at the path `tests/unit_tests` will be excluded from linting.
#### Run static analysis for all the shell scripts and only report issue with error severity:
```yml
- name: Run ShellCheck
uses: azohra/shell-linter@latest
with:
path: "src/*.sh"
severity: "error"
```
#### Run analysis by using a specific version of Shell Linter:
```yml
- name: Run ShellCheck
uses: azohra/[email protected]
```
# Input
### `path`
Optional. Execute lint check on a specific file or folder. Default: `.`
### `exclude-paths`
Optional. Exclude files and folders from ShellCheck scan.
### `severity`
Optional. Specify minimum severity of errors to consider [style, info, warning, error]. Default: `style`
# License
This software is available as open source under the terms of the MIT License.