search

easybuilders / easybuild

EasyBuild - building software with ease
http://easybuild.io
GNU General Public License v2.0
461 stars 143 forks source link

ci(lint): add shell linter - Differential ShellCheck #838

Closed jamacku closed 1 year ago

jamacku commented 1 year ago

Differential ShellCheck is a GitHub action that performs differential ShellCheck scans on shell scripts changed via PR and reports results directly in PR. The beauty of differential scans is that you will get reports only about newly added defects.

Since this repository has few shell scripts, I think you might find some value in having a shell linter. Differential ShellCheck action is able to produce reports in SARIF format. GitHub understands this format and is able to display it nicely as a PR comment, and on the Files Changed tab, please see below.

image

image

Documentation is available at @redhat-plumbers-in-action/differential-shellcheck. Let me know If you are missing some feature or setting. I'm always happy to extend functionality.

ocaisa commented 1 year ago

@jamacku Thanks for taking the effort to include this but this repository makes very little (and rarely updated) use of shellscripts. I think if we wanted to run shellcheck we would probably just do that directly, or with an action that does not require access to GITHUB_TOKEN.