Add Shellcheck Lint, Address Caught Issues #849
Conversation
Signed-off-by: codecriticsceo <codecriticsceo>
Signed-off-by: codecriticsceo <codecriticsceo>
codecriticsceo
changed the title
.github/workflows/ci.yml
Outdated
| - name: Run Shellcheck | ||
| run: find . -name '*.sh' -print0 | xargs -0 shellcheck -x |
There was a problem hiding this comment.
Any reason not to use the shellcheck GH action, instead?
There was a problem hiding this comment.
The reason I did not use it was because I don't think that's an official Shellcheck project action. Here is the page on shellcheck: https://www.shellcheck.net/wiki/GitHub-Actions. Would be happy to switch, if you want though.
There was a problem hiding this comment.
Ah, okay. That seems simple enough. Maybe just change this to the recommended incantation...
- run: shellcheck **/*.shI don't think the find command is needed. Nor the -x option (what does that even do?)
There was a problem hiding this comment.
The -x option follows included shellscripts and checks them as well. The find command is so that shellscripts in varying directory levels (including root) will all be found.
There was a problem hiding this comment.
I can test with the action, but in bash, echo **/*.sh appears not to find shellscripts in the immediate directory, only a subdirectory
There was a problem hiding this comment.
Update tested: https://github.com/codecriticsceo/uuid/actions/runs/12554064345/job/35002278202. I added two bad scripts to a throw-away branch, one in root and one two directories down. shellcheck **/*.sh did not find them but the find command did. I am going to try updating the shellcheck wiki.
There was a problem hiding this comment.
Updated the PR with the exact command from the docs (find without -x or xargs)
|
Noting for posterity that |
Signed-off-by: codecriticsceo <codecriticsceo>
PR adds the
shellchecklinter to check the shell scripts, and fixes the found issues. Nothing major, although the existing scripts might not work if there are spaces or asterisks in the development repo path. If you would like changes, please let me know.