[WIP] ci: add ShellCheck workflow for shell script linting #32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced a GitHub Actions workflow to run ShellCheck on all .sh files - Ensures shell scripts follow best practices and common standards - Helps catch syntax errors, quoting issues, and style problems early This improves code quality and enforces consistency in shell script contributions. Signed-off-by: Srikanth Muppandam <[email protected]>
mwasilew
requested changes
May 15, 2025
| run: sudo apt-get install -y shellcheck | ||
| - name: Run ShellCheck | ||
| run: | | ||
| find . -name '*.sh' -exec shellcheck {} + |
There was a problem hiding this comment.
we should probably exclude some codes. In test definitions the following codes are excluded: SC1091 SC2230 SC3043
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Install ShellCheck | ||
| run: sudo apt-get install -y shellcheck |
There was a problem hiding this comment.
maybe pin a version? Shellcheck behaviour changes in unpredicted way after upgrade. I'm currently using 0.9.0-1
There was a problem hiding this comment.
apt-get may not retrieve this version. Do you recommend downloading version 0.9.0-1 and installing it manually to ensure it is available for use.?
|
I think all checks should be green. If you want to introduce shellcheck you need to either fix all warnings beforehand or in the same PR. |
smuppand
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves code quality and enforces consistency in shell script contributions.