A GitHub Action that runs shellcheck with reviewdog to automatically review shell scripts in pull requests.
reviewdog/action-shellcheck is a GitHub Action that automatically runs shellcheck, a static analysis tool for shell scripts, and integrates it with reviewdog to provide code review feedback on pull requests. It scans shell script files for errors, security issues, and style violations, posting results as comments or checks in the GitHub pull request interface. This helps teams maintain shell script quality and catch issues early in the development workflow.
Developers and DevOps engineers who write and maintain shell scripts in GitHub repositories and want to automate code quality checks in their CI/CD pipelines. It's particularly useful for teams that rely on shell scripts for automation, deployment, or tooling.
It provides a seamless, automated way to enforce shell script best practices directly within GitHub's pull request workflow, reducing manual review effort and catching common errors before they reach production. The integration with reviewdog offers flexible reporting options and configurable severity levels, making it adaptable to different team workflows.
Run shellcheck with reviewdog
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Seamlessly runs shellcheck on pull requests and posts findings as comments or checks, automating code review and reducing manual effort, as shown in the README's sample outputs.
Supports multiple reviewdog reporters like github-pr-review for Markdown comments with rule links, allowing teams to customize feedback style, per the inputs section.
Allows specifying path, pattern, and exclude inputs to precisely control which files are checked, with examples for multiple directories and patterns in the README.
Users can set fail_level to define which severity levels trigger workflow failures, providing flexibility in enforcing standards without blocking on minor issues.
As admitted in the known issue, shellcheck.exe may fail on Windows due to carriage returns, requiring manual .gitattributes configuration, which adds setup complexity.
The fail_on_error input is deprecated, which could confuse users and necessitate updates to existing workflows, as noted in the README, indicating maintenance challenges.
This action is specific to GitHub Actions, making it unsuitable for projects on other CI/CD platforms like GitLab CI or Jenkins, limiting its versatility.